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.CreateLetterForm;
020import com.echothree.model.control.chain.server.control.ChainControl;
021import com.echothree.model.control.contactlist.server.control.ContactListControl;
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 CreateLetterCommand
043        extends BaseSimpleCommand<CreateLetterForm> {
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.Letter.name(), SecurityRoles.Create.name())
053                    )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
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                new FieldDefinition("LetterSourceName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("ContactListName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
063                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
064                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
065                ));
066    }
067    
068    /** Creates a new instance of CreateLetterCommand */
069    public CreateLetterCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var chainControl = Session.getModelController(ChainControl.class);
076        var chainKindName = form.getChainKindName();
077        var chainKind = chainControl.getChainKindByName(chainKindName);
078        
079        if(chainKind != null) {
080            var chainTypeName = form.getChainTypeName();
081            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
082            
083            if(chainType != null) {
084                var letterControl = Session.getModelController(LetterControl.class);
085                var letterName = form.getLetterName();
086                var letter = letterControl.getLetterByName(chainType, letterName);
087                
088                if(letter == null) {
089                    var letterSourceName = form.getLetterSourceName();
090                    var letterSource = letterControl.getLetterSourceByName(letterSourceName);
091                    
092                    if(letterSource != null) {
093                        var contactListControl = Session.getModelController(ContactListControl.class);
094                        var contactListName = form.getContactListName();
095                        var contactList = contactListName == null? null: contactListControl.getContactListByName(contactListName);
096                        
097                        if(contactListName == null || contactList != null) {
098                            var partyPK = getPartyPK();
099                            var isDefault = Boolean.valueOf(form.getIsDefault());
100                            var sortOrder = Integer.valueOf(form.getSortOrder());
101                            var description = form.getDescription();
102                            
103                            letter = letterControl.createLetter(chainType, letterName, letterSource, contactList, isDefault,
104                                    sortOrder, partyPK);
105                            
106                            if(description != null) {
107                                letterControl.createLetterDescription(letter, getPreferredLanguage(), description, partyPK);
108                            }
109                        } else {
110                            addExecutionError(ExecutionErrors.UnknownContactListName.name(), contactListName);
111                        }
112                    } else {
113                        addExecutionError(ExecutionErrors.UnknownLetterSourceName.name(), letterSourceName);
114                    }
115                } else {
116                    addExecutionError(ExecutionErrors.DuplicateLetterName.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}