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.model.data.letter.server.entity.Letter;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetLetterCommand
042        extends BaseSingleEntityCommand<Letter, GetLetterForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Review.name())
052                ))
053        ));
054        
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    @Inject
063    LetterControl letterControl;
064
065    @Inject
066    ChainTypeLogic chainTypeLogic;
067
068    /** Creates a new instance of GetLetterCommand */
069    public GetLetterCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072
073    @Override
074    protected Letter getEntity() {
075        Letter letter = null;
076        var chainKindName = form.getChainKindName();
077        var chainTypeName = form.getChainTypeName();
078        var chainType = chainTypeLogic.getChainTypeByName(this, chainKindName, chainTypeName);
079
080        if(!hasExecutionErrors()) {
081            var letterName = form.getLetterName();
082
083            letter = letterControl.getLetterByName(chainType, letterName);
084
085            if(letter != null) {
086                sendEvent(letter.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
087            } else {
088                addExecutionError(ExecutionErrors.UnknownLetterName.name(), chainKindName, chainTypeName, letterName);
089            }
090        }
091
092        return letter;
093    }
094
095    @Override
096    protected BaseResult getResult(Letter letter) {
097        var result = LetterResultFactory.getGetLetterResult();
098
099        if(letter != null) {
100            result.setLetter(letterControl.getLetterTransfer(getUserVisit(), letter));
101        }
102
103        return result;
104    }
105    
106}