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