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.GetWorkflowChoicesForm;
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.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.List;
035
036public class GetWorkflowChoicesCommand
037        extends BaseSimpleCommand<GetWorkflowChoicesForm> {
038
039    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
044                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
045                        new SecurityRoleDefinition(SecurityRoleGroups.Workflow.name(), SecurityRoles.Choices.name())
046                ))
047        ));
048
049        FORM_FIELD_DEFINITIONS = List.of(
050                new FieldDefinition("DefaultWorkflowChoice", FieldType.ENTITY_NAME, false, null, null),
051                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
052        );
053    }
054    
055    /** Creates a new instance of GetWorkflowChoicesCommand */
056    public GetWorkflowChoicesCommand(UserVisitPK userVisitPK, GetWorkflowChoicesForm form) {
057        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
058    }
059    
060    @Override
061    protected BaseResult execute() {
062        var workflowControl = Session.getModelController(WorkflowControl.class);
063        var result = WorkflowResultFactory.getGetWorkflowChoicesResult();
064        var defaultWorkflowChoice = form.getDefaultWorkflowChoice();
065        var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
066        
067        result.setWorkflowChoices(workflowControl.getWorkflowChoices(defaultWorkflowChoice, getPreferredLanguage(), allowNullChoice));
068        
069        return result;
070    }
071    
072}