com.canto.cumulus.prefs

Class CatalogWorkflowList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.CatalogWorkflowList

public class CatalogWorkflowList
extends ListPackManager

This class manages a list of workflows stored in a catalog.

Since:

9.2

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

TYPE_EJP, TYPE_NATIVE

Method Summary

Methods

Modifier and Type	Method and Description
Workflow	add(Workflow workflow) Adds the given workflow.
void	delete(Workflow workflow) Deletes the given workflow and the related catalog fields.
Workflow	getWorkflow(GUID id) Returns the workflow for the given workflow id.
Workflow	getWorkflow(java.lang.String name) Returns the workflow for the given name.
java.util.Set<GUID>	getWorkflowIDs() Return a mapping of all contained workflows, with their internal ID pointing to their name.
java.util.List<java.lang.String>	getWorkflowNames() Return a list of workflow names of this instance.
java.util.List<Workflow>	getWorkflows() Returns all workflows contained in this list.
void	update(Workflow updateWorkflow) Updates a stored workflow with the new version provided by the caller.

Methods inherited from class com.canto.cumulus.prefs.BaseManager

addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

add

public Workflow add(Workflow workflow)
             throws CumulusException

Adds the given workflow. This makes the given workflow available for records in this catalog by adding all the required fields to the layout.

Parameters:

workflow - the workflow to add

Throws:

CumulusException - in case of an error

update

public void update(Workflow updateWorkflow)

Updates a stored workflow with the new version provided by the caller. If the given version is older than the stored one, the call is ignored.

Parameters:

updateWorkflow - workflow to update

Throws:

java.lang.IllegalArgumentException - if the given workflow has not yet been added to the catalog

delete

public void delete(Workflow workflow)
            throws CumulusException

Deletes the given workflow and the related catalog fields.

Parameters:

workflow - the workflow to delete

Throws:

CumulusException - in case of an error

getWorkflowNames

public java.util.List<java.lang.String> getWorkflowNames()

Return a list of workflow names of this instance.

Returns:

a list of String

getWorkflowIDs

public java.util.Set<GUID> getWorkflowIDs()

Return a mapping of all contained workflows, with their internal ID pointing to their name.

Returns:

mapping of all contained workflows

getWorkflow

public Workflow getWorkflow(java.lang.String name)

Returns the workflow for the given name.

Parameters:

name - the name of the workflow to return

Returns:

the workflow or null if not found

getWorkflow

public Workflow getWorkflow(GUID id)

Returns the workflow for the given workflow id.

Parameters:

id - the workflow id of the workflow to return

Returns:

the workflow or null if not found

getWorkflows

public java.util.List<Workflow> getWorkflows()

Returns all workflows contained in this list.

Returns:

all workflows of this list