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.GetWorkflowDescriptionsForm;
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.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.Dependent;
037
038@Dependent
039public class GetWorkflowDescriptionsCommand
040        extends BaseSimpleCommand<GetWorkflowDescriptionsForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                    new SecurityRoleDefinition(SecurityRoleGroups.Workflow.name(), SecurityRoles.Description.name())
050                    ))
051                ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null)
055                );
056    }
057    
058    /** Creates a new instance of GetWorkflowDescriptionsCommand */
059    public GetWorkflowDescriptionsCommand() {
060        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
061    }
062    
063    @Override
064    protected BaseResult execute() {
065        var workflowControl = Session.getModelController(WorkflowControl.class);
066        var result = WorkflowResultFactory.getGetWorkflowDescriptionsResult();
067        var workflowName = form.getWorkflowName();
068        var workflow = workflowControl.getWorkflowByName(workflowName);
069        
070        if(workflow != null) {
071            result.setWorkflow(workflowControl.getWorkflowTransfer(getUserVisit(), workflow));
072            result.setWorkflowDescriptions(workflowControl.getWorkflowDescriptionTransfersByWorkflow(getUserVisit(), workflow));
073        } else {
074            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
075        }
076        
077        return result;
078    }
079    
080}