001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetContactMechanismPurposeCommand
043        extends BaseSingleEntityCommand<ContactMechanismPurpose, GetContactMechanismPurposeForm> {
044    
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
049                new FieldDefinition("ContactMechanismPurposeName", FieldType.ENTITY_NAME, false, null, null),
050                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
051                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
052                ));
053    }
054    
055    /** Creates a new instance of GetContactMechanismPurposeCommand */
056    public GetContactMechanismPurposeCommand() {
057        super(null, FORM_FIELD_DEFINITIONS, true);
058    }
059
060    @Override
061    protected ContactMechanismPurpose getEntity() {
062        var contactMechanismPurpose = ContactMechanismPurposeLogic.getInstance().getContactMechanismPurposeByUniversalSpec(this, form);
063
064        return contactMechanismPurpose;
065    }
066
067    @Override
068    protected BaseResult getResult(ContactMechanismPurpose contactMechanismPurpose) {
069        var result = ContactResultFactory.getGetContactMechanismPurposeResult();
070
071        if(contactMechanismPurpose != null) {
072            var contactControl = Session.getModelController(ContactControl.class);
073
074            result.setContactMechanismPurpose(contactControl.getContactMechanismPurposeTransfer(getUserVisit(), contactMechanismPurpose));
075        }
076
077        return result;
078    }
079
080}