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.inventory.server.command;
018
019import com.echothree.control.user.inventory.common.form.GetInventoryDispositionAdjustmentForm;
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.InventoryDispositionAdjustmentControl;
023import com.echothree.model.control.inventory.server.logic.InventoryDispositionAdjustmentLogic;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.inventory.server.entity.InventoryDispositionAdjustment;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetInventoryDispositionAdjustmentCommand
042        extends BaseSingleEntityCommand<InventoryDispositionAdjustment, GetInventoryDispositionAdjustmentForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.InventoryDispositionAdjustment.name(), SecurityRoles.Review.name())
052                ))
053        ));
054        
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("InventoryTransactionTypeName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("InventoryDispositionName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("InventoryDispositionAdjustmentName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
060                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
061        );
062    }
063
064    @Inject
065    InventoryDispositionAdjustmentControl inventoryDispositionAdjustmentControl;
066
067    @Inject
068    InventoryDispositionAdjustmentLogic inventoryDispositionAdjustmentLogic;
069
070    /** Creates a new instance of GetInventoryDispositionAdjustmentCommand */
071    public GetInventoryDispositionAdjustmentCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
073    }
074
075    @Override
076    protected InventoryDispositionAdjustment getEntity() {
077        var inventoryDispositionAdjustment = inventoryDispositionAdjustmentLogic.getInventoryDispositionAdjustmentByUniversalSpec(this, form, true);
078
079        if(inventoryDispositionAdjustment != null) {
080            sendEvent(inventoryDispositionAdjustment.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
081        }
082
083        return inventoryDispositionAdjustment;
084    }
085
086    @Override
087    protected BaseResult getResult(InventoryDispositionAdjustment inventoryDispositionAdjustment) {
088        var result = InventoryResultFactory.getGetInventoryDispositionAdjustmentResult();
089
090        if(inventoryDispositionAdjustment != null) {
091            result.setInventoryDispositionAdjustment(inventoryDispositionAdjustmentControl.getInventoryDispositionAdjustmentTransfer(getUserVisit(),
092                    inventoryDispositionAdjustment));
093        }
094
095        return result;
096    }
097    
098}