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.contact.server.command;
018
019import com.echothree.control.user.contact.common.form.GetContactMechanismPurposeForm;
020import com.echothree.control.user.contact.common.result.ContactResultFactory;
021import com.echothree.model.control.contact.server.control.ContactControl;
022import com.echothree.model.control.contact.server.logic.ContactMechanismPurposeLogic;
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.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetContactMechanismPurposeCommand
041        extends BaseSingleEntityCommand<ContactMechanismPurpose, GetContactMechanismPurposeForm> {
042    
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        FORM_FIELD_DEFINITIONS = List.of(
047                new FieldDefinition("ContactMechanismPurposeName", FieldType.ENTITY_NAME, false, null, null),
048                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
049                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
050                );
051    }
052    
053    /** Creates a new instance of GetContactMechanismPurposeCommand */
054    public GetContactMechanismPurposeCommand() {
055        super(null, FORM_FIELD_DEFINITIONS, true);
056    }
057
058    @Override
059    protected ContactMechanismPurpose getEntity() {
060        var contactMechanismPurpose = ContactMechanismPurposeLogic.getInstance().getContactMechanismPurposeByUniversalSpec(this, form);
061
062        return contactMechanismPurpose;
063    }
064
065    @Override
066    protected BaseResult getResult(ContactMechanismPurpose contactMechanismPurpose) {
067        var result = ContactResultFactory.getGetContactMechanismPurposeResult();
068
069        if(contactMechanismPurpose != null) {
070            var contactControl = Session.getModelController(ContactControl.class);
071
072            result.setContactMechanismPurpose(contactControl.getContactMechanismPurposeTransfer(getUserVisit(), contactMechanismPurpose));
073        }
074
075        return result;
076    }
077
078}