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