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.workflow.server.command;
018
019import com.echothree.control.user.workflow.common.form.CreateWorkflowEntranceForm;
020import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
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.model.data.workflow.server.entity.Workflow;
027import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
028import com.echothree.model.data.workflow.server.entity.WorkflowStep;
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 CreateWorkflowEntranceCommand
043        extends BaseSimpleCommand<CreateWorkflowEntranceForm> {
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.WorkflowEntrance.name(), SecurityRoles.Create.name())
053                    )))
054                )));
055
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, true, 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    /** Creates a new instance of CreateWorkflowEntranceCommand */
066    public CreateWorkflowEntranceCommand(UserVisitPK userVisitPK, CreateWorkflowEntranceForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var result = WorkflowResultFactory.getCreateWorkflowEntranceResult();
073        var workflowControl = Session.getModelController(WorkflowControl.class);
074        String workflowName = form.getWorkflowName();
075        var workflow = workflowControl.getWorkflowByName(workflowName);
076        WorkflowEntrance workflowEntrance = null;
077        
078        if(workflow != null) {
079            String workflowEntranceName = form.getWorkflowEntranceName();
080
081            workflowEntrance = workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
082            
083            if(workflowEntrance == null) {
084                var partyPK = getPartyPK();
085                var isDefault = Boolean.valueOf(form.getIsDefault());
086                var sortOrder = Integer.valueOf(form.getSortOrder());
087                var description = form.getDescription();
088                
089                workflowEntrance = workflowControl.createWorkflowEntrance(workflow, workflowEntranceName, isDefault, sortOrder, partyPK);
090                
091                if(description != null) {
092                    workflowControl.createWorkflowEntranceDescription(workflowEntrance, getPreferredLanguage(), description, partyPK);
093                }
094            } else {
095                addExecutionError(ExecutionErrors.DuplicateWorkflowEntrance.name());
096            }
097        } else {
098            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
099        }
100
101        if(workflowEntrance != null) {
102            var basePK = workflowEntrance.getPrimaryKey();
103            var workflowEntranceDetail = workflowEntrance.getLastDetail();
104
105            result.setWorkflowName(workflowEntranceDetail.getWorkflow().getLastDetail().getWorkflowName());
106            result.setWorkflowEntranceName(workflowEntranceDetail.getWorkflowEntranceName());
107            result.setEntityRef(basePK.getEntityRef());
108        }
109
110        return result;
111    }
112    
113}