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.logic.ChainInstanceLogic;
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.letter.server.entity.QueuedLetter;
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.BaseSingleEntityCommand;
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 GetQueuedLetterCommand
041        extends BaseSingleEntityCommand<QueuedLetter, 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    @Inject
061    LetterControl letterControl;
062
063    @Inject
064    ChainInstanceLogic chainInstanceLogic;
065
066    /** Creates a new instance of GetQueuedLetterCommand */
067    public GetQueuedLetterCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070
071    @Override
072    protected QueuedLetter getEntity() {
073        QueuedLetter queuedLetter = null;
074        var chainInstanceName = form.getChainInstanceName();
075        var chainInstance = chainInstanceLogic.getChainInstanceByName(this, chainInstanceName);
076
077        if(!hasExecutionErrors()) {
078            var strQueuedLetterSequence = form.getQueuedLetterSequence();
079            var queuedLetterSequence = Integer.valueOf(strQueuedLetterSequence);
080
081            queuedLetter = letterControl.getQueuedLetter(chainInstance, queuedLetterSequence);
082
083            if(queuedLetter == null) {
084                addExecutionError(ExecutionErrors.UnknownQueuedLetter.name(), chainInstanceName, strQueuedLetterSequence);
085            }
086        }
087
088        return queuedLetter;
089    }
090
091    @Override
092    protected BaseResult getResult(QueuedLetter queuedLetter) {
093        var result = LetterResultFactory.getGetQueuedLetterResult();
094
095        if(queuedLetter != null) {
096            result.setQueuedLetter(letterControl.getQueuedLetterTransfer(getUserVisit(), queuedLetter));
097        }
098
099        return result;
100    }
101    
102}