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.CreateLetterForm;
020import com.echothree.model.control.chain.server.control.ChainControl;
021import com.echothree.model.control.contactlist.server.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.chain.server.entity.ChainKind;
027import com.echothree.model.data.chain.server.entity.ChainType;
028import com.echothree.model.data.contactlist.server.entity.ContactList;
029import com.echothree.model.data.letter.server.entity.Letter;
030import com.echothree.model.data.letter.server.entity.LetterSource;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class CreateLetterCommand
046        extends BaseSimpleCommand<CreateLetterForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                    new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Create.name())
056                    )))
057                )));
058        
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LetterSourceName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("ContactListName", FieldType.ENTITY_NAME, false, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068                ));
069    }
070    
071    /** Creates a new instance of CreateLetterCommand */
072    public CreateLetterCommand(UserVisitPK userVisitPK, CreateLetterForm form) {
073        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
074    }
075    
076    @Override
077    protected BaseResult execute() {
078        var chainControl = Session.getModelController(ChainControl.class);
079        String chainKindName = form.getChainKindName();
080        ChainKind chainKind = chainControl.getChainKindByName(chainKindName);
081        
082        if(chainKind != null) {
083            String chainTypeName = form.getChainTypeName();
084            ChainType chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
085            
086            if(chainType != null) {
087                var letterControl = Session.getModelController(LetterControl.class);
088                String letterName = form.getLetterName();
089                Letter letter = letterControl.getLetterByName(chainType, letterName);
090                
091                if(letter == null) {
092                    String letterSourceName = form.getLetterSourceName();
093                    LetterSource letterSource = letterControl.getLetterSourceByName(letterSourceName);
094                    
095                    if(letterSource != null) {
096                        var contactListControl = Session.getModelController(ContactListControl.class);
097                        String contactListName = form.getContactListName();
098                        ContactList contactList = contactListName == null? null: contactListControl.getContactListByName(contactListName);
099                        
100                        if(contactListName == null || contactList != null) {
101                            var partyPK = getPartyPK();
102                            var isDefault = Boolean.valueOf(form.getIsDefault());
103                            var sortOrder = Integer.valueOf(form.getSortOrder());
104                            var description = form.getDescription();
105                            
106                            letter = letterControl.createLetter(chainType, letterName, letterSource, contactList, isDefault,
107                                    sortOrder, partyPK);
108                            
109                            if(description != null) {
110                                letterControl.createLetterDescription(letter, getPreferredLanguage(), description, partyPK);
111                            }
112                        } else {
113                            addExecutionError(ExecutionErrors.UnknownContactListName.name(), contactListName);
114                        }
115                    } else {
116                        addExecutionError(ExecutionErrors.UnknownLetterSourceName.name(), letterSourceName);
117                    }
118                } else {
119                    addExecutionError(ExecutionErrors.DuplicateLetterName.name(), letterName);
120                }
121            } else {
122                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
123            }
124        } else {
125            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
126        }
127        
128        return null;
129    }
130    
131}