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.contactlist.server.command;
018
019import com.echothree.control.user.contactlist.common.form.CreateContactListForm;
020import com.echothree.control.user.contactlist.common.result.ContactListResultFactory;
021import com.echothree.model.control.contactlist.common.workflow.PartyContactListStatusConstants;
022import com.echothree.model.control.contactlist.server.control.ContactListControl;
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.control.workflow.server.control.WorkflowControl;
027import com.echothree.model.data.contactlist.server.entity.ContactList;
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 CreateContactListCommand
043        extends BaseSimpleCommand<CreateContactListForm> {
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.ContactList.name(), SecurityRoles.Create.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("ContactListName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ContactListGroupName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("ContactListTypeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("ContactListFrequencyName", FieldType.ENTITY_NAME, false, null, null),
061                new FieldDefinition("DefaultPartyContactListStatusChoice", FieldType.ENTITY_NAME, true, 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    ContactListControl contactListControl;
070
071    @Inject
072    WorkflowControl workflowControl;
073
074    /** Creates a new instance of CreateContactListCommand */
075    public CreateContactListCommand() {
076        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
077    }
078    
079    @Override
080    protected BaseResult execute() {
081        var result = ContactListResultFactory.getCreateContactListResult();
082        var contactListName = form.getContactListName();
083        var contactList = contactListControl.getContactListByName(contactListName);
084
085        if(contactList == null) {
086            var contactListGroupName = form.getContactListGroupName();
087            var contactListGroup = contactListControl.getContactListGroupByName(contactListGroupName);
088
089            if(contactListGroup != null) {
090                var contactListTypeName = form.getContactListTypeName();
091                var contactListType = contactListControl.getContactListTypeByName(contactListTypeName);
092
093                if(contactListType != null) {
094                    var contactListFrequencyName = form.getContactListFrequencyName();
095                    var contactListFrequency = contactListFrequencyName == null ? null : contactListControl.getContactListFrequencyByName(contactListFrequencyName);
096
097                    if(contactListFrequencyName == null || contactListFrequency != null) {
098                        var defaultPartyContactListStatusChoice = form.getDefaultPartyContactListStatusChoice();
099                        var workflow = workflowControl.getWorkflowByName(PartyContactListStatusConstants.Workflow_PARTY_CONTACT_LIST_STATUS);
100                        var defaultPartyContactListStatus = workflowControl.getWorkflowEntranceByName(workflow, defaultPartyContactListStatusChoice);
101
102                        if(defaultPartyContactListStatus != null) {
103                            var partyPK = getPartyPK();
104                            var isDefault = Boolean.valueOf(form.getIsDefault());
105                            var sortOrder = Integer.valueOf(form.getSortOrder());
106                            var description = form.getDescription();
107
108                            contactList = contactListControl.createContactList(contactListName, contactListGroup, contactListType, contactListFrequency,
109                                    defaultPartyContactListStatus, isDefault, sortOrder, partyPK);
110
111                            if(description != null) {
112                                contactListControl.createContactListDescription(contactList, getPreferredLanguage(), description, partyPK);
113                            }
114                        } else {
115                            addExecutionError(ExecutionErrors.UnknownDefaultPartyContactListStatusChoice.name(), PartyContactListStatusConstants.Workflow_PARTY_CONTACT_LIST_STATUS,
116                                    defaultPartyContactListStatusChoice);
117                        }
118                    } else {
119                        addExecutionError(ExecutionErrors.UnknownContactListFrequencyName.name(), contactListFrequencyName);
120                    }
121                } else {
122                    addExecutionError(ExecutionErrors.UnknownContactListTypeName.name(), contactListTypeName);
123                }
124            } else {
125                addExecutionError(ExecutionErrors.UnknownContactListGroupName.name(), contactListGroupName);
126            }
127        } else {
128            addExecutionError(ExecutionErrors.DuplicateContactListName.name(), contactListName);
129        }
130
131        if(contactList != null) {
132            result.setEntityRef(contactList.getPrimaryKey().getEntityRef());
133            result.setContactListName(contactList.getLastDetail().getContactListName());
134        }
135
136        return result;
137    }
138    
139}