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.vendor.server.command;
018
019import com.echothree.control.user.vendor.common.form.GetVendorItemCostsForm;
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.VendorLogic;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.model.data.vendor.server.entity.Vendor;
028import com.echothree.model.data.vendor.server.entity.VendorItem;
029import com.echothree.model.data.vendor.server.entity.VendorItemCost;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
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.Collection;
041import java.util.Collections;
042import java.util.List;
043
044public class GetVendorItemCostsCommand
045        extends BaseMultipleEntitiesCommand<VendorItemCost, GetVendorItemCostsForm> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
049    
050    static {
051        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
052                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
053                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
054                        new SecurityRoleDefinition(SecurityRoleGroups.VendorItemCost.name(), SecurityRoles.List.name())
055                        )))
056                )));
057        
058        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
059                new FieldDefinition("VendorName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("VendorItemName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetVendorItemCostsCommand */
065    public GetVendorItemCostsCommand(UserVisitPK userVisitPK, GetVendorItemCostsForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068
069    Vendor vendor;
070    VendorItem vendorItem;
071
072    @Override
073    protected Collection<VendorItemCost> getEntities() {
074        var vendorControl = Session.getModelController(VendorControl.class);
075        Collection<VendorItemCost> entities = null;
076
077        vendor = VendorLogic.getInstance().getVendorByName(this, form.getVendorName(), null, null);
078
079        if(!hasExecutionErrors()) {
080            var vendorParty = vendor.getParty();
081            var vendorItemName = form.getVendorItemName();
082
083            vendorItem = vendorControl.getVendorItemByVendorPartyAndVendorItemName(vendorParty, vendorItemName);
084
085            if(vendorItem != null) {
086                entities = vendorControl.getVendorItemCostsByVendorItem(vendorItem);
087            } else {
088                addExecutionError(ExecutionErrors.UnknownVendorItemName.name(), vendorItemName);
089            }
090        }
091
092        return entities;
093    }
094
095    @Override
096    protected BaseResult getResult(Collection<VendorItemCost> entities) {
097        var result = VendorResultFactory.getGetVendorItemCostsResult();
098
099        if(entities != null) {
100            var vendorControl = Session.getModelController(VendorControl.class);
101            var userVisit = getUserVisit();
102
103            result.setVendor(vendorControl.getVendorTransfer(userVisit, vendor));
104            result.setVendorItem(vendorControl.getVendorItemTransfer(userVisit, vendorItem));
105            result.setVendorItemCosts(vendorControl.getVendorItemCostTransfers(userVisit, entities));
106        }
107
108        return result;
109    }
110
111}