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 com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.Dependent;
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    /** Creates a new instance of CreatePeriodKindCommand */
064    public CreatePeriodKindCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var periodControl = Session.getModelController(PeriodControl.class);
071        var workflowName = form.getWorkflowName();
072        var workflowEntranceName = form.getWorkflowEntranceName();
073        var parameterCount = (workflowName == null ? 0 : 1) + (workflowEntranceName == null ? 0 : 1);
074
075        if(parameterCount == 0 || parameterCount == 2) {
076            var periodKindName = form.getPeriodKindName();
077            var periodKind = periodControl.getPeriodKindByName(periodKindName);
078
079            if(periodKind == null) {
080                var workflowControl = Session.getModelController(WorkflowControl.class);
081                var workflow = workflowName == null? null: workflowControl.getWorkflowByName(workflowName);
082
083                if(workflowName == null || workflow != null) {
084                    var workflowEntrance = workflowEntranceName == null? null: workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
085
086                    if(workflowEntranceName == null || workflowEntrance != null) {
087                        var partyPK = getPartyPK();
088                        var isDefault = Boolean.valueOf(form.getIsDefault());
089                        var sortOrder = Integer.valueOf(form.getSortOrder());
090                        var description = form.getDescription();
091
092                        periodKind = periodControl.createPeriodKind(periodKindName, workflowEntrance, isDefault, sortOrder, partyPK);
093
094                        if(description != null) {
095                            periodControl.createPeriodKindDescription(periodKind, getPreferredLanguage(), description, partyPK);
096                        }
097                    } else {
098                        addExecutionError(ExecutionErrors.UnknownWorkflowEntranceName.name(), workflowName, workflowEntranceName);
099                    }
100                } else {
101                    addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
102                }
103            } else {
104                addExecutionError(ExecutionErrors.DuplicatePeriodKindName.name(), periodKindName);
105            }
106        } else {
107            addExecutionError(ExecutionErrors.InvalidParameterCount.name());
108        }
109
110        return null;
111    }
112    
113}