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.item.server.command;
018
019import com.echothree.control.user.item.common.form.CreateItemCategoryForm;
020import com.echothree.control.user.item.common.result.CreateItemCategoryResult;
021import com.echothree.control.user.item.common.result.ItemResultFactory;
022import com.echothree.model.control.item.server.control.ItemControl;
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.item.server.entity.ItemCategory;
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 CreateItemCategoryCommand
042        extends BaseSimpleCommand<CreateItemCategoryForm> {
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.ItemCategory.name(), SecurityRoles.Create.name())
052                        )))
053                )));
054        
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("ItemCategoryName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ParentItemCategoryName", 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 CreateItemCategoryCommand */
065    public CreateItemCategoryCommand(UserVisitPK userVisitPK, CreateItemCategoryForm form) {
066        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        CreateItemCategoryResult result = ItemResultFactory.getCreateItemCategoryResult();
072        var itemControl = Session.getModelController(ItemControl.class);
073        String itemCategoryName = form.getItemCategoryName();
074        ItemCategory itemCategory = itemControl.getItemCategoryByName(itemCategoryName);
075        
076        if(itemCategory == null) {
077            String parentItemCategoryName = form.getParentItemCategoryName();
078            ItemCategory parentItemCategory = null;
079            
080            if(parentItemCategoryName != null) {
081                parentItemCategory = itemControl.getItemCategoryByName(parentItemCategoryName);
082            }
083            
084            if(parentItemCategoryName == null || parentItemCategory != null) {
085                var partyPK = getPartyPK();
086                var isDefault = Boolean.valueOf(form.getIsDefault());
087                var sortOrder = Integer.valueOf(form.getSortOrder());
088                var description = form.getDescription();
089                
090                itemCategory = itemControl.createItemCategory(itemCategoryName, parentItemCategory, null,
091                        isDefault, sortOrder, partyPK);
092                
093                if(description != null) {
094                    itemControl.createItemCategoryDescription(itemCategory, getPreferredLanguage(),
095                            description, partyPK);
096                }
097            } else {
098                addExecutionError(ExecutionErrors.UnknownParentItemCategoryName.name(), parentItemCategoryName);
099            }
100        } else {
101            addExecutionError(ExecutionErrors.DuplicateItemCategoryName.name(), itemCategoryName);
102        }
103                
104        if(itemCategory != null) {
105            result.setItemCategoryName(itemCategory.getLastDetail().getItemCategoryName());
106            result.setEntityRef(itemCategory.getPrimaryKey().getEntityRef());
107        }
108
109        return result;
110    }
111    
112}