001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.LetterResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
022import com.echothree.model.control.letter.server.control.LetterControl;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037import javax.inject.Inject;
038
039@Dependent
040public class GetLetterChoicesCommand
041        extends BaseSimpleCommand<GetLetterChoicesForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Choices.name())
050                ))
051        ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("DefaultLetterChoice", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
058        );
059    }
060
061    @Inject
062    ChainControl chainControl;
063
064    @Inject
065    LetterControl letterControl;
066
067    
068    /** Creates a new instance of GetLetterChoicesCommand */
069    public GetLetterChoicesCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var result = LetterResultFactory.getGetLetterChoicesResult();
076        var chainKindName = form.getChainKindName();
077        var chainKind = chainControl.getChainKindByName(chainKindName);
078        
079        if(chainKind != null) {
080            var chainTypeName = form.getChainTypeName();
081            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
082            
083            if(chainType != null) {
084                var defaultLetterChoice = form.getDefaultLetterChoice();
085                var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
086                
087                result.setLetterChoices(letterControl.getLetterChoices(chainType, defaultLetterChoice,
088                        getPreferredLanguage(), allowNullChoice));
089            } else {
090                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
091            }
092        } else {
093            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
094        }
095        
096        return result;
097    }
098    
099}