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.CreateFiscalYearForm;
020import com.echothree.control.user.period.common.result.PeriodResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.period.server.logic.FiscalPeriodLogic;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import java.util.List;
034import javax.enterprise.context.Dependent;
035import javax.inject.Inject;
036
037@Dependent
038public class CreateFiscalYearCommand
039        extends BaseSimpleCommand<CreateFiscalYearForm> {
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.FiscalPeriod.name(), SecurityRoles.Create.name())
049                ))
050        ));
051        
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("Year", FieldType.YEAR, true, null, null)
054        );
055    }
056
057    @Inject
058    FiscalPeriodLogic fiscalPeriodLogic;
059
060    
061    /** Creates a new instance of CreateFiscalYearCommand */
062    public CreateFiscalYearCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var result = PeriodResultFactory.getCreateFiscalYearResult();
069        var year = Integer.valueOf(form.getYear());
070        
071        var period = fiscalPeriodLogic.createFiscalYear(this, year, getPartyPK());
072
073        if(period != null) {
074            result.setPeriodName(period.getLastDetail().getPeriodName());
075            result.setEntityRef(period.getPrimaryKey().getEntityRef());
076        }
077
078        return result;
079    }
080    
081}