001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.vendor.server.command;
018
019import com.echothree.control.user.vendor.common.form.GetVendorItemForm;
020import com.echothree.control.user.vendor.common.result.VendorResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.vendor.server.control.VendorControl;
025import com.echothree.model.control.vendor.server.logic.VendorItemLogic;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.vendor.server.entity.VendorItem;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class GetVendorItemCommand
041        extends BaseSingleEntityCommand<VendorItem, GetVendorItemForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.VendorItem.name(), SecurityRoles.Review.name())
051                ))
052        ));
053        
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("VendorName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("VendorItemName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
059                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
060        );
061    }
062
063    /** Creates a new instance of GetVendorItemCommand */
064    public GetVendorItemCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067
068    @Override
069    protected VendorItem getEntity() {
070        return VendorItemLogic.getInstance().getVendorItemByUniversalSpec(this, form);
071    }
072
073    @Override
074    protected BaseResult getResult(VendorItem entity) {
075        var result = VendorResultFactory.getGetVendorItemResult();
076
077        if(entity != null) {
078            var vendorControl = Session.getModelController(VendorControl.class);
079
080            result.setVendorItem(vendorControl.getVendorItemTransfer(getUserVisit(), entity));
081        }
082
083        return result;
084    }
085
086}