001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.SetDefaultContactListContactMechanismPurposeForm;
020import com.echothree.model.control.contact.server.logic.ContactMechanismPurposeLogic;
021import com.echothree.model.control.contactlist.server.ContactListControl;
022import com.echothree.model.control.contactlist.server.logic.ContactListLogic;
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.data.contact.server.entity.ContactMechanismPurpose;
027import com.echothree.model.data.contactlist.server.entity.ContactList;
028import com.echothree.model.data.contactlist.server.value.ContactListContactMechanismPurposeDetailValue;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class SetDefaultContactListContactMechanismPurposeCommand
044        extends BaseSimpleCommand<SetDefaultContactListContactMechanismPurposeForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.ContactList.name(), SecurityRoles.ContactListContactMechanismPurpose.name())
054                        )))
055                )));
056        
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("ContactListName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("ContactMechanismPurposeName", FieldType.ENTITY_NAME, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of SetDefaultContactListContactMechanismPurposeCommand */
064    public SetDefaultContactListContactMechanismPurposeCommand(UserVisitPK userVisitPK, SetDefaultContactListContactMechanismPurposeForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        String contactListName = form.getContactListName();
071        ContactList contactList = ContactListLogic.getInstance().getContactListByName(this, contactListName);
072        
073        if(!hasExecutionErrors()) {
074            String contactMechanismPurposeName = form.getContactMechanismPurposeName();
075            ContactMechanismPurpose contactMechanismPurpose = ContactMechanismPurposeLogic.getInstance().getContactMechanismPurposeByName(this, contactMechanismPurposeName);
076            
077            if(!hasExecutionErrors()) {
078                var contactListControl = Session.getModelController(ContactListControl.class);
079                ContactListContactMechanismPurposeDetailValue contactListContactMechanismPurposeDetailValue = contactListControl.getContactListContactMechanismPurposeDetailValueForUpdate(contactList, contactMechanismPurpose);
080                
081                if(contactListContactMechanismPurposeDetailValue != null) {
082                    contactListContactMechanismPurposeDetailValue.setIsDefault(Boolean.TRUE);
083                    contactListControl.updateContactListContactMechanismPurposeFromValue(contactListContactMechanismPurposeDetailValue, getPartyPK());
084                } else {
085                    addExecutionError(ExecutionErrors.UnknownContactListContactMechanismPurpose.name(), contactListName, contactMechanismPurposeName);
086                }
087            }
088        }
089        
090        return null;
091    }
092    
093}