001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.period.server.command;
018
019import com.echothree.control.user.period.common.form.GetFiscalPeriodsForm;
020import com.echothree.control.user.period.common.result.PeriodResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.period.server.control.PeriodControl;
023import com.echothree.model.control.period.server.logic.FiscalPeriodLogic;
024import com.echothree.model.control.period.server.logic.PeriodLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.period.server.entity.Period;
028import com.echothree.model.data.period.server.factory.PeriodFactory;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetFiscalPeriodsCommand
043        extends BasePaginatedMultipleEntitiesCommand<Period, GetFiscalPeriodsForm> {
044
045    private static final CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private static final List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.FiscalPeriod.name(), SecurityRoles.List.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("ParentPeriodName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("PeriodTypeName", FieldType.ENTITY_NAME, false, null, null)
059        );
060    }
061
062    @Inject
063    PeriodControl periodControl;
064
065    @Inject
066    FiscalPeriodLogic fiscalPeriodLogic;
067
068    @Inject
069    PeriodLogic periodLogic;
070
071    public GetFiscalPeriodsCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
073    }
074
075    private PeriodControl.PeriodSelection periodSelection;
076
077    @Override
078    protected void handleForm() {
079        var periodKind = fiscalPeriodLogic.getFiscalPeriodKind(this);
080
081        if(!hasExecutionErrors()) {
082            periodSelection = periodLogic.getPeriodSelection(this, periodKind, form.getParentPeriodName(), form.getPeriodTypeName());
083        }
084    }
085
086    @Override
087    protected Long getTotalEntities() {
088        return hasExecutionErrors() ? null : periodControl.countPeriods(periodSelection);
089    }
090
091    @Override
092    protected Collection<Period> getEntities() {
093        return hasExecutionErrors() ? null : periodControl.getPeriods(periodSelection);
094    }
095
096    @Override
097    protected BaseResult getResult(Collection<Period> entities) {
098        var result = PeriodResultFactory.getGetFiscalPeriodsResult();
099
100        if(entities != null) {
101            if(session.hasLimit(PeriodFactory.class)) {
102                result.setFiscalPeriodCount(getTotalEntities());
103            }
104
105            result.setFiscalPeriods(periodControl.getFiscalPeriodTransfers(getUserVisit(), entities));
106        }
107
108        return result;
109    }
110
111}