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.GetQueuedLettersForm;
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 GetQueuedLettersCommand
041        extends BaseSimpleCommand<GetQueuedLettersForm> {
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.List.name())
051                    ))
052                ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, false, null, null)
058                );
059    }
060    
061    /** Creates a new instance of GetQueuedLettersCommand */
062    public GetQueuedLettersCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var chainControl = Session.getModelController(ChainControl.class);
069        var result = LetterResultFactory.getGetQueuedLettersResult();
070        var chainKindName = form.getChainKindName();
071        var chainTypeName = form.getChainTypeName();
072        var letterName = form.getLetterName();
073        var parameterCount = (chainKindName != null? 1: 0) + (chainTypeName != null && letterName != null? 1: 0);
074
075        if(parameterCount == 0 || parameterCount == 3) {
076            var chainKind = chainKindName == null ? null : chainControl.getChainKindByName(chainKindName);
077
078            if(chainKindName == null || chainKind != null) {
079                var chainType = chainTypeName == null ? null : chainControl.getChainTypeByName(chainKind, chainTypeName);
080
081                if(chainTypeName == null || chainType != null) {
082                    var letterControl = Session.getModelController(LetterControl.class);
083                    var letter = letterName == null ? null : letterControl.getLetterByName(chainType, letterName);
084
085                    if(letterName == null || letter != null) {
086                        if(letter == null) {
087                            result.setQueuedLetters(letterControl.getQueuedLetterTransfers(getUserVisit()));
088                        } else {
089                            result.setLetter(letterControl.getLetterTransfer(getUserVisit(), letter));
090                            result.setQueuedLetters(letterControl.getQueuedLetterTransfersByLetter(getUserVisit(), letter));
091                        }
092                    } else {
093                        addExecutionError(ExecutionErrors.UnknownLetterName.name(), chainKindName, chainTypeName, letterName);
094                    }
095                } else {
096                    addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
097                }
098            } else {
099                addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
100            }
101        } else {
102            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
103        }
104        
105        return result;
106    }
107    
108}