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.GetQueuedLetterForm;
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.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetQueuedLetterCommand
041        extends BaseSimpleCommand<GetQueuedLetterForm> {
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.QueuedLetter.name(), SecurityRoles.Review.name())
051                        ))
052                ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ChainInstanceName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("QueuedLetterSequence", FieldType.UNSIGNED_INTEGER, true, null, null)
057                );
058    }
059    
060    /** Creates a new instance of GetQueuedLetterCommand */
061    public GetQueuedLetterCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var chainControl = Session.getModelController(ChainControl.class);
068        var result = LetterResultFactory.getGetQueuedLetterResult();
069        var chainInstanceName = form.getChainInstanceName();
070        var chainInstance = chainControl.getChainInstanceByName(chainInstanceName);
071        
072        if(chainInstance != null) {
073            var letterControl = Session.getModelController(LetterControl.class);
074            var strQueuedLetterSequence = form.getQueuedLetterSequence();
075            var queuedLetterSequence = Integer.valueOf(strQueuedLetterSequence);
076            var queuedLetter = letterControl.getQueuedLetter(chainInstance, queuedLetterSequence);
077
078            if(queuedLetter != null) {
079                result.setQueuedLetter(letterControl.getQueuedLetterTransfer(getUserVisit(), queuedLetter));
080            } else {
081                addExecutionError(ExecutionErrors.UnknownQueuedLetter.name(), chainInstanceName, strQueuedLetterSequence);
082            }
083        } else {
084            addExecutionError(ExecutionErrors.UnknownChainInstanceName.name(), chainInstanceName);
085        }
086        
087        return result;
088    }
089    
090}