001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.ItemResultFactory;
021import com.echothree.model.control.item.server.control.ItemControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.item.server.entity.ItemCategory;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class CreateItemCategoryCommand
043        extends BaseSimpleCommand<CreateItemCategoryForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.ItemCategory.name(), SecurityRoles.Create.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("ItemCategoryName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ParentItemCategoryName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
060                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
061                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
062                ));
063    }
064    
065    /** Creates a new instance of CreateItemCategoryCommand */
066    public CreateItemCategoryCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var result = ItemResultFactory.getCreateItemCategoryResult();
073        var itemControl = Session.getModelController(ItemControl.class);
074        var itemCategoryName = form.getItemCategoryName();
075        var itemCategory = itemControl.getItemCategoryByName(itemCategoryName);
076        
077        if(itemCategory == null) {
078            var parentItemCategoryName = form.getParentItemCategoryName();
079            ItemCategory parentItemCategory = null;
080            
081            if(parentItemCategoryName != null) {
082                parentItemCategory = itemControl.getItemCategoryByName(parentItemCategoryName);
083            }
084            
085            if(parentItemCategoryName == null || parentItemCategory != null) {
086                var partyPK = getPartyPK();
087                var isDefault = Boolean.valueOf(form.getIsDefault());
088                var sortOrder = Integer.valueOf(form.getSortOrder());
089                var description = form.getDescription();
090                
091                itemCategory = itemControl.createItemCategory(itemCategoryName, parentItemCategory, null,
092                        isDefault, sortOrder, partyPK);
093                
094                if(description != null) {
095                    itemControl.createItemCategoryDescription(itemCategory, getPreferredLanguage(),
096                            description, partyPK);
097                }
098            } else {
099                addExecutionError(ExecutionErrors.UnknownParentItemCategoryName.name(), parentItemCategoryName);
100            }
101        } else {
102            addExecutionError(ExecutionErrors.DuplicateItemCategoryName.name(), itemCategoryName);
103        }
104                
105        if(itemCategory != null) {
106            result.setItemCategoryName(itemCategory.getLastDetail().getItemCategoryName());
107            result.setEntityRef(itemCategory.getPrimaryKey().getEntityRef());
108        }
109
110        return result;
111    }
112    
113}