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.GetContactListContactMechanismPurposeForm;
020import com.echothree.control.user.contactlist.common.result.ContactListResultFactory;
021import com.echothree.control.user.contactlist.common.result.GetContactListContactMechanismPurposeResult;
022import com.echothree.model.control.contact.server.logic.ContactMechanismPurposeLogic;
023import com.echothree.model.control.contactlist.server.ContactListControl;
024import com.echothree.model.control.contactlist.server.logic.ContactListLogic;
025import com.echothree.model.control.core.common.EventTypes;
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.contact.server.entity.ContactMechanismPurpose;
030import com.echothree.model.data.contactlist.server.entity.ContactList;
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.BaseResult;
037import com.echothree.util.server.control.BaseSimpleCommand;
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;
045
046public class GetContactListContactMechanismPurposeCommand
047        extends BaseSimpleCommand<GetContactListContactMechanismPurposeForm> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
056                        new SecurityRoleDefinition(SecurityRoleGroups.ContactList.name(), SecurityRoles.ContactListContactMechanismPurpose.name())
057                        )))
058                )));
059        
060        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
061                new FieldDefinition("ContactListName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("ContactMechanismPurposeName", FieldType.ENTITY_NAME, true, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of GetContactListContactMechanismPurposeCommand */
067    public GetContactListContactMechanismPurposeCommand(UserVisitPK userVisitPK, GetContactListContactMechanismPurposeForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070    
071    @Override
072    protected BaseResult execute() {
073        GetContactListContactMechanismPurposeResult result = ContactListResultFactory.getGetContactListContactMechanismPurposeResult();
074        String contactListName = form.getContactListName();
075        ContactList contactList = ContactListLogic.getInstance().getContactListByName(this, contactListName);
076        
077        if(!hasExecutionErrors()) {
078            String contactMechanismPurposeName = form.getContactMechanismPurposeName();
079            ContactMechanismPurpose contactMechanismPurpose = ContactMechanismPurposeLogic.getInstance().getContactMechanismPurposeByName(this, contactMechanismPurposeName);
080            
081            if(!hasExecutionErrors()) {
082                var contactListControl = Session.getModelController(ContactListControl.class);
083                ContactListContactMechanismPurpose contactListContactMechanismPurpose = contactListControl.getContactListContactMechanismPurpose(contactList, contactMechanismPurpose);
084                
085                if(contactListContactMechanismPurpose != null) {
086                    result.setContactListContactMechanismPurpose(contactListControl.getContactListContactMechanismPurposeTransfer(getUserVisit(), contactListContactMechanismPurpose));
087
088                    sendEvent(contactListContactMechanismPurpose.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
089                } else {
090                    addExecutionError(ExecutionErrors.DuplicateContactListContactMechanismPurpose.name(), contactListName, contactMechanismPurposeName);
091                }
092            }
093        }
094        
095        return result;
096    }
097    
098}