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.GetLotForm;
020import com.echothree.control.user.inventory.common.result.GetLotResult;
021import com.echothree.control.user.inventory.common.result.InventoryResultFactory;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.inventory.server.control.InventoryControl;
024import com.echothree.model.control.inventory.server.control.LotControl;
025import com.echothree.model.control.inventory.server.logic.LotLogic;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.inventory.server.entity.Lot;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BaseSingleEntityCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class GetLotCommand
044        extends BaseSingleEntityCommand<Lot, GetLotForm> {
045
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Lot.name(), SecurityRoles.Review.name())
054                )))
055        )));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("LotName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
060                new FieldDefinition("Key", FieldType.KEY, false, null, null),
061                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
062                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
063                ));
064    }
065    
066    /** Creates a new instance of GetLotCommand */
067    public GetLotCommand(UserVisitPK userVisitPK, GetLotForm form) {
068        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
069    }
070    
071    @Override
072    protected Lot getEntity() {
073        Lot lot = LotLogic.getInstance().getLotByUniversalSpec(this, form);
074
075        if(lot != null) {
076            sendEvent(lot.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
077        }
078
079        return lot;
080    }
081    
082    @Override
083    protected BaseResult getResult(Lot lot) {
084        var lotControl = Session.getModelController(LotControl.class);
085        var result = InventoryResultFactory.getGetLotResult();
086
087        if(lot != null) {
088            result.setLot(lotControl.getLotTransfer(getUserVisit(), lot));
089        }
090
091        return result;
092    }
093    
094}