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.CreateItemAccountingCategoryForm;
020import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
021import com.echothree.model.control.accounting.server.control.AccountingControl;
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.ItemAccountingCategory;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
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 CreateItemAccountingCategoryCommand
042        extends BaseSimpleCommand<CreateItemAccountingCategoryForm> {
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(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                        new SecurityRoleDefinition(SecurityRoleGroups.ItemAccountingCategory.name(), SecurityRoles.Create.name())
052                        )))
053                )));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("ItemAccountingCategoryName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ParentItemAccountingCategoryName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
059                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
060                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
061        ));
062    }
063    
064    /** Creates a new instance of CreateItemAccountingCategoryCommand */
065    public CreateItemAccountingCategoryCommand(UserVisitPK userVisitPK, CreateItemAccountingCategoryForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var result = AccountingResultFactory.getCreateItemAccountingCategoryResult();
072        ItemAccountingCategory itemAccountingCategory = null;
073        var accountingControl = Session.getModelController(AccountingControl.class);
074        var parentItemAccountingCategoryName = form.getParentItemAccountingCategoryName();
075        ItemAccountingCategory parentItemAccountingCategory = null;
076
077        if(parentItemAccountingCategoryName != null) {
078            parentItemAccountingCategory = accountingControl.getItemAccountingCategoryByName(parentItemAccountingCategoryName);
079        }
080
081        if(parentItemAccountingCategoryName == null || parentItemAccountingCategory != null) {
082            var itemAccountingCategoryName = form.getItemAccountingCategoryName();
083            var isDefault = Boolean.valueOf(form.getIsDefault());
084            var sortOrder = Integer.valueOf(form.getSortOrder());
085            var description = form.getDescription();
086            var partyPK = getPartyPK();
087
088            itemAccountingCategory = ItemAccountingCategoryLogic.getInstance().createItemAccountingCategory(this,
089                    itemAccountingCategoryName, parentItemAccountingCategory, null, null, null,
090                    null, null, isDefault, sortOrder, getPreferredLanguage(), description, partyPK);
091        } else {
092            addExecutionError(ExecutionErrors.UnknownParentItemAccountingCategoryName.name(), parentItemAccountingCategoryName);
093        }
094
095        if(itemAccountingCategory != null) {
096            result.setItemAccountingCategoryName(itemAccountingCategory.getLastDetail().getItemAccountingCategoryName());
097            result.setEntityRef(itemAccountingCategory.getPrimaryKey().getEntityRef());
098        }
099        
100        return result;
101    }
102    
103}