Package org.ametys.plugins.workflow.repository

Class WorkflowAwareAmetysObjectHelper

java.lang.Object

org.ametys.plugins.workflow.repository.WorkflowAwareAmetysObjectHelper

public final class WorkflowAwareAmetysObjectHelper
extends Object

Provides helper methods to use the WorkflowAwareAmetysObject.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	METADATA_CURRENT_STEP_ID	Constants for currentStepId Metadata*
static final String	METADATA_WORKFLOW_ID	Constants for workflowId Metadata*

Method Summary

Modifier and Type	Method	Description
static long	getCurrentStepId(WorkflowAwareAmetysObject ametysObject)	Get an ametys object's current step ID.
static long	getWorkflowId(WorkflowAwareAmetysObject ametysObject)	Get an ametys object's workflow ID
static void	removeWorkflowId(WorkflowAwareAmetysObject ametysObject)	Remove the workflow ID property if exists on
static void	setCurrentStepId(WorkflowAwareAmetysObject ametysObject, long stepId)	Set an ametys object's current step ID.
static void	setWorkflowId(WorkflowAwareAmetysObject ametysObject, long workflowId)	Set an ametys object's workflow ID.

Methods inherited from class java.lang.Object

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

Field Details

METADATA_WORKFLOW_ID

public static final String METADATA_WORKFLOW_ID

Constants for workflowId Metadata*

See Also:

• Constant Field Values

METADATA_CURRENT_STEP_ID

public static final String METADATA_CURRENT_STEP_ID

Constants for currentStepId Metadata*

See Also:

• Constant Field Values

Method Details

getWorkflowId

public static long getWorkflowId(WorkflowAwareAmetysObject ametysObject)
                          throws AmetysRepositoryException

Get an ametys object's workflow ID

Parameters:

ametysObject - the ametys object

Returns:

the ametys object's workflow ID

Throws:

AmetysRepositoryException - if an error occurs

setWorkflowId

public static void setWorkflowId(WorkflowAwareAmetysObject ametysObject,
 long workflowId)
                          throws AmetysRepositoryException

Set an ametys object's workflow ID.

Parameters:

ametysObject - the ametys object

workflowId - the workflow ID to set.

Throws:

AmetysRepositoryException - if an error occurs.

removeWorkflowId

public static void removeWorkflowId(WorkflowAwareAmetysObject ametysObject)

Remove the workflow ID property if exists on

Parameters:

ametysObject - the ametys object

getCurrentStepId

public static long getCurrentStepId(WorkflowAwareAmetysObject ametysObject)
                             throws AmetysRepositoryException

Get an ametys object's current step ID.

Parameters:

ametysObject - the ametys object

Returns:

the ametys object's current step ID.

Throws:

AmetysRepositoryException - if an error occurs.

setCurrentStepId

public static void setCurrentStepId(WorkflowAwareAmetysObject ametysObject,
 long stepId)
                             throws AmetysRepositoryException

Set an ametys object's current step ID.

Parameters:

ametysObject - the ametys object

stepId - the current step ID to set.

Throws:

AmetysRepositoryException - if an error occurs.