001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.model.control.party.common.PartyTypes;
021import com.echothree.model.control.period.server.logic.FiscalPeriodLogic;
022import com.echothree.model.data.user.common.pk.UserVisitPK;
023import com.echothree.util.common.validation.FieldDefinition;
024import com.echothree.util.common.validation.FieldType;
025import com.echothree.util.common.command.BaseResult;
026import com.echothree.util.server.control.BaseSimpleCommand;
027import com.echothree.util.server.control.CommandSecurityDefinition;
028import com.echothree.util.server.control.PartyTypeDefinition;
029import java.util.Arrays;
030import java.util.Collections;
031import java.util.List;
032
033public class CreateFiscalYearCommand
034        extends BaseSimpleCommand<CreateFiscalYearForm> {
035    
036    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038    
039    static {
040        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
041                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null)
042                )));
043        
044        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
045                new FieldDefinition("Year", FieldType.YEAR, true, null, null)
046                ));
047    }
048    
049    /** Creates a new instance of CreateFiscalYearCommand */
050    public CreateFiscalYearCommand(UserVisitPK userVisitPK, CreateFiscalYearForm form) {
051        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
052    }
053    
054    @Override
055    protected BaseResult execute() {
056        Integer year = Integer.valueOf(form.getYear());
057        
058        FiscalPeriodLogic.getInstance().createFiscalYear(this, year, getPartyPK());
059        
060        return null;
061    }
062    
063}