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.CreateLetterForm;
020import com.echothree.control.user.letter.common.result.LetterResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
022import com.echothree.model.control.contactlist.server.control.ContactListControl;
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.letter.server.entity.Letter;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseSimpleCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
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(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Create.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                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    @Inject
069    ChainControl chainControl;
070
071    @Inject
072    ContactListControl contactListControl;
073
074    @Inject
075    LetterControl letterControl;
076
077    
078    /** Creates a new instance of CreateLetterCommand */
079    public CreateLetterCommand() {
080        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
081    }
082    
083    @Override
084    protected BaseResult execute() {
085        var result = LetterResultFactory.getCreateLetterResult();
086        Letter letter = null;
087        var chainKindName = form.getChainKindName();
088        var chainKind = chainControl.getChainKindByName(chainKindName);
089        
090        if(chainKind != null) {
091            var chainTypeName = form.getChainTypeName();
092            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
093            
094            if(chainType != null) {
095                var letterName = form.getLetterName();
096
097                letter = letterControl.getLetterByName(chainType, letterName);
098                
099                if(letter == null) {
100                    var letterSourceName = form.getLetterSourceName();
101                    var letterSource = letterControl.getLetterSourceByName(letterSourceName);
102                    
103                    if(letterSource != null) {
104                        var contactListName = form.getContactListName();
105                        var contactList = contactListName == null? null: contactListControl.getContactListByName(contactListName);
106                        
107                        if(contactListName == null || contactList != null) {
108                            var partyPK = getPartyPK();
109                            var isDefault = Boolean.valueOf(form.getIsDefault());
110                            var sortOrder = Integer.valueOf(form.getSortOrder());
111                            var description = form.getDescription();
112                            
113                            letter = letterControl.createLetter(chainType, letterName, letterSource, contactList, isDefault,
114                                    sortOrder, partyPK);
115                            
116                            if(description != null) {
117                                letterControl.createLetterDescription(letter, getPreferredLanguage(), description, partyPK);
118                            }
119                        } else {
120                            addExecutionError(ExecutionErrors.UnknownContactListName.name(), contactListName);
121                        }
122                    } else {
123                        addExecutionError(ExecutionErrors.UnknownLetterSourceName.name(), letterSourceName);
124                    }
125                } else {
126                    addExecutionError(ExecutionErrors.DuplicateLetterName.name(), letterName);
127                }
128            } else {
129                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
130            }
131        } else {
132            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
133        }
134        
135        if(letter != null) {
136            result.setEntityRef(letter.getPrimaryKey().getEntityRef());
137            result.setChainKindName(letter.getLastDetail().getChainType().getLastDetail().getChainKind().getLastDetail().getChainKindName());
138            result.setChainTypeName(letter.getLastDetail().getChainType().getLastDetail().getChainTypeName());
139            result.setLetterName(letter.getLastDetail().getLetterName());
140        }
141
142        return result;
143    }
144    
145}