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.core.server.command;
018
019import com.echothree.control.user.core.common.form.GetEntityAttributeForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.logic.EntityAttributeLogic;
022import com.echothree.model.data.core.server.entity.EntityAttribute;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
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 java.util.List;
029
030public class GetEntityAttributeCommand
031        extends BaseSingleEntityCommand<EntityAttribute, GetEntityAttributeForm> {
032
033    // No COMMAND_SECURITY_DEFINITION, anyone may execute this command.
034    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
035    
036    static {
037        FORM_FIELD_DEFINITIONS = List.of(
038                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null),
039                new FieldDefinition("EntityTypeName", FieldType.ENTITY_TYPE_NAME, false, null, null),
040                new FieldDefinition("EntityAttributeName", FieldType.ENTITY_NAME, false, null, null),
041                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
042                new FieldDefinition("Key", FieldType.KEY, false, null, null),
043                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
044                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
045        );
046    }
047    
048    /** Creates a new instance of GetEntityAttributeCommand */
049    public GetEntityAttributeCommand(UserVisitPK userVisitPK, GetEntityAttributeForm form) {
050        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected EntityAttribute getEntity() {
055        return EntityAttributeLogic.getInstance().getEntityAttributeByUniversalSpec(this, form);
056    }
057    
058    @Override
059    protected BaseResult getResult(EntityAttribute entityAttribute) {
060        var coreControl = getCoreControl();
061        var result = CoreResultFactory.getGetEntityAttributeResult();
062
063        if(entityAttribute != null) {
064            result.setEntityAttribute(coreControl.getEntityAttributeTransfer(getUserVisit(), entityAttribute, null));
065        }
066        
067        return result;
068    }
069    
070}