Package org.opencastproject.workflow.api

Class WorkflowInstance

java.lang.Object

org.opencastproject.workflow.api.WorkflowInstance

@Entity(name="WorkflowInstance")
public class WorkflowInstance
extends Object

Entity object for storing workflows in persistence storage. Workflow ID is stored as primary key, DUBLIN_CORE field is used to store serialized Dublin core and ACCESS_CONTROL field is used to store information about access control rules.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	WorkflowInstance.WorkflowState

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<String,String>	configurations
protected String	mediaPackageId
protected List<WorkflowOperationInstance>	operations
protected String	seriesId

Constructor Summary

Constructors

Constructor	Description
WorkflowInstance()	Default constructor without any import.
WorkflowInstance(long id, WorkflowInstance.WorkflowState state, String template, String title, String description, String creatorName, String organizationId, Date dateCreated, Date dateCompleted, MediaPackage mediaPackage, List<WorkflowOperationInstance> operations, Map<String,String> configurations, String mediaPackageId, String seriesId)
WorkflowInstance(WorkflowDefinition def, MediaPackage mediaPackage, User creator, Organization organization, Map<String,String> configuration)	Constructs a new workflow instance from the given definition, mediapackage, and optional parent workflow ID and properties.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
void	extend(WorkflowDefinition workflowDefinition)
String	getConfiguration(String key)
Set<String>	getConfigurationKeys()
Map<String,String>	getConfigurations()
String	getCreatorName()
WorkflowOperationInstance	getCurrentOperation()	Returns the workflow operation that is currently active or next to be executed.
Date	getDateCompleted()
Date	getDateCreated()
String	getDescription()
long	getId()
MediaPackage	getMediaPackage()
List<WorkflowOperationInstance>	getOperations()
String	getOrganizationId()
WorkflowInstance.WorkflowState	getState()
String	getTemplate()
String	getTitle()
int	hashCode()
void	insert(WorkflowDefinition workflowDefinition, WorkflowOperationInstance after)
boolean	isActive()
void	removeConfiguration(String key)
void	setConfiguration(String key, String value)
void	setCreatorName(String creatorName)
void	setDateCompleted(Date dateCompleted)
void	setDateCreated(Date dateCreated)
void	setDescription(String description)
void	setId(long workflowId)
void	setMediaPackage(MediaPackage mediaPackage)
final void	setOperations(List<WorkflowOperationInstance> workflowOperationInstanceList)	Sets the workflow operations on this workflow instance
void	setOrganizationId(String organizationId)
void	setState(WorkflowInstance.WorkflowState state)
void	setTemplate(String template)
void	setTitle(String title)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

operations

protected List<WorkflowOperationInstance> operations

configurations

protected Map<String,String> configurations

mediaPackageId

protected String mediaPackageId

seriesId

protected String seriesId

Constructor Details

WorkflowInstance

public WorkflowInstance()

Default constructor without any import.

WorkflowInstance

public WorkflowInstance(WorkflowDefinition def,
 MediaPackage mediaPackage,
 User creator,
 Organization organization,
 Map<String,String> configuration)

Constructs a new workflow instance from the given definition, mediapackage, and optional parent workflow ID and properties.

WorkflowInstance

public WorkflowInstance(long id,
 WorkflowInstance.WorkflowState state,
 String template,
 String title,
 String description,
 String creatorName,
 String organizationId,
 Date dateCreated,
 Date dateCompleted,
 MediaPackage mediaPackage,
 List<WorkflowOperationInstance> operations,
 Map<String,String> configurations,
 String mediaPackageId,
 String seriesId)

Method Details

getId

public long getId()

setId

public void setId(long workflowId)

getState

public WorkflowInstance.WorkflowState getState()

setState

public void setState(WorkflowInstance.WorkflowState state)

getTemplate

public String getTemplate()

setTemplate

public void setTemplate(String template)

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getCreatorName

public String getCreatorName()

setCreatorName

public void setCreatorName(String creatorName)

getOrganizationId

public String getOrganizationId()

setOrganizationId

public void setOrganizationId(String organizationId)

getDateCreated

public Date getDateCreated()

setDateCreated

public void setDateCreated(Date dateCreated)

getDateCompleted

public Date getDateCompleted()

setDateCompleted

public void setDateCompleted(Date dateCompleted)

getMediaPackage

public MediaPackage getMediaPackage()

setMediaPackage

public void setMediaPackage(MediaPackage mediaPackage)

isActive

public boolean isActive()

getOperations

public List<WorkflowOperationInstance> getOperations()

See Also:

• getOperations()

setOperations

public final void setOperations(List<WorkflowOperationInstance> workflowOperationInstanceList)

Sets the workflow operations on this workflow instance

Parameters:

workflowOperationInstanceList - List of operations to set.

getCurrentOperation

public WorkflowOperationInstance getCurrentOperation()

Returns the workflow operation that is currently active or next to be executed.

Returns:

the current operation

getConfigurations

public Map<String,String> getConfigurations()

getConfiguration

public String getConfiguration(String key)

See Also:

• Configurable.getConfiguration(java.lang.String)

getConfigurationKeys

public Set<String> getConfigurationKeys()

See Also:

• Configurable.getConfigurationKeys()

removeConfiguration

public void removeConfiguration(String key)

See Also:

• Configurable.removeConfiguration(java.lang.String)

setConfiguration

public void setConfiguration(String key,
 String value)

See Also:

• Configurable.setConfiguration(java.lang.String, java.lang.String)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

extend

public void extend(WorkflowDefinition workflowDefinition)

insert

public void insert(WorkflowDefinition workflowDefinition,
 WorkflowOperationInstance after)