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.GetLetterContactMechanismPurposesForm;
020import com.echothree.control.user.letter.common.result.LetterResultFactory;
021import com.echothree.model.control.chain.server.logic.ChainTypeLogic;
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.Letter;
027import com.echothree.model.data.letter.server.entity.LetterContactMechanismPurpose;
028import com.echothree.model.data.letter.server.factory.LetterContactMechanismPurposeFactory;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetLetterContactMechanismPurposesCommand
043        extends BasePaginatedMultipleEntitiesCommand<LetterContactMechanismPurpose, GetLetterContactMechanismPurposesForm> {
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(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.LetterContactMechanismPurpose.name(), SecurityRoles.List.name())
053                ))
054        ));
055        
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062    
063    @Inject
064    LetterControl letterControl;
065
066    @Inject
067    ChainTypeLogic chainTypeLogic;
068
069    /** Creates a new instance of GetLetterContactMechanismPurposesCommand */
070    public GetLetterContactMechanismPurposesCommand() {
071        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
072    }
073
074    private Letter letter;
075
076    @Override
077    protected void handleForm() {
078        var chainKindName = form.getChainKindName();
079        var chainTypeName = form.getChainTypeName();
080        var chainType = chainTypeLogic.getChainTypeByName(this, chainKindName, chainTypeName);
081
082        if(!hasExecutionErrors()) {
083            var letterName = form.getLetterName();
084
085            letter = letterControl.getLetterByName(chainType, letterName);
086
087            if(letter == null) {
088                addExecutionError(com.echothree.util.common.message.ExecutionErrors.UnknownLetterName.name(), letterName);
089            }
090        }
091    }
092
093    @Override
094    protected Long getTotalEntities() {
095        return hasExecutionErrors() ? null : letterControl.countLetterContactMechanismPurposesByLetter(letter);
096    }
097
098    @Override
099    protected Collection<LetterContactMechanismPurpose> getEntities() {
100        return hasExecutionErrors() ? null : letterControl.getLetterContactMechanismPurposesByLetter(letter);
101    }
102
103    @Override
104    protected BaseResult getResult(Collection<LetterContactMechanismPurpose> entities) {
105        var result = LetterResultFactory.getGetLetterContactMechanismPurposesResult();
106
107        if(entities != null) {
108            var userVisit = getUserVisit();
109
110            result.setLetter(letterControl.getLetterTransfer(userVisit, letter));
111
112            if(session.hasLimit(LetterContactMechanismPurposeFactory.class)) {
113                result.setLetterContactMechanismPurposeCount(getTotalEntities());
114            }
115
116            result.setLetterContactMechanismPurposes(letterControl.getLetterContactMechanismPurposeTransfers(userVisit, entities));
117        }
118
119        return result;
120    }
121    
122}