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.edit.ContactListEditFactory;
020import com.echothree.control.user.contactlist.common.edit.ContactListGroupEdit;
021import com.echothree.control.user.contactlist.common.form.EditContactListGroupForm;
022import com.echothree.control.user.contactlist.common.result.ContactListResultFactory;
023import com.echothree.control.user.contactlist.common.result.EditContactListGroupResult;
024import com.echothree.control.user.contactlist.common.spec.ContactListGroupSpec;
025import com.echothree.model.control.contactlist.server.control.ContactListControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.contactlist.server.entity.ContactListGroup;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.List;
041import javax.enterprise.context.Dependent;
042
043@Dependent
044public class EditContactListGroupCommand
045        extends BaseAbstractEditCommand<ContactListGroupSpec, ContactListGroupEdit, EditContactListGroupResult, ContactListGroup, ContactListGroup> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.ContactListGroup.name(), SecurityRoles.Edit.name())
056                        ))
057                ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("ContactListGroupName", FieldType.ENTITY_NAME, true, null, null)
061                );
062
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("ContactListGroupName", FieldType.ENTITY_NAME, true, 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 EditContactListGroupCommand */
072    public EditContactListGroupCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075
076    @Override
077    public EditContactListGroupResult getResult() {
078        return ContactListResultFactory.getEditContactListGroupResult();
079    }
080
081    @Override
082    public ContactListGroupEdit getEdit() {
083        return ContactListEditFactory.getContactListGroupEdit();
084    }
085
086    @Override
087    public ContactListGroup getEntity(EditContactListGroupResult result) {
088        var contactListControl = Session.getModelController(ContactListControl.class);
089        ContactListGroup contactListGroup;
090        var contactListGroupName = spec.getContactListGroupName();
091
092        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093            contactListGroup = contactListControl.getContactListGroupByName(contactListGroupName);
094        } else { // EditMode.UPDATE
095            contactListGroup = contactListControl.getContactListGroupByNameForUpdate(contactListGroupName);
096        }
097
098        if(contactListGroup == null) {
099            addExecutionError(ExecutionErrors.UnknownContactListGroupName.name(), contactListGroupName);
100        }
101
102        return contactListGroup;
103    }
104
105    @Override
106    public ContactListGroup getLockEntity(ContactListGroup contactListGroup) {
107        return contactListGroup;
108    }
109
110    @Override
111    public void fillInResult(EditContactListGroupResult result, ContactListGroup contactListGroup) {
112        var contactListControl = Session.getModelController(ContactListControl.class);
113
114        result.setContactListGroup(contactListControl.getContactListGroupTransfer(getUserVisit(), contactListGroup));
115    }
116
117    @Override
118    public void doLock(ContactListGroupEdit edit, ContactListGroup contactListGroup) {
119        var contactListControl = Session.getModelController(ContactListControl.class);
120        var contactListGroupDescription = contactListControl.getContactListGroupDescription(contactListGroup, getPreferredLanguage());
121        var contactListGroupDetail = contactListGroup.getLastDetail();
122
123        edit.setContactListGroupName(contactListGroupDetail.getContactListGroupName());
124        edit.setIsDefault(contactListGroupDetail.getIsDefault().toString());
125        edit.setSortOrder(contactListGroupDetail.getSortOrder().toString());
126
127        if(contactListGroupDescription != null) {
128            edit.setDescription(contactListGroupDescription.getDescription());
129        }
130    }
131
132    @Override
133    public void canUpdate(ContactListGroup contactListGroup) {
134        var contactListControl = Session.getModelController(ContactListControl.class);
135        var contactListGroupName = edit.getContactListGroupName();
136        var duplicateContactListGroup = contactListControl.getContactListGroupByName(contactListGroupName);
137
138        if(duplicateContactListGroup != null && !contactListGroup.equals(duplicateContactListGroup)) {
139            addExecutionError(ExecutionErrors.DuplicateContactListGroupName.name(), contactListGroupName);
140        }
141    }
142
143    @Override
144    public void doUpdate(ContactListGroup contactListGroup) {
145        var contactListControl = Session.getModelController(ContactListControl.class);
146        var partyPK = getPartyPK();
147        var contactListGroupDetailValue = contactListControl.getContactListGroupDetailValueForUpdate(contactListGroup);
148        var contactListGroupDescription = contactListControl.getContactListGroupDescriptionForUpdate(contactListGroup, getPreferredLanguage());
149        var description = edit.getDescription();
150
151        contactListGroupDetailValue.setContactListGroupName(edit.getContactListGroupName());
152        contactListGroupDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
153        contactListGroupDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
154
155        contactListControl.updateContactListGroupFromValue(contactListGroupDetailValue, partyPK);
156
157        if(contactListGroupDescription == null && description != null) {
158            contactListControl.createContactListGroupDescription(contactListGroup, getPreferredLanguage(), description, partyPK);
159        } else if(contactListGroupDescription != null && description == null) {
160            contactListControl.deleteContactListGroupDescription(contactListGroupDescription, partyPK);
161        } else if(contactListGroupDescription != null && description != null) {
162            var contactListGroupDescriptionValue = contactListControl.getContactListGroupDescriptionValue(contactListGroupDescription);
163
164            contactListGroupDescriptionValue.setDescription(description);
165            contactListControl.updateContactListGroupDescriptionFromValue(contactListGroupDescriptionValue, partyPK);
166        }
167    }
168
169}