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.form.GetContactListContactMechanismPurposeForm;
020import com.echothree.control.user.contactlist.common.result.ContactListResultFactory;
021import com.echothree.model.control.contact.server.logic.ContactMechanismPurposeLogic;
022import com.echothree.model.control.contactlist.server.control.ContactListControl;
023import com.echothree.model.control.contactlist.server.logic.ContactListLogic;
024import com.echothree.model.control.core.common.EventTypes;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.data.contactlist.server.entity.ContactListContactMechanismPurpose;
029import com.echothree.util.common.command.BaseResult;
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.server.control.BaseSingleEntityCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetContactListContactMechanismPurposeCommand
043        extends BaseSingleEntityCommand<ContactListContactMechanismPurpose, GetContactListContactMechanismPurposeForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.ContactList.name(), SecurityRoles.ContactListContactMechanismPurpose.name())
053                ))
054        ));
055        
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("ContactListName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ContactMechanismPurposeName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061    
062    @Inject
063    ContactListControl contactListControl;
064
065    @Inject
066    ContactListLogic contactListLogic;
067
068    @Inject
069    ContactMechanismPurposeLogic contactMechanismPurposeLogic;
070
071    /** Creates a new instance of GetContactListContactMechanismPurposeCommand */
072    public GetContactListContactMechanismPurposeCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075    
076    @Override
077    protected ContactListContactMechanismPurpose getEntity() {
078        ContactListContactMechanismPurpose contactListContactMechanismPurpose = null;
079        var contactListName = form.getContactListName();
080        var contactList = contactListLogic.getContactListByName(this, contactListName);
081
082        if(!hasExecutionErrors()) {
083            var contactMechanismPurposeName = form.getContactMechanismPurposeName();
084            var contactMechanismPurpose = contactMechanismPurposeLogic.getContactMechanismPurposeByName(this, contactMechanismPurposeName);
085
086            if(!hasExecutionErrors()) {
087                contactListContactMechanismPurpose = contactListControl.getContactListContactMechanismPurpose(contactList, contactMechanismPurpose);
088
089                if(contactListContactMechanismPurpose != null) {
090                    sendEvent(contactListContactMechanismPurpose.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
091                } else {
092                    addExecutionError(ExecutionErrors.DuplicateContactListContactMechanismPurpose.name(), contactListName, contactMechanismPurposeName);
093                }
094            }
095        }
096
097        return contactListContactMechanismPurpose;
098    }
099
100    @Override
101    protected BaseResult getResult(ContactListContactMechanismPurpose contactListContactMechanismPurpose) {
102        var result = ContactListResultFactory.getGetContactListContactMechanismPurposeResult();
103
104        if(contactListContactMechanismPurpose != null) {
105            result.setContactListContactMechanismPurpose(contactListControl.getContactListContactMechanismPurposeTransfer(getUserVisit(), contactListContactMechanismPurpose));
106        }
107
108        return result;
109    }
110    
111}