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.GetLetterForm;
020import com.echothree.control.user.letter.common.result.LetterResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
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.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040import javax.enterprise.context.RequestScoped;
041
042@RequestScoped
043public class GetLetterCommand
044        extends BaseSimpleCommand<GetLetterForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Review.name())
054                        )))
055                )));
056        
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetLetterCommand */
065    public GetLetterCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var chainControl = Session.getModelController(ChainControl.class);
072        var result = LetterResultFactory.getGetLetterResult();
073        var chainKindName = form.getChainKindName();
074        var chainKind = chainControl.getChainKindByName(chainKindName);
075        
076        if(chainKind != null) {
077            var chainTypeName = form.getChainTypeName();
078            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
079            
080            if(chainType != null) {
081                var letterControl = Session.getModelController(LetterControl.class);
082                var letterName = form.getLetterName();
083                var letter = letterControl.getLetterByName(chainType, letterName);
084                
085                if(letter != null) {
086                    result.setLetter(letterControl.getLetterTransfer(getUserVisit(), letter));
087                    
088                    sendEvent(letter.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
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}