Package ca.corefacility.bioinformatics.irida.ria.web.services

Class UIPipelineService

java.lang.Object

ca.corefacility.bioinformatics.irida.ria.web.services.UIPipelineService

@Component
public class UIPipelineService
extends java.lang.Object

UI Service for all things related to workflow pipelines.

Constructor Summary

Constructors

Constructor

Description

UIPipelineService(UICartService cartService, IridaWorkflowsService workflowsService, WorkflowNamedParametersService namedParametersService, ProjectService projectService, ReferenceFileService referenceFileService, AnalysisSubmissionSampleProcessor analysisSubmissionSampleProcessor, UpdateSamplePermission updateSamplePermission, GalaxyToolDataService galaxyToolDataService, AnalysisSubmissionService analysisSubmissionService, org.springframework.context.MessageSource messageSource)

Method Summary

Modifier and Type	Method	Description
UIPipelineDetailsResponse	getPipelineDetails(java.util.UUID id, java.util.Locale locale)	Get the information about a specific workflow pipeline
java.util.List<AnalysisTemplate>	getProjectAnalysisTemplates(java.lang.Long projectId, java.util.Locale locale)	List of existing automated workflows on a project
java.util.List<Pipeline>	getWorkflowTypes(java.lang.Boolean automated, java.util.Locale locale)	Get a list of pipeline workflows, if the automated flag is set then only those pipelines that can be run automated will be returned
java.lang.String	removeProjectAutomatedPipeline(java.lang.Long templateId, java.lang.Long projectId, java.util.Locale locale)	Remove an automated workflow from a project
SavedPipelineParameters	saveNewPipelineParameters(java.util.UUID id, SavePipelineParametersRequest request, java.util.Locale locale)	Save a new set of IridaWorkflowNamedParameters

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UIPipelineService

@Autowired
public UIPipelineService(UICartService cartService,
                         IridaWorkflowsService workflowsService,
                         WorkflowNamedParametersService namedParametersService,
                         ProjectService projectService,
                         ReferenceFileService referenceFileService,
                         AnalysisSubmissionSampleProcessor analysisSubmissionSampleProcessor,
                         UpdateSamplePermission updateSamplePermission,
                         GalaxyToolDataService galaxyToolDataService,
                         AnalysisSubmissionService analysisSubmissionService,
                         org.springframework.context.MessageSource messageSource)

Method Detail

getPipelineDetails

public UIPipelineDetailsResponse getPipelineDetails(java.util.UUID id,
                                                    java.util.Locale locale)
                                             throws IridaWorkflowNotFoundException

Get the information about a specific workflow pipeline

Parameters:

id - for a IridaWorkflow

locale - current users Locale

Returns:

Details contained within a UIPipelineDetailsResponse

Throws:

IridaWorkflowNotFoundException - exception thrown if the workflow cannot be found.

saveNewPipelineParameters

public SavedPipelineParameters saveNewPipelineParameters(java.util.UUID id,
                                                         SavePipelineParametersRequest request,
                                                         java.util.Locale locale)
                                                  throws IridaWorkflowNotFoundException

Save a new set of IridaWorkflowNamedParameters

Parameters:

id - UUID identifier for w IridaWorkflow

request - details about the new set of saved pipeline parameters

locale - current users Locale

Returns:

the identifier for the new set

Throws:

IridaWorkflowNotFoundException - exception thrown if the workflow cannot be found.

getWorkflowTypes

public java.util.List<Pipeline> getWorkflowTypes(java.lang.Boolean automated,
                                                 java.util.Locale locale)

Get a list of pipeline workflows, if the automated flag is set then only those pipelines that can be run automated will be returned

Parameters:

automated - if true, then this is from a project for creating automated pipelines

locale - currently logged in users locale

Returns:

list of pipelines

getProjectAnalysisTemplates

public java.util.List<AnalysisTemplate> getProjectAnalysisTemplates(java.lang.Long projectId,
                                                                    java.util.Locale locale)

List of existing automated workflows on a project

Parameters:

projectId - identifier for a project

locale - currently logged in users local

Returns:

list of existing automated workflows (AnalysisTemplate) for a project.

removeProjectAutomatedPipeline

public java.lang.String removeProjectAutomatedPipeline(java.lang.Long templateId,
                                                       java.lang.Long projectId,
                                                       java.util.Locale locale)

Remove an automated workflow from a project

Parameters:

templateId - identifier for the automated workflow (AnalysisTemplate)

projectId - identifier for the project

locale - currently logged in users locale

Returns:

message to the user about the status of the removal