001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.GetLetterDescriptionsForm;
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 com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetLetterDescriptionsCommand
043        extends BaseSimpleCommand<GetLetterDescriptionsForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Description.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("LetterName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of GetLetterDescriptionsCommand */
064    public GetLetterDescriptionsCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var chainControl = Session.getModelController(ChainControl.class);
071        var result = LetterResultFactory.getGetLetterDescriptionsResult();
072        var chainKindName = form.getChainKindName();
073        var chainKind = chainControl.getChainKindByName(chainKindName);
074        
075        if(chainKind != null) {
076            var chainTypeName = form.getChainTypeName();
077            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
078            
079            if(chainType != null) {
080                var letterControl = Session.getModelController(LetterControl.class);
081                var letterName = form.getLetterName();
082                var letter = letterControl.getLetterByName(chainType, letterName);
083                
084                if(letter != null) {
085                    result.setLetter(letterControl.getLetterTransfer(getUserVisit(), letter));
086                    result.setLetterDescriptions(letterControl.getLetterDescriptionTransfersByLetter(getUserVisit(), letter));
087                } else {
088                    addExecutionError(ExecutionErrors.UnknownLetterName.name(), letterName);
089                }
090            } else {
091                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
092            }
093        } else {
094            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
095        }
096        
097        return result;
098    }
099    
100}