Package org.opencastproject.workflow.api

Class WorkflowOperationResultImpl

java.lang.Object

org.opencastproject.workflow.api.WorkflowOperationResultImpl

All Implemented Interfaces:

WorkflowOperationResult

public class WorkflowOperationResultImpl
extends Object
implements WorkflowOperationResult

Nested Class Summary

Nested classes/interfaces inherited from interface org.opencastproject.workflow.api.WorkflowOperationResult

WorkflowOperationResult.Action

Field Summary

Fields

Modifier and Type	Field	Description
protected WorkflowOperationResult.Action	action
protected boolean	isAbortable
protected boolean	isContinuable
protected Map<String,String>	properties
protected MediaPackage	resultingMediaPackage
protected long	timeInQueue
protected boolean	wait

Constructor Summary

Constructors

Constructor	Description
WorkflowOperationResultImpl()	No arg constructor needed by JAXB
WorkflowOperationResultImpl(MediaPackage resultingMediaPackage, Map<String,String> properties, WorkflowOperationResult.Action action, long timeInQueue)	Constructs a new WorkflowOperationResultImpl from a mediapackage and an action.

Method Summary

Modifier and Type	Method	Description
boolean	allowsAbort()	Returns true if this operation can be canceled by the user from an optional hold state.
boolean	allowsContinue()	Returns true if this operation can be continued by the user from an optional hold state.
WorkflowOperationResult.Action	getAction()	Operations may optionally request that the workflow be placed in a certain state.
MediaPackage	getMediaPackage()
Map<String,String>	getProperties()	Operations may optionally set properties on a workflow operation.
long	getTimeInQueue()	The number of milliseconds this operation sat in a queue before finishing.
void	setAction(WorkflowOperationResult.Action action)	Sets the action that the workflow service should take on the workflow instance
void	setAllowsAbort(boolean isAbortable)	Specifies whether the operation should be abortable by the user.
void	setAllowsContinue(boolean isContinuable)	Specifies whether the operation should be continuable by the user.
void	setMediaPackage(MediaPackage mediaPackage)	Sets the resulting media package.

Methods inherited from class java.lang.Object

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

Field Details

resultingMediaPackage

protected MediaPackage resultingMediaPackage

properties

protected Map<String,String> properties

action

protected WorkflowOperationResult.Action action

timeInQueue

protected long timeInQueue

wait

protected boolean wait

isContinuable

protected boolean isContinuable

isAbortable

protected boolean isAbortable

Constructor Details

WorkflowOperationResultImpl

public WorkflowOperationResultImpl()

No arg constructor needed by JAXB

WorkflowOperationResultImpl

public WorkflowOperationResultImpl(MediaPackage resultingMediaPackage,
 Map<String,String> properties,
 WorkflowOperationResult.Action action,
 long timeInQueue)

Constructs a new WorkflowOperationResultImpl from a mediapackage and an action.

Parameters:

resultingMediaPackage -

action -

Method Details

getMediaPackage

public MediaPackage getMediaPackage()

Specified by:

getMediaPackage in interface WorkflowOperationResult

Returns:

The media package that results from the execution of a workflow operation.

See Also:

• WorkflowOperationResult.getMediaPackage()

setMediaPackage

public void setMediaPackage(MediaPackage mediaPackage)

Sets the resulting media package.

Parameters:

mediaPackage -

getAction

public WorkflowOperationResult.Action getAction()

Operations may optionally request that the workflow be placed in a certain state.

Specified by:

getAction in interface WorkflowOperationResult

Returns:

The action that the workflow service should take on this workflow instance.

See Also:

• WorkflowOperationResult.getAction()

setAction

public void setAction(WorkflowOperationResult.Action action)

Sets the action that the workflow service should take on the workflow instance

Specified by:

setAction in interface WorkflowOperationResult

Parameters:

action -

getProperties

public Map<String,String> getProperties()

Operations may optionally set properties on a workflow operation.

Specified by:

getProperties in interface WorkflowOperationResult

Returns:

The properties to set

See Also:

• WorkflowOperationResult.getProperties()

getTimeInQueue

public long getTimeInQueue()

The number of milliseconds this operation sat in a queue before finishing.

Specified by:

getTimeInQueue in interface WorkflowOperationResult

Returns:

The time spent in a queue

See Also:

• WorkflowOperationResult.getTimeInQueue()

setAllowsAbort

public void setAllowsAbort(boolean isAbortable)

Specifies whether the operation should be abortable by the user.

Specified by:

setAllowsAbort in interface WorkflowOperationResult

Parameters:

isAbortable -

allowsAbort

public boolean allowsAbort()

Returns true if this operation can be canceled by the user from an optional hold state. This value is only considered if the action returned by this result equals WorkflowOperationResult.Action.PAUSE.

Specified by:

allowsAbort in interface WorkflowOperationResult

Returns:

true if a paused operation should be abortable

See Also:

• WorkflowOperationResult.allowsAbort()

setAllowsContinue

public void setAllowsContinue(boolean isContinuable)

Specifies whether the operation should be continuable by the user.

Specified by:

setAllowsContinue in interface WorkflowOperationResult

Parameters:

isContinuable -

allowsContinue

public boolean allowsContinue()

Returns true if this operation can be continued by the user from an optional hold state. This value is only considered if the action returned by this result equals WorkflowOperationResult.Action.PAUSE.

Specified by:

allowsContinue in interface WorkflowOperationResult

Returns:

true if a paused operation should be continuable

See Also:

• WorkflowOperationResult.allowsContinue()