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.sales.server.command;
018
019import com.echothree.control.user.sales.common.form.DeleteSalesOrderBatchForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.sales.server.logic.SalesOrderBatchLogic;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.data.batch.server.entity.Batch;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
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 java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class DeleteSalesOrderBatchCommand
038        extends BaseSimpleCommand<DeleteSalesOrderBatchForm> {
039    
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
047                        new SecurityRoleDefinition(SecurityRoleGroups.SalesOrderBatch.name(), SecurityRoles.Delete.name())
048                        )))
049                )));
050
051        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
052                new FieldDefinition("BatchName", FieldType.ENTITY_NAME, true, null, null)
053                ));
054    }
055    
056    /** Creates a new instance of DeleteSalesOrderBatchCommand */
057    public DeleteSalesOrderBatchCommand(UserVisitPK userVisitPK, DeleteSalesOrderBatchForm form) {
058        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
059    }
060    
061    @Override
062    protected BaseResult execute() {
063        Batch batch = SalesOrderBatchLogic.getInstance().getBatchByNameForUpdate(this, form.getBatchName());
064
065        if(batch != null) {
066            SalesOrderBatchLogic.getInstance().deleteBatch(this, batch, getPartyPK());
067        }
068        
069        return null;
070    }
071    
072}