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.GetLetterForm;
020import com.echothree.control.user.letter.common.result.LetterResultFactory;
021import com.echothree.model.control.chain.server.logic.ChainTypeLogic;
022import com.echothree.model.control.core.common.EventTypes;
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.util.common.command.BaseResult;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
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 GetLetterCommand
041        extends BaseSimpleCommand<GetLetterForm> {
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.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Review.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060    
061    /** Creates a new instance of GetLetterCommand */
062    public GetLetterCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    @Inject
067    LetterControl letterControl;
068
069    @Inject
070    ChainTypeLogic chainTypeLogic;
071
072    @Override
073    protected BaseResult execute() {
074        var result = LetterResultFactory.getGetLetterResult();
075        var chainKindName = form.getChainKindName();
076        var chainTypeName = form.getChainTypeName();
077        var chainType = chainTypeLogic.getChainTypeByName(this, chainKindName, chainTypeName);
078
079        if(!hasExecutionErrors()) {
080            var letterName = form.getLetterName();
081            var letter = letterControl.getLetterByName(chainType, letterName);
082
083            if(letter != null) {
084                result.setLetter(letterControl.getLetterTransfer(getUserVisit(), letter));
085
086                sendEvent(letter.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
087            } else {
088                addExecutionError(ExecutionErrors.UnknownLetterName.name(), letterName);
089            }
090        }
091
092        return result;
093    }
094    
095}