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