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.letter.server.command;
018
019import com.echothree.control.user.letter.common.form.GetLetterChoicesForm;
020import com.echothree.control.user.letter.common.result.GetLetterChoicesResult;
021import com.echothree.control.user.letter.common.result.LetterResultFactory;
022import com.echothree.model.control.chain.server.control.ChainControl;
023import com.echothree.model.control.letter.server.control.LetterControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.chain.server.entity.ChainKind;
028import com.echothree.model.data.chain.server.entity.ChainType;
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 GetLetterChoicesCommand
044        extends BaseSimpleCommand<GetLetterChoicesForm> {
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.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Choices.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("DefaultLetterChoice", FieldType.ENTITY_NAME, false, null, null),
060                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetLetterChoicesCommand */
065    public GetLetterChoicesCommand(UserVisitPK userVisitPK, GetLetterChoicesForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var chainControl = Session.getModelController(ChainControl.class);
072        GetLetterChoicesResult result = LetterResultFactory.getGetLetterChoicesResult();
073        String chainKindName = form.getChainKindName();
074        ChainKind chainKind = chainControl.getChainKindByName(chainKindName);
075        
076        if(chainKind != null) {
077            String chainTypeName = form.getChainTypeName();
078            ChainType chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
079            
080            if(chainType != null) {
081                var letterControl = Session.getModelController(LetterControl.class);
082                String defaultLetterChoice = form.getDefaultLetterChoice();
083                boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
084                
085                result.setLetterChoices(letterControl.getLetterChoices(chainType, defaultLetterChoice,
086                        getPreferredLanguage(), allowNullChoice));
087            } else {
088                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
089            }
090        } else {
091            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
092        }
093        
094        return result;
095    }
096    
097}