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.GetWorkflowEntranceDescriptionsForm;
020import com.echothree.control.user.workflow.common.result.GetWorkflowEntranceDescriptionsResult;
021import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
022import com.echothree.model.control.party.common.PartyTypes;
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.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 GetWorkflowEntranceDescriptionsCommand
043        extends BaseSimpleCommand<GetWorkflowEntranceDescriptionsForm> {
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.Description.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                ));
060    }
061    
062    /** Creates a new instance of GetWorkflowEntranceDescriptionsCommand */
063    public GetWorkflowEntranceDescriptionsCommand(UserVisitPK userVisitPK, GetWorkflowEntranceDescriptionsForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var workflowControl = Session.getModelController(WorkflowControl.class);
070        GetWorkflowEntranceDescriptionsResult result = WorkflowResultFactory.getGetWorkflowEntranceDescriptionsResult();
071        String workflowName = form.getWorkflowName();
072        var workflow = workflowControl.getWorkflowByName(workflowName);
073        
074        if(workflow != null) {
075            String workflowEntranceName = form.getWorkflowEntranceName();
076            WorkflowEntrance workflowEntrance = workflowControl.getWorkflowEntranceByName(workflow, workflowEntranceName);
077            
078            result.setWorkflow(workflowControl.getWorkflowTransfer(getUserVisit(), workflow));
079            
080            if(workflowEntrance != null) {
081                result.setWorkflowEntrance(workflowControl.getWorkflowEntranceTransfer(getUserVisit(), workflowEntrance));
082                result.setWorkflowEntranceDescriptions(workflowControl.getWorkflowEntranceDescriptionTransfersByWorkflowEntrance(getUserVisit(), workflowEntrance));
083            } else {
084                addExecutionError(ExecutionErrors.UnknownWorkflowEntranceName.name(), workflowEntranceName);
085            }
086        } else {
087            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
088        }
089        
090        return result;
091    }
092    
093}