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.accounting.server.command;
018
019import com.echothree.control.user.accounting.common.form.DeleteGlAccountForm;
020import com.echothree.model.control.accounting.server.control.AccountingControl;
021import com.echothree.model.control.accounting.server.logic.GlAccountLogic;
022import com.echothree.model.control.accounting.server.logic.ItemAccountingCategoryLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.accounting.server.entity.GlAccount;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.message.ExecutionErrors;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.common.command.BaseResult;
032import com.echothree.util.server.control.BaseSimpleCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class DeleteGlAccountCommand
042        extends BaseSimpleCommand<DeleteGlAccountForm> {
043    
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.GlAccount.name(), SecurityRoles.Delete.name())
052                ))
053        ));
054        
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("GlAccountName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
058                new FieldDefinition("Key", FieldType.KEY, false, null, null),
059                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
060                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
061        );
062    }
063    
064    /** Creates a new instance of DeleteGlAccountCommand */
065    public DeleteGlAccountCommand(UserVisitPK userVisitPK, DeleteGlAccountForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var glAccount = GlAccountLogic.getInstance().getGlAccountByUniversalSpecForUpdate(this, form, false, null);
072
073        if(!hasExecutionErrors()) {
074            GlAccountLogic.getInstance().deleteGlAccount(this, glAccount, getPartyPK());
075        }
076
077        return null;
078    }
079    
080}