com.canto.cumulus.prefs

Class WorkflowList

java.lang.Object

com.canto.cumulus.prefs.BaseManager

com.canto.cumulus.prefs.ListPackManager

com.canto.cumulus.prefs.WorkflowList

All Implemented Interfaces:

ItemManager

public class WorkflowList
extends ListPackManager
implements ItemManager

This class manages a list of workflows.

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
Item	copy(java.lang.String newID, Item src, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given workflow with the specified UID.
Workflow	copy(java.lang.String newName, Workflow copySource) Duplicates the given workflow and stores the result under the specified name.
Workflow	copy(java.lang.String newName, Workflow copySource, boolean copyDisplayNames, boolean copyDescriptions) Duplicates the given workflow and stores the result under the specified name.
void	delete(Item item) Deletes the given item.
void	delete(Workflow workflow) Deletes the given workflow.
Item	getItem(java.lang.String id) Returns the item with the specified UID.
java.util.Collection<java.lang.String>	getItemIDs() Returns the list of item UIDs that are available by this manager instance.
int	getItemType() Returns the item type for the items of this manager.
java.lang.String	getPath() Returns the path for this item manager instance.
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.
Workflow	importSet(JPack data, SetImportDuplicatesMode duplicatesMode) Imports the given exported workflow data into a new workflow.
void	rename(java.lang.String newID, Item item, boolean keepDisplayNames, boolean keepDescriptions) Renames the given item to the new UID.
void	rename(java.lang.String newName, Workflow workflow) Renames the given workflow to the new specified name.
void	rename(java.lang.String newName, Workflow workflow, boolean keepDisplayNames, boolean keepDescriptions) Renames the given workflow to the new specified name.
void	setAsDefault(Item item) Sets the given item to be the default item.
void	setAsDefault(Workflow newDefault) Sets the given workflow as the default workflow.

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

copy

public Workflow copy(java.lang.String newName,
            Workflow copySource)
              throws CumulusException,
                     javax.naming.InvalidNameException

Duplicates the given workflow and stores the result under the specified name. The copied workflow gets a new workflow ID assigned.

Parameters:

newName - the name of the new set

copySource - the source set to copy

Returns:

the copied set

Throws:

CumulusException - in case of an error

javax.naming.InvalidNameException - in case of an invalid or already used name

copy

public Workflow copy(java.lang.String newName,
            Workflow copySource,
            boolean copyDisplayNames,
            boolean copyDescriptions)
              throws CumulusException,
                     javax.naming.InvalidNameException

Duplicates the given workflow and stores the result under the specified name. The copied workflow gets a new workflow ID assigned.

Parameters:

newName - the name of the new workflow

copySource - the source set to copy

copyDisplayNames - true if display names should be copied as well

copyDescriptions - true if descriptions should be copied as well

Returns:

the copied set

Throws:

CumulusException - in case of an error

javax.naming.InvalidNameException - in case of an invalid or already used name

importSet

public Workflow importSet(JPack data,
                 SetImportDuplicatesMode duplicatesMode)
                   throws CumulusException,
                          PermissionDeniedException

Imports the given exported workflow data into a new workflow.

Parameters:

data - workflow that had been exported using Workflow.exportSet() before

duplicatesMode - mode to handle duplicate sets

Returns:

newly created workflow instance

Throws:

PermissionDeniedException - if you are not cumulus admin

CumulusException - in case of an server error

See Also:

Workflow.exportSet()

setAsDefault

public void setAsDefault(Workflow newDefault)

Sets the given workflow as the default workflow.

Parameters:

newDefault - the new default workflow

rename

public void rename(java.lang.String newName,
          Workflow workflow)
            throws CumulusException,
                   javax.naming.InvalidNameException

Renames the given workflow to the new specified name.

Parameters:

newName - the new name for the set

workflow - the workflow to rename

Throws:

CumulusException - in case of an error

javax.naming.InvalidNameException - in case of an invalid name

rename

public void rename(java.lang.String newName,
          Workflow workflow,
          boolean keepDisplayNames,
          boolean keepDescriptions)
            throws CumulusException,
                   javax.naming.InvalidNameException

Renames the given workflow to the new specified name.

Parameters:

newName - the new name for the set

workflow - the set to rename

keepDisplayNames - true if display names should be kept

keepDescriptions - true if descriptions should be kept

Throws:

CumulusException - in case of an error

javax.naming.InvalidNameException - in case of an invalid name

delete

public void delete(Workflow workflow)
            throws CumulusException

Deletes the given workflow.

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

copy

public Item copy(java.lang.String newID,
        Item src,
        boolean copyDisplayNames,
        boolean copyDescriptions)
          throws javax.naming.InvalidNameException,
                 CumulusException

Duplicates the given workflow with the specified UID.

Specified by:

copy in interface ItemManager

Parameters:

newID - the UID of the new item

src - the item to copy

copyDisplayNames - true if display names should be copied as well

copyDescriptions - true if descriptions should be copied as well

Returns:

the copied item instance

Throws:

javax.naming.InvalidNameException - if the name is already in use or invalid for another reason

CumulusException - in case of an error

delete

public void delete(Item item)
            throws CumulusException

Deletes the given item.

Specified by:

delete in interface ItemManager

Parameters:

item - the item to delete

Throws:

CumulusException - in case of an error

getItem

public Item getItem(java.lang.String id)

Returns the item with the specified UID.

Specified by:

getItem in interface ItemManager

Parameters:

id - the items UID to get

Returns:

the found item or null if not found

getItemIDs

public java.util.Collection<java.lang.String> getItemIDs()

Returns the list of item UIDs that are available by this manager instance.

Specified by:

getItemIDs in interface ItemManager

Returns:

list of item UIDs

rename

public void rename(java.lang.String newID,
          Item item,
          boolean keepDisplayNames,
          boolean keepDescriptions)
            throws javax.naming.InvalidNameException,
                   CumulusException

Renames the given item to the new UID.

Specified by:

rename in interface ItemManager

Parameters:

newID - the new item UID

item - the item to rename

keepDisplayNames - true if display names should be kept

keepDescriptions - true if descriptions should be kept

Throws:

javax.naming.InvalidNameException - in case of an invalid name

CumulusException - in case of another error

setAsDefault

public void setAsDefault(Item item)

Sets the given item to be the default item. This makes only sense for shared items.

Specified by:

setAsDefault in interface ItemManager

Parameters:

item - the item to be the default

getPath

public java.lang.String getPath()

Description copied from interface: ItemManager

Returns the path for this item manager instance.

Specified by:

getPath in interface ItemManager

Returns:

path for this item manager instance

getItemType

public int getItemType()

Description copied from interface: ItemManager

Returns the item type for the items of this manager.

Specified by:

getItemType in interface ItemManager

Returns:

item type for the items of this manager