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