001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.control.user.party.server.command;
018
019import com.echothree.control.user.party.common.form.GetBirthdayFormatDescriptionForm;
020import com.echothree.control.user.party.common.result.GetBirthdayFormatDescriptionResult;
021import com.echothree.control.user.party.common.result.PartyResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.party.server.entity.BirthdayFormat;
027import com.echothree.model.data.party.server.entity.BirthdayFormatDescription;
028import com.echothree.model.data.party.server.entity.Language;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class GetBirthdayFormatDescriptionCommand
044        extends BaseSimpleCommand<GetBirthdayFormatDescriptionForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.BirthdayFormat.name(), SecurityRoles.Description.name())
054                        )))
055                )));
056                
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("BirthdayFormatName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetBirthdayFormatDescriptionCommand */
064    public GetBirthdayFormatDescriptionCommand(UserVisitPK userVisitPK, GetBirthdayFormatDescriptionForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var partyControl = Session.getModelController(PartyControl.class);
071        GetBirthdayFormatDescriptionResult result = PartyResultFactory.getGetBirthdayFormatDescriptionResult();
072        String birthdayFormatName = form.getBirthdayFormatName();
073        BirthdayFormat birthdayFormat = partyControl.getBirthdayFormatByName(birthdayFormatName);
074        
075        if(birthdayFormat != null) {
076            String languageIsoName = form.getLanguageIsoName();
077            Language language = partyControl.getLanguageByIsoName(languageIsoName);
078            
079            if(language != null) {
080                BirthdayFormatDescription birthdayFormatDescription = partyControl.getBirthdayFormatDescription(birthdayFormat, language);
081                
082                if(birthdayFormatDescription != null) {
083                    result.setBirthdayFormatDescription(partyControl.getBirthdayFormatDescriptionTransfer(getUserVisit(), birthdayFormatDescription));
084                } else {
085                    addExecutionError(ExecutionErrors.UnknownBirthdayFormatDescription.name(), birthdayFormatName, languageIsoName);
086                }
087            } else {
088                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
089            }
090        } else {
091            addExecutionError(ExecutionErrors.UnknownBirthdayFormatName.name(), birthdayFormatName);
092        }
093        
094        return result;
095    }
096    
097}