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.GetItemAccountingCategoriesForm;
020import com.echothree.control.user.accounting.common.result.AccountingResultFactory;
021import com.echothree.model.control.accounting.server.control.AccountingControl;
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.accounting.server.entity.ItemAccountingCategory;
026import com.echothree.model.data.accounting.server.factory.ItemAccountingCategoryFactory;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Collection;
036import java.util.List;
037
038public class GetItemAccountingCategoriesCommand
039        extends BasePaginatedMultipleEntitiesCommand<ItemAccountingCategory, GetItemAccountingCategoriesForm>  {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.ItemAccountingCategory.name(), SecurityRoles.List.name())
049                ))
050        ));
051        
052        FORM_FIELD_DEFINITIONS = List.of();
053    }
054    
055    /** Creates a new instance of GetItemAccountingCategoriesCommand */
056    public GetItemAccountingCategoriesCommand(UserVisitPK userVisitPK, GetItemAccountingCategoriesForm form) {
057        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
058    }
059
060    @Override
061    protected void handleForm() {
062        // No form fields.
063    }
064
065    @Override
066    protected Long getTotalEntities() {
067        var accountingControl = Session.getModelController(AccountingControl.class);
068
069        return accountingControl.countItemAccountingCategories();
070    }
071
072    @Override
073    protected Collection<ItemAccountingCategory> getEntities() {
074        var accountingControl = Session.getModelController(AccountingControl.class);
075
076        return accountingControl.getItemAccountingCategories();
077    }
078
079    @Override
080    protected BaseResult getResult(Collection<ItemAccountingCategory> entities) {
081        var result = AccountingResultFactory.getGetItemAccountingCategoriesResult();
082
083        if(entities != null) {
084            var accountingControl = Session.getModelController(AccountingControl.class);
085
086            if(session.hasLimit(ItemAccountingCategoryFactory.class)) {
087                result.setItemAccountingCategoryCount(getTotalEntities());
088            }
089
090            result.setItemAccountingCategories(accountingControl.getItemAccountingCategoryTransfers(getUserVisit(), entities));
091        }
092
093        return result;
094    }
095    
096}