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.ContactListContactMechanismPurposeEdit;
020import com.echothree.control.user.contactlist.common.edit.ContactListEditFactory;
021import com.echothree.control.user.contactlist.common.form.EditContactListContactMechanismPurposeForm;
022import com.echothree.control.user.contactlist.common.result.ContactListResultFactory;
023import com.echothree.control.user.contactlist.common.result.EditContactListContactMechanismPurposeResult;
024import com.echothree.control.user.contactlist.common.spec.ContactListContactMechanismPurposeSpec;
025import com.echothree.model.control.contact.server.logic.ContactMechanismPurposeLogic;
026import com.echothree.model.control.contactlist.server.control.ContactListControl;
027import com.echothree.model.control.contactlist.server.logic.ContactListLogic;
028import com.echothree.model.control.party.common.PartyTypes;
029import com.echothree.model.control.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.data.contactlist.server.entity.ContactListContactMechanismPurpose;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.message.ExecutionErrors;
034import com.echothree.util.common.validation.FieldDefinition;
035import com.echothree.util.common.validation.FieldType;
036import com.echothree.util.common.command.EditMode;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditContactListContactMechanismPurposeCommand
047        extends BaseAbstractEditCommand<ContactListContactMechanismPurposeSpec, ContactListContactMechanismPurposeEdit, EditContactListContactMechanismPurposeResult, ContactListContactMechanismPurpose, ContactListContactMechanismPurpose> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.ContactList.name(), SecurityRoles.ContactListContactMechanismPurpose.name())
058                ))
059        ));
060        
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("ContactListName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("ContactMechanismPurposeName", FieldType.ENTITY_NAME, true, null, null)
064        );
065        
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
068                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null)
069        );
070    }
071
072    @Inject
073    ContactListControl contactListControl;
074
075    @Inject
076    ContactListLogic contactListLogic;
077
078    @Inject
079    ContactMechanismPurposeLogic contactMechanismPurposeLogic;
080
081    
082    /** Creates a new instance of EditContactListContactMechanismPurposeCommand */
083    public EditContactListContactMechanismPurposeCommand() {
084        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
085    }
086    
087    @Override
088    public EditContactListContactMechanismPurposeResult getResult() {
089        return ContactListResultFactory.getEditContactListContactMechanismPurposeResult();
090    }
091
092    @Override
093    public ContactListContactMechanismPurposeEdit getEdit() {
094        return ContactListEditFactory.getContactListContactMechanismPurposeEdit();
095    }
096
097    @Override
098    public ContactListContactMechanismPurpose getEntity(EditContactListContactMechanismPurposeResult result) {
099        ContactListContactMechanismPurpose contactListContactMechanismPurpose = null;
100        var contactListName = spec.getContactListName();
101        var contactList = contactListLogic.getContactListByName(this, contactListName);
102        
103        if(!hasExecutionErrors()) {
104            var contactMechanismPurposeName = spec.getContactMechanismPurposeName();
105            var contactMechanismPurpose = contactMechanismPurposeLogic.getContactMechanismPurposeByName(this, contactMechanismPurposeName);
106            
107            if(!hasExecutionErrors()) {
108                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
109                    contactListContactMechanismPurpose = contactListControl.getContactListContactMechanismPurpose(contactList, contactMechanismPurpose);
110                } else { // EditMode.UPDATE
111                    contactListContactMechanismPurpose = contactListControl.getContactListContactMechanismPurposeForUpdate(contactList, contactMechanismPurpose);
112                }
113
114                if(contactListContactMechanismPurpose == null) {
115                    addExecutionError(ExecutionErrors.UnknownContactListContactMechanismPurpose.name(), contactListName, contactMechanismPurposeName);
116                }
117            }
118        }
119
120        return contactListContactMechanismPurpose;
121    }
122
123    @Override
124    public ContactListContactMechanismPurpose getLockEntity(ContactListContactMechanismPurpose contactListContactMechanismPurpose) {
125        return contactListContactMechanismPurpose;
126    }
127
128    @Override
129    public void fillInResult(EditContactListContactMechanismPurposeResult result, ContactListContactMechanismPurpose contactListContactMechanismPurpose) {
130        result.setContactListContactMechanismPurpose(contactListControl.getContactListContactMechanismPurposeTransfer(getUserVisit(), contactListContactMechanismPurpose));
131    }
132
133    @Override
134    public void doLock(ContactListContactMechanismPurposeEdit edit, ContactListContactMechanismPurpose contactListContactMechanismPurpose) {
135        var contactListContactMechanismPurposeDetail = contactListContactMechanismPurpose.getLastDetail();
136
137        edit.setIsDefault(contactListContactMechanismPurposeDetail.getIsDefault().toString());
138        edit.setSortOrder(contactListContactMechanismPurposeDetail.getSortOrder().toString());
139    }
140
141    @Override
142    public void doUpdate(ContactListContactMechanismPurpose contactListContactMechanismPurpose) {
143        var partyPK = getPartyPK();
144        var contactListContactMechanismPurposeDetailValue = contactListControl.getContactListContactMechanismPurposeDetailValueForUpdate(contactListContactMechanismPurpose);
145
146        contactListContactMechanismPurposeDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
147        contactListContactMechanismPurposeDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
148
149        contactListControl.updateContactListContactMechanismPurposeFromValue(contactListContactMechanismPurposeDetailValue, partyPK);
150    }
151    
152}