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.CreatePeriodKindForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.period.server.control.PeriodControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.workflow.server.control.WorkflowControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class CreatePeriodKindCommand
040        extends BaseSimpleCommand<CreatePeriodKindForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.PeriodKind.name(), SecurityRoles.Create.name())
050                ))
051        ));
052        
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("PeriodKindName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, false, null, null),
056                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
058                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
059                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
060        );
061    }
062
063    @Inject
064    PeriodControl periodControl;
065
066    @Inject
067    WorkflowControl workflowControl;
068
069    
070    /** Creates a new instance of CreatePeriodKindCommand */
071    public CreatePeriodKindCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
073    }
074    
075    @Override
076    protected BaseResult execute() {
077        var workflowName = form.getWorkflowName();
078        var workflowEntranceName = form.getWorkflowEntranceName();
079        var parameterCount = (workflowName == null ? 0 : 1) + (workflowEntranceName == null ? 0 : 1);
080
081        if(parameterCount == 0 || parameterCount == 2) {
082            var periodKindName = form.getPeriodKindName();
083            var periodKind = periodControl.getPeriodKindByName(periodKindName);
084
085            if(periodKind == null) {
086                var workflow = workflowName == null? null: workflowControl.getWorkflowByName(workflowName);
087
088                if(workflowName == null || workflow != null) {
089                    var workflowEntrance = workflowEntranceName == null? null: workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
090
091                    if(workflowEntranceName == null || workflowEntrance != null) {
092                        var partyPK = getPartyPK();
093                        var isDefault = Boolean.valueOf(form.getIsDefault());
094                        var sortOrder = Integer.valueOf(form.getSortOrder());
095                        var description = form.getDescription();
096
097                        periodKind = periodControl.createPeriodKind(periodKindName, workflowEntrance, isDefault, sortOrder, partyPK);
098
099                        if(description != null) {
100                            periodControl.createPeriodKindDescription(periodKind, getPreferredLanguage(), description, partyPK);
101                        }
102                    } else {
103                        addExecutionError(ExecutionErrors.UnknownWorkflowEntranceName.name(), workflowName, workflowEntranceName);
104                    }
105                } else {
106                    addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
107                }
108            } else {
109                addExecutionError(ExecutionErrors.DuplicatePeriodKindName.name(), periodKindName);
110            }
111        } else {
112            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
113        }
114
115        return null;
116    }
117    
118}