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.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.WorkflowEntrance;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class CreateWorkflowEntranceCommand
041        extends BaseSimpleCommand<CreateWorkflowEntranceForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                    new SecurityRoleDefinition(SecurityRoleGroups.WorkflowEntrance.name(), SecurityRoles.Create.name())
051                    ))
052                ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, true, 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 CreateWorkflowEntranceCommand */
064    public CreateWorkflowEntranceCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var result = WorkflowResultFactory.getCreateWorkflowEntranceResult();
071        var workflowControl = Session.getModelController(WorkflowControl.class);
072        var workflowName = form.getWorkflowName();
073        var workflow = workflowControl.getWorkflowByName(workflowName);
074        WorkflowEntrance workflowEntrance = null;
075        
076        if(workflow != null) {
077            var workflowEntranceName = form.getWorkflowEntranceName();
078
079            workflowEntrance = workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
080            
081            if(workflowEntrance == null) {
082                var partyPK = getPartyPK();
083                var isDefault = Boolean.valueOf(form.getIsDefault());
084                var sortOrder = Integer.valueOf(form.getSortOrder());
085                var description = form.getDescription();
086                
087                workflowEntrance = workflowControl.createWorkflowEntrance(workflow, workflowEntranceName, isDefault, sortOrder, partyPK);
088                
089                if(description != null) {
090                    workflowControl.createWorkflowEntranceDescription(workflowEntrance, getPreferredLanguage(), description, partyPK);
091                }
092            } else {
093                addExecutionError(ExecutionErrors.DuplicateWorkflowEntrance.name());
094            }
095        } else {
096            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
097        }
098
099        if(workflowEntrance != null) {
100            var basePK = workflowEntrance.getPrimaryKey();
101            var workflowEntranceDetail = workflowEntrance.getLastDetail();
102
103            result.setWorkflowName(workflowEntranceDetail.getWorkflow().getLastDetail().getWorkflowName());
104            result.setWorkflowEntranceName(workflowEntranceDetail.getWorkflowEntranceName());
105            result.setEntityRef(basePK.getEntityRef());
106        }
107
108        return result;
109    }
110    
111}