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.GetLetterDescriptionsForm;
020import com.echothree.control.user.letter.common.result.GetLetterDescriptionsResult;
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.letter.server.entity.Letter;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.BaseResult;
035import com.echothree.util.server.control.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.Arrays;
041import java.util.Collections;
042import java.util.List;
043
044public class GetLetterDescriptionsCommand
045        extends BaseSimpleCommand<GetLetterDescriptionsForm> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Description.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null)
062                ));
063    }
064    
065    /** Creates a new instance of GetLetterDescriptionsCommand */
066    public GetLetterDescriptionsCommand(UserVisitPK userVisitPK, GetLetterDescriptionsForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var chainControl = Session.getModelController(ChainControl.class);
073        GetLetterDescriptionsResult result = LetterResultFactory.getGetLetterDescriptionsResult();
074        String chainKindName = form.getChainKindName();
075        ChainKind chainKind = chainControl.getChainKindByName(chainKindName);
076        
077        if(chainKind != null) {
078            String chainTypeName = form.getChainTypeName();
079            ChainType chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
080            
081            if(chainType != null) {
082                var letterControl = Session.getModelController(LetterControl.class);
083                String letterName = form.getLetterName();
084                Letter letter = letterControl.getLetterByName(chainType, letterName);
085                
086                if(letter != null) {
087                    result.setLetter(letterControl.getLetterTransfer(getUserVisit(), letter));
088                    result.setLetterDescriptions(letterControl.getLetterDescriptionTransfersByLetter(getUserVisit(), letter));
089                } else {
090                    addExecutionError(ExecutionErrors.UnknownLetterName.name(), letterName);
091                }
092            } else {
093                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
094            }
095        } else {
096            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
097        }
098        
099        return result;
100    }
101    
102}