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.GetPeriodDescriptionsForm;
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.PeriodKindLogic;
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.entity.PeriodDescription;
029import com.echothree.model.data.period.server.factory.PeriodDescriptionFactory;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class GetPeriodDescriptionsCommand
044        extends BasePaginatedMultipleEntitiesCommand<PeriodDescription, GetPeriodDescriptionsForm> {
045
046    private static final CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private static final List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Period.name(), SecurityRoles.Description.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("PeriodKindName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("PeriodName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    @Inject
064    PeriodControl periodControl;
065
066    @Inject
067    PeriodKindLogic periodKindLogic;
068
069    @Inject
070    PeriodLogic periodLogic;
071
072    public GetPeriodDescriptionsCommand() {
073        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
074    }
075
076    private Period period;
077
078    @Override
079    protected void handleForm() {
080        var periodKind = periodKindLogic.getPeriodKindByName(this, form.getPeriodKindName());
081
082        if(!hasExecutionErrors()) {
083            period = periodLogic.getPeriodByName(this, periodKind, form.getPeriodName());
084        }
085    }
086
087    @Override
088    protected Long getTotalEntities() {
089        return hasExecutionErrors() ? null : periodControl.countPeriodDescriptionsByPeriod(period);
090    }
091
092    @Override
093    protected Collection<PeriodDescription> getEntities() {
094        return hasExecutionErrors() ? null : periodControl.getPeriodDescriptionsByPeriod(period);
095    }
096
097    @Override
098    protected BaseResult getResult(Collection<PeriodDescription> periodDescriptions) {
099        var result = PeriodResultFactory.getGetPeriodDescriptionsResult();
100
101        if(periodDescriptions != null) {
102            var userVisit = getUserVisit();
103
104            result.setPeriod(periodControl.getPeriodTransfer(userVisit, period));
105
106            if(session.hasLimit(PeriodDescriptionFactory.class)) {
107                result.setPeriodDescriptionCount(getTotalEntities());
108            }
109
110            result.setPeriodDescriptions(periodControl.getPeriodDescriptionTransfers(userVisit, periodDescriptions));
111        }
112
113        return result;
114    }
115
116}