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.SetVendorItemStatusForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.control.vendor.server.control.VendorControl;
024import com.echothree.model.control.vendor.server.logic.VendorItemLogic;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.Arrays;
035import java.util.Collections;
036import java.util.List;
037
038public class SetVendorItemStatusCommand
039        extends BaseSimpleCommand<SetVendorItemStatusForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
048                    new SecurityRoleDefinition(SecurityRoleGroups.VendorItemStatus.name(), SecurityRoles.Choices.name())
049                    )))
050                )));
051        
052        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
053                new FieldDefinition("VendorName", FieldType.ENTITY_NAME, false, null, null),
054                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, false, null, null),
055                new FieldDefinition("VendorItemName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
057                new FieldDefinition("Key", FieldType.KEY, false, null, null),
058                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
059                new FieldDefinition("Ulid", FieldType.ULID, false, null, null),
060                new FieldDefinition("VendorItemStatusChoice", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of SetVendorItemStatusCommand */
065    public SetVendorItemStatusCommand(UserVisitPK userVisitPK, SetVendorItemStatusForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var vendorItem = VendorItemLogic.getInstance().getVendorItemByUniversalSpecForUpdate(this, form);
072
073        if(!hasExecutionErrors()) {
074            var vendorControl = Session.getModelController(VendorControl.class);
075            var vendorItemStatusChoice = form.getVendorItemStatusChoice();
076
077            vendorControl.setVendorItemStatus(this, vendorItem, vendorItemStatusChoice, getPartyPK());
078        }
079        
080        return null;
081    }
082    
083}