Package org.opencastproject.workflow.api

Class WorkflowDefinitionImpl

java.lang.Object

org.opencastproject.workflow.api.WorkflowDefinitionImpl

All Implemented Interfaces:

Comparable<WorkflowDefinition>, WorkflowDefinition

public class WorkflowDefinitionImpl
extends Object
implements WorkflowDefinition

A JAXB-annotated implementation of WorkflowDefinition

Field Summary

Fields

Modifier and Type	Field	Description
protected SortedSet<String>	roles
protected SortedSet<String>	tags

Fields inherited from interface org.opencastproject.workflow.api.WorkflowDefinition

FAILURE_KEY

Constructor Summary

Constructors

Constructor	Description
WorkflowDefinitionImpl()	Constructor to be used by JAXB only.

Method Summary

Modifier and Type	Method	Description
void	add(WorkflowOperationDefinition operation)	Appends the operation to the workflow definition.
void	add(WorkflowOperationDefinition operation, int position)	Inserts the operation at the given position into the workflow definition.
void	addTag(String tag)	Tags the workflow definition with the given tag.
void	clearTags()	Removes all tags associated with this workflow definition
int	compareTo(WorkflowDefinition workflowDefinition)
boolean	containsTag(String tag)	Returns true if the workflow definition contains the given tag.
boolean	containsTag(Collection<String> tags)	Returns true if the workflow definition contains at least one of the given tags.
WorkflowOperationDefinition	get(int position)	Returns the operation at the given position.
String	getConfigurationPanel()	A XML String describing the configuration parameter/panel for this WorkflowDefinition.
String	getConfigurationPanelJson()	A JSON String describing the configuration parameter/panel for this WorkflowDefinition.
String	getDescription()	A longer description of this workflow definition
int	getDisplayOrder()	An integer describing the display order for this workflow definition.
String	getId()	The short title of this workflow definition
List<WorkflowOperationDefinition>	getOperations()	The operations, listed in order, that this workflow definition includes.
String	getOrganization()	Gets the organization associated with this workflow (or null, if it's global)
Collection<String>	getRoles()	Returns the roles for this workflow definition
Set<WorkflowStateMapping>	getStateMappings()	The custom state mappings to use for this workflow.
String[]	getTags()	Returns the tags for this workflow definition or an empty array if there are no tags.
String	getTitle()	The title for this workflow definition
WorkflowOperationDefinition	remove(int position)	Removes the workflow operation at the indicated position and returns it.
void	removeTag(String tag)	Removes the tag from the workflow definition.
void	setConfigurationPanel(String panelXML)	Sets the configuration panel for this workflow.
void	setConfigurationPanelJson(String panelJson)	Sets the configuration panel for this workflow.
void	setDescription(String description)	Sets the description
void	setDisplayOrder(int displayOrder)	Set the display order
void	setId(String id)	Sets the identifier
void	setTitle(String title)	Sets the title
String	toString()
static WorkflowDefinitionImpl	valueOf(String xmlString)	Since we are posting workflow definitions as one post parameter in a multi-parameter post, we can not rely on "automatic" JAXB deserialization.

Methods inherited from class java.lang.Object

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

Field Details

tags

protected SortedSet<String> tags

roles

protected SortedSet<String> roles

Constructor Details

WorkflowDefinitionImpl

public WorkflowDefinitionImpl()

Constructor to be used by JAXB only.

Method Details

getId

public String getId()

The short title of this workflow definition

Specified by:

getId in interface WorkflowDefinition

See Also:

• WorkflowDefinition.getId()

setId

public void setId(String id)

Sets the identifier

Specified by:

setId in interface WorkflowDefinition

Parameters:

id - the workflow definition identifier

See Also:

• WorkflowDefinition.setId(java.lang.String)

getDescription

public String getDescription()

A longer description of this workflow definition

Specified by:

getDescription in interface WorkflowDefinition

See Also:

• WorkflowDefinition.getDescription()

setDescription

public void setDescription(String description)

Sets the description

Specified by:

setDescription in interface WorkflowDefinition

Parameters:

description - the workflow definition description

See Also:

• WorkflowDefinition.setDescription(java.lang.String)

getDisplayOrder

public int getDisplayOrder()

An integer describing the display order for this workflow definition. The display order is supposed to define the order workflow lists as displayed to users. Default is 0.

Specified by:

getDisplayOrder in interface WorkflowDefinition

See Also:

• WorkflowDefinition.getDisplayOrder()

setDisplayOrder

public void setDisplayOrder(int displayOrder)

Set the display order

Specified by:

setDisplayOrder in interface WorkflowDefinition

Parameters:

displayOrder - the workflow definition display order

See Also:

• WorkflowDefinition.setDisplayOrder(int)

setConfigurationPanel

public void setConfigurationPanel(String panelXML)

Sets the configuration panel for this workflow.

Parameters:

panelXML - the xml for the configuration panel

getConfigurationPanel

public String getConfigurationPanel()

A XML String describing the configuration parameter/panel for this WorkflowDefinition.

Specified by:

getConfigurationPanel in interface WorkflowDefinition

See Also:

• WorkflowDefinition.getConfigurationPanel()

setConfigurationPanelJson

public void setConfigurationPanelJson(String panelJson)

Sets the configuration panel for this workflow.

Parameters:

panelJson - the json for the configuration panel

getConfigurationPanelJson

public String getConfigurationPanelJson()

A JSON String describing the configuration parameter/panel for this WorkflowDefinition.

Specified by:

getConfigurationPanelJson in interface WorkflowDefinition

See Also:

• WorkflowDefinition.getConfigurationPanelJson()

getOperations

public List<WorkflowOperationDefinition> getOperations()

The operations, listed in order, that this workflow definition includes.

Specified by:

getOperations in interface WorkflowDefinition

See Also:

• WorkflowDefinition.getOperations()

getStateMappings

public Set<WorkflowStateMapping> getStateMappings()

Description copied from interface: WorkflowDefinition

The custom state mappings to use for this workflow.

Specified by:

getStateMappings in interface WorkflowDefinition

get

public WorkflowOperationDefinition get(int position)
                                throws IndexOutOfBoundsException

Returns the operation at the given position.

Specified by:

get in interface WorkflowDefinition

Parameters:

position - the operation's position

Throws:

IndexOutOfBoundsException - if position is larger than the number of operations

See Also:

• WorkflowDefinition.get(int)

add

public void add(WorkflowOperationDefinition operation)

Appends the operation to the workflow definition.

Specified by:

add in interface WorkflowDefinition

Parameters:

operation - the operation

See Also:

• WorkflowDefinition.add(org.opencastproject.workflow.api.WorkflowOperationDefinition)

add

public void add(WorkflowOperationDefinition operation,
 int position)

Inserts the operation at the given position into the workflow definition.

Specified by:

add in interface WorkflowDefinition

Parameters:

operation - the operation

position - the position to add the workflow operation to

See Also:

• WorkflowDefinition.add(org.opencastproject.workflow.api.WorkflowOperationDefinition, int)

remove

public WorkflowOperationDefinition remove(int position)
                                   throws IndexOutOfBoundsException

Removes the workflow operation at the indicated position and returns it.

Specified by:

remove in interface WorkflowDefinition

Parameters:

position - the operation's position

Returns:

the removed workflow operation

Throws:

IndexOutOfBoundsException - if position is larger than the number of operations

See Also:

• WorkflowDefinition.remove(int)

addTag

public void addTag(String tag)

Description copied from interface: WorkflowDefinition

Tags the workflow definition with the given tag.

Specified by:

addTag in interface WorkflowDefinition

Parameters:

tag - the tag

See Also:

• WorkflowDefinition.addTag(String)

removeTag

public void removeTag(String tag)

Description copied from interface: WorkflowDefinition

Removes the tag from the workflow definition.

Specified by:

removeTag in interface WorkflowDefinition

Parameters:

tag - the tag

See Also:

• WorkflowDefinition.removeTag(String)

containsTag

public boolean containsTag(String tag)

Description copied from interface: WorkflowDefinition

Returns true if the workflow definition contains the given tag.

Specified by:

containsTag in interface WorkflowDefinition

Parameters:

tag - the tag

Returns:

true if the element is tagged

See Also:

• WorkflowDefinition.containsTag(String)

containsTag

public boolean containsTag(Collection<String> tags)

Description copied from interface: WorkflowDefinition

Returns true if the workflow definition contains at least one of the given tags. If there are no tags contained in the set, then the definition is considered to match as well.

Specified by:

containsTag in interface WorkflowDefinition

Parameters:

tags - the set of tag

Returns:

true if the element is tagged accordingly

See Also:

• WorkflowDefinition.containsTag(Collection)

getTags

public String[] getTags()

Description copied from interface: WorkflowDefinition

Returns the tags for this workflow definition or an empty array if there are no tags.

Specified by:

getTags in interface WorkflowDefinition

Returns:

the tags

See Also:

• WorkflowDefinition.getTags()

clearTags

public void clearTags()

Description copied from interface: WorkflowDefinition

Removes all tags associated with this workflow definition

Specified by:

clearTags in interface WorkflowDefinition

See Also:

• WorkflowDefinition.clearTags()

valueOf

public static WorkflowDefinitionImpl valueOf(String xmlString)
                                      throws Exception

Since we are posting workflow definitions as one post parameter in a multi-parameter post, we can not rely on "automatic" JAXB deserialization. We therefore need to provide a static valueOf(String) method to transform an XML string into a WorkflowDefinition.

Parameters:

xmlString - The xml describing the workflow

Returns:

A WorkflowDefinitionImpl instance based on xmlString

Throws:

Exception - If there is a problem marshalling the WorkflowDefinitionImpl from XML.

compareTo

public int compareTo(WorkflowDefinition workflowDefinition)

Specified by:

compareTo in interface Comparable<WorkflowDefinition>

getTitle

public String getTitle()

Description copied from interface: WorkflowDefinition

The title for this workflow definition

Specified by:

getTitle in interface WorkflowDefinition

Returns:

the title

setTitle

public void setTitle(String title)

Description copied from interface: WorkflowDefinition

Sets the title

Specified by:

setTitle in interface WorkflowDefinition

Parameters:

title - the title to set

getOrganization

public String getOrganization()

Description copied from interface: WorkflowDefinition

Gets the organization associated with this workflow (or null, if it's global)

Specified by:

getOrganization in interface WorkflowDefinition

Returns:

the organization

getRoles

public Collection<String> getRoles()

Description copied from interface: WorkflowDefinition

Returns the roles for this workflow definition

Specified by:

getRoles in interface WorkflowDefinition

Returns:

the tags

toString

public String toString()

Overrides:

toString in class Object

See Also:

• Object.toString()