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.GetFiscalPeriodForm;
020import com.echothree.control.user.period.common.result.PeriodResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.period.server.control.PeriodControl;
024import com.echothree.model.control.period.server.logic.FiscalPeriodLogic;
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.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseSingleEntityCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.EntityPermission;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetFiscalPeriodCommand
042        extends BaseSingleEntityCommand<Period, GetFiscalPeriodForm> {
043
044    private static final CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private static final List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.FiscalPeriod.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("PeriodName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
058                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
059        );
060    }
061
062    @Inject
063    PeriodControl periodControl;
064
065    @Inject
066    FiscalPeriodLogic fiscalPeriodLogic;
067
068    public GetFiscalPeriodCommand() {
069        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
070    }
071
072    @Override
073    protected Period getEntity() {
074        var period = fiscalPeriodLogic.getFiscalPeriodByUniversalSpec(this, form, EntityPermission.READ_ONLY);
075
076        if(!hasExecutionErrors()) {
077            sendEvent(period.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
078        }
079
080        return period;
081    }
082
083    @Override
084    protected BaseResult getResult(Period period) {
085        var result = PeriodResultFactory.getGetFiscalPeriodResult();
086
087        if(period != null) {
088            result.setFiscalPeriod(periodControl.getFiscalPeriodTransfer(getUserVisit(), period));
089        }
090
091        return result;
092    }
093
094}