001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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;
035import javax.enterprise.context.RequestScoped;
036
037@RequestScoped
038public class GetWorkflowChoicesCommand
039        extends BaseSimpleCommand<GetWorkflowChoicesForm> {
040
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
047                        new SecurityRoleDefinition(SecurityRoleGroups.Workflow.name(), SecurityRoles.Choices.name())
048                ))
049        ));
050
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("DefaultWorkflowChoice", FieldType.ENTITY_NAME, false, null, null),
053                new FieldDefinition("AllowNullChoice", FieldType.BOOLEAN, true, null, null)
054        );
055    }
056    
057    /** Creates a new instance of GetWorkflowChoicesCommand */
058    public GetWorkflowChoicesCommand() {
059        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
060    }
061    
062    @Override
063    protected BaseResult execute() {
064        var workflowControl = Session.getModelController(WorkflowControl.class);
065        var result = WorkflowResultFactory.getGetWorkflowChoicesResult();
066        var defaultWorkflowChoice = form.getDefaultWorkflowChoice();
067        var allowNullChoice = Boolean.parseBoolean(form.getAllowNullChoice());
068        
069        result.setWorkflowChoices(workflowControl.getWorkflowChoices(defaultWorkflowChoice, getPreferredLanguage(), allowNullChoice));
070        
071        return result;
072    }
073    
074}