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.CreateLetterContactMechanismPurposeForm;
020import com.echothree.model.control.chain.server.control.ChainControl;
021import com.echothree.model.control.contact.common.ContactMechanismTypes;
022import com.echothree.model.control.contact.server.control.ContactControl;
023import com.echothree.model.control.letter.server.control.LetterControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040import javax.enterprise.context.RequestScoped;
041
042@RequestScoped
043public class CreateLetterContactMechanismPurposeCommand
044        extends BaseSimpleCommand<CreateLetterContactMechanismPurposeForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                new SecurityRoleDefinition(SecurityRoleGroups.LetterContactMechanismPurpose.name(), SecurityRoles.Create.name())
054                )))
055                )));
056        
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("Priority", FieldType.SIGNED_INTEGER, true, null, null),
062                new FieldDefinition("ContactMechanismPurposeName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of CreateLetterContactMechanismPurposeCommand */
067    public CreateLetterContactMechanismPurposeCommand() {
068        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        var chainControl = Session.getModelController(ChainControl.class);
074        var chainKindName = form.getChainKindName();
075        var chainKind = chainControl.getChainKindByName(chainKindName);
076        
077        if(chainKind != null) {
078            var chainTypeName = form.getChainTypeName();
079            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
080            
081            if(chainType != null) {
082                var letterControl = Session.getModelController(LetterControl.class);
083                var letterName = form.getLetterName();
084                var letter = letterControl.getLetterByName(chainType, letterName);
085                
086                if(letter != null) {
087                    var priority = Integer.valueOf(form.getPriority());
088                    var letterContactMechanismPurpose = letterControl.getLetterContactMechanismPurpose(letter,
089                            priority);
090                    
091                    if(letterContactMechanismPurpose == null) {
092                        var contactControl = Session.getModelController(ContactControl.class);
093                        var contactMechanismPurposeName = form.getContactMechanismPurposeName();
094                        var contactMechanismPurpose = contactControl.getContactMechanismPurposeByName(contactMechanismPurposeName);
095                        
096                        if(contactMechanismPurpose != null) {
097                            var contactMechanismTypeName = contactMechanismPurpose.getContactMechanismType().getContactMechanismTypeName();
098                            
099                            if(contactMechanismTypeName.equals(ContactMechanismTypes.EMAIL_ADDRESS.name())
100                                    || contactMechanismTypeName.equals(ContactMechanismTypes.POSTAL_ADDRESS.name())) {
101                                letterControl.createLetterContactMechanismPurpose(letter, priority, contactMechanismPurpose,
102                                        getPartyPK());
103                            } else {
104                                addExecutionError(ExecutionErrors.InvalidContactMechanismType.name(), contactMechanismTypeName);
105                            }
106                        } else {
107                            addExecutionError(ExecutionErrors.UnknownContactMechanismPurposeName.name(), contactMechanismPurposeName);
108                        }
109                    } else {
110                        addExecutionError(ExecutionErrors.DuplicateLetterContactMechanismPurpose.name());
111                    }
112                } else {
113                    addExecutionError(ExecutionErrors.UnknownLetterName.name(), letterName);
114                }
115            } else {
116                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
117            }
118        } else {
119            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
120        }
121        
122        return null;
123    }
124    
125}