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