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.GetWorkflowStepChoicesForm;
020import com.echothree.control.user.workflow.common.result.GetWorkflowStepChoicesResult;
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.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 com.echothree.util.server.persistence.Session;
037import java.util.Arrays;
038import java.util.Collections;
039import java.util.List;
040
041public class GetWorkflowStepChoicesCommand
042        extends BaseSimpleCommand<GetWorkflowStepChoicesForm> {
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(Collections.unmodifiableList(Arrays.asList(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
051                    new SecurityRoleDefinition(SecurityRoleGroups.WorkflowStep.name(), SecurityRoles.Choices.name())
052                    )))
053                )));
054
055        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
056                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("DefaultWorkflowStepChoice", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
059                ));
060    }
061    
062    /** Creates a new instance of GetWorkflowStepChoicesCommand */
063    public GetWorkflowStepChoicesCommand(UserVisitPK userVisitPK, GetWorkflowStepChoicesForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var workflowControl = Session.getModelController(WorkflowControl.class);
070        GetWorkflowStepChoicesResult result = WorkflowResultFactory.getGetWorkflowStepChoicesResult();
071        String workflowName = form.getWorkflowName();
072        var workflow = workflowControl.getWorkflowByName(workflowName);
073        
074        if(workflow != null) {
075            String defaultWorkflowStepChoice = form.getDefaultWorkflowStepChoice();
076            boolean allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
077            
078            result.setWorkflowStepChoices(workflowControl.getWorkflowStepChoices(defaultWorkflowStepChoice,
079                    getPreferredLanguage(), allowNullChoice, workflow));
080        } else {
081            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
082        }
083        
084        return result;
085    }
086    
087}