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