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.uom.server.command;
018
019import com.echothree.control.user.uom.common.form.GetUnitOfMeasureKindUseForm;
020import com.echothree.control.user.uom.common.result.GetUnitOfMeasureKindUseResult;
021import com.echothree.control.user.uom.common.result.UomResultFactory;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.uom.server.control.UomControl;
024import com.echothree.model.control.uom.server.logic.UnitOfMeasureKindUseLogic;
025import com.echothree.model.data.uom.server.entity.UnitOfMeasureKindUse;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSingleEntityCommand;
031import com.echothree.util.server.persistence.Session;
032import java.util.Arrays;
033import java.util.Collections;
034import java.util.List;
035
036public class GetUnitOfMeasureKindUseCommand
037        extends BaseSingleEntityCommand<UnitOfMeasureKindUse, GetUnitOfMeasureKindUseForm> {
038    
039    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
040    
041    static {
042        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
043            new FieldDefinition("UnitOfMeasureKindName", FieldType.ENTITY_NAME, true, null, null),
044            new FieldDefinition("UnitOfMeasureKindUseTypeName", FieldType.ENTITY_NAME, true, null, null)
045        ));
046    }
047    
048    /** Creates a new instance of GetUnitOfMeasureKindUseCommand */
049    public GetUnitOfMeasureKindUseCommand(UserVisitPK userVisitPK, GetUnitOfMeasureKindUseForm form) {
050        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
051    }
052    
053    @Override
054    protected UnitOfMeasureKindUse getEntity() {
055        UnitOfMeasureKindUse unitOfMeasureKindUse = UnitOfMeasureKindUseLogic.getInstance().getUnitOfMeasureKindUse(this,
056                form.getUnitOfMeasureKindUseTypeName(), form.getUnitOfMeasureKindName());
057        
058        if(!hasExecutionErrors()) {
059            sendEvent(unitOfMeasureKindUse.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
060        }
061        
062        return unitOfMeasureKindUse;
063    }
064    
065    @Override
066    protected BaseResult getResult(UnitOfMeasureKindUse unitOfMeasureKindUse) {
067        var uomControl = Session.getModelController(UomControl.class);
068        GetUnitOfMeasureKindUseResult result = UomResultFactory.getGetUnitOfMeasureKindUseResult();
069        
070        if(unitOfMeasureKindUse != null) {
071            result.setUnitOfMeasureKindUse(uomControl.getUnitOfMeasureKindUseTransfer(getUserVisit(), unitOfMeasureKindUse));
072        }
073        
074        return result;
075    }
076    
077}