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.contactlist.server.command;
018
019import com.echothree.control.user.contactlist.common.form.CreateContactListForm;
020import com.echothree.model.control.contactlist.server.control.ContactListControl;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.contactlist.common.workflow.PartyContactListStatusConstants;
025import com.echothree.model.control.workflow.server.control.WorkflowControl;
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 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(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.ContactList.name(), SecurityRoles.Create.name())
053                    )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
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    /** Creates a new instance of CreateContactListCommand */
069    public CreateContactListCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var contactListControl = Session.getModelController(ContactListControl.class);
076        var contactListName = form.getContactListName();
077        var contactList = contactListControl.getContactListByName(contactListName);
078
079        if(contactList == null) {
080            var contactListGroupName = form.getContactListGroupName();
081            var contactListGroup = contactListControl.getContactListGroupByName(contactListGroupName);
082
083            if(contactListGroup != null) {
084                var contactListTypeName = form.getContactListTypeName();
085                var contactListType = contactListControl.getContactListTypeByName(contactListTypeName);
086
087                if(contactListType != null) {
088                    var contactListFrequencyName = form.getContactListFrequencyName();
089                    var contactListFrequency = contactListFrequencyName == null ? null : contactListControl.getContactListFrequencyByName(contactListFrequencyName);
090
091                    if(contactListFrequencyName == null || contactListFrequency != null) {
092                        var workflowControl = Session.getModelController(WorkflowControl.class);
093                        var defaultPartyContactListStatusChoice = form.getDefaultPartyContactListStatusChoice();
094                        var workflow = workflowControl.getWorkflowByName(PartyContactListStatusConstants.Workflow_PARTY_CONTACT_LIST_STATUS);
095                        var defaultPartyContactListStatus = workflowControl.getWorkflowEntranceByName(workflow, defaultPartyContactListStatusChoice);
096
097                        if(defaultPartyContactListStatus != 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                            contactList = contactListControl.createContactList(contactListName, contactListGroup, contactListType, contactListFrequency,
104                                    defaultPartyContactListStatus, isDefault, sortOrder, partyPK);
105
106                            if(description != null) {
107                                contactListControl.createContactListDescription(contactList, getPreferredLanguage(), description, partyPK);
108                            }
109                        } else {
110                            addExecutionError(ExecutionErrors.UnknownDefaultPartyContactListStatusChoice.name(), PartyContactListStatusConstants.Workflow_PARTY_CONTACT_LIST_STATUS,
111                                    defaultPartyContactListStatusChoice);
112                        }
113                    } else {
114                        addExecutionError(ExecutionErrors.UnknownContactListFrequencyName.name(), contactListFrequencyName);
115                    }
116                } else {
117                    addExecutionError(ExecutionErrors.UnknownContactListTypeName.name(), contactListTypeName);
118                }
119            } else {
120                addExecutionError(ExecutionErrors.UnknownContactListGroupName.name(), contactListGroupName);
121            }
122        } else {
123            addExecutionError(ExecutionErrors.DuplicateContactListName.name(), contactListName);
124        }
125
126        return null;
127    }
128    
129}