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.GetItemCategoriesForm;
020import com.echothree.control.user.item.common.result.GetItemCategoriesResult;
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.model.data.user.server.entity.UserVisit;
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.common.command.BaseResult;
033import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Arrays;
039import java.util.Collection;
040import java.util.Collections;
041import java.util.List;
042
043public class GetItemCategoriesCommand
044        extends BaseMultipleEntitiesCommand<ItemCategory, GetItemCategoriesForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.ItemCategory.name(), SecurityRoles.List.name())
054                        )))
055                )));
056        
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("ParentItemCategoryName", FieldType.ENTITY_NAME, false, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetItemCategoriesCommand */
063    public GetItemCategoriesCommand(UserVisitPK userVisitPK, GetItemCategoriesForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    private ItemCategory parentItemCategory;
068    
069    @Override
070    protected Collection<ItemCategory> getEntities() {
071        var itemControl = Session.getModelController(ItemControl.class);
072        String parentItemCategoryName = form.getParentItemCategoryName();
073        Collection<ItemCategory> itemCategories = null;
074        
075        parentItemCategory = parentItemCategoryName == null? null: itemControl.getItemCategoryByName(parentItemCategoryName);
076
077        if(parentItemCategoryName == null || parentItemCategory != null) {
078            itemCategories = parentItemCategory == null ? itemControl.getItemCategories()
079                    : itemControl.getItemCategoriesByParentItemCategory(parentItemCategory);
080        } else {
081            addExecutionError(ExecutionErrors.UnknownParentItemCategoryName.name(), parentItemCategoryName);
082        }
083        
084        return itemCategories;
085    }
086    
087    @Override
088    protected BaseResult getResult(Collection<ItemCategory> entities) {
089        GetItemCategoriesResult result = ItemResultFactory.getGetItemCategoriesResult();
090        var itemControl = Session.getModelController(ItemControl.class);
091        UserVisit userVisit = getUserVisit();
092        
093        result.setParentItemCategory(parentItemCategory == null ? null : itemControl.getItemCategoryTransfer(userVisit, parentItemCategory));
094        result.setItemCategories(itemControl.getItemCategoryTransfers(userVisit, entities));
095        
096        return result;
097    }
098    
099}