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.inventory.server.command;
018
019import com.echothree.control.user.inventory.common.form.GetInventoryConditionForm;
020import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.inventory.server.control.InventoryControl;
023import com.echothree.model.control.inventory.server.logic.InventoryConditionLogic;
024import com.echothree.model.data.inventory.server.entity.InventoryCondition;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSingleEntityCommand;
030import com.echothree.util.server.persistence.Session;
031import java.util.List;
032
033public class GetInventoryConditionCommand
034        extends BaseSingleEntityCommand<InventoryCondition, GetInventoryConditionForm> {
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("InventoryConditionName", FieldType.ENTITY_NAME, false, null, null),
042                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
043                new FieldDefinition("Key", FieldType.KEY, false, null, null),
044                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
045                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
046        );
047    }
048    
049    /** Creates a new instance of GetInventoryConditionCommand */
050    public GetInventoryConditionCommand(UserVisitPK userVisitPK, GetInventoryConditionForm form) {
051        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
052    }
053    
054    @Override
055    protected InventoryCondition getEntity() {
056        var entity = InventoryConditionLogic.getInstance().getInventoryConditionByUniversalSpec(this, form, true);
057
058        if(entity != null) {
059            sendEvent(entity.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
060        }
061
062        return entity;
063    }
064    
065    @Override
066    protected BaseResult getResult(InventoryCondition entity) {
067        var inventoryControl = Session.getModelController(InventoryControl.class);
068        var result = InventoryResultFactory.getGetInventoryConditionResult();
069
070        if(entity != null) {
071            result.setInventoryCondition(inventoryControl.getInventoryConditionTransfer(getUserVisit(), entity));
072        }
073
074        return result;
075    }
076    
077}