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