001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.RequestScoped;
035
036@RequestScoped
037public class CreateFiscalYearCommand
038        extends BaseSimpleCommand<CreateFiscalYearForm> {
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.FiscalPeriod.name(), SecurityRoles.Create.name())
048                ))
049        ));
050        
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("Year", FieldType.YEAR, true, null, null)
053        );
054    }
055    
056    /** Creates a new instance of CreateFiscalYearCommand */
057    public CreateFiscalYearCommand() {
058        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
059    }
060    
061    @Override
062    protected BaseResult execute() {
063        var result = PeriodResultFactory.getCreateFiscalYearResult();
064        var year = Integer.valueOf(form.getYear());
065        
066        var period = FiscalPeriodLogic.getInstance().createFiscalYear(this, year, getPartyPK());
067
068        if(period != null) {
069            result.setPeriodName(period.getLastDetail().getPeriodName());
070            result.setEntityRef(period.getPrimaryKey().getEntityRef());
071        }
072
073        return result;
074    }
075    
076}