org.alfresco.bm.wf

Class WorkflowDAO

java.lang.Object

org.alfresco.bm.wf.WorkflowDAO

public class WorkflowDAO
extends Object

Service providing access to WorkflowData storage. All WorkflowData returned from and persisted with this service will be testrun-specific. The testrun-identifier is set in the constructor.

Since:

1.0

Author:

Frederik Heremans, Derek Hulley

Field Summary

Fields

Modifier and Type	Field and Description
static String	FIELD_END_DATE
static String	FIELD_ID
static String	FIELD_START_DATE
static String	FIELD_STATE
static String	FIELD_TEST_RUN
static String	FIELD_USERNAME
static String	FIELD_WORKFLOW_DEFINITION
static String	FIELD_WORKFLOW_ID

Constructor Summary

Constructors

Constructor and Description
WorkflowDAO(com.mongodb.DB db, String collection, String testRun)

Method Summary

Modifier and Type	Method and Description
long	countWorkflows(org.alfresco.bm.data.DataCreationState state) Count the workflows in the given state (for the current test run)
String	createWorkflow(String workflowDefinition) Create a new data object using the definition provided (for the current test run)
com.mongodb.DBObject	findById(String id) Find data by generated ID.
List<com.mongodb.DBObject>	findWorkflows(org.alfresco.bm.data.DataCreationState state, int count) Find a number of processes with a given state (for the current test run)
void	setEnded(String id, Date endDate) Mark a workflow as ended.
void	setStarted(String id, String username, String workflowId, Date startDate) Mark a workflow as started.
void	setState(String id, org.alfresco.bm.data.DataCreationState state) Mark a workflow as scheduled.

Methods inherited from class java.lang.Object

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

Field Detail

FIELD_ID

public static final String FIELD_ID

See Also:

Constant Field Values

FIELD_WORKFLOW_DEFINITION

public static final String FIELD_WORKFLOW_DEFINITION

See Also:

Constant Field Values

FIELD_WORKFLOW_ID

public static final String FIELD_WORKFLOW_ID

See Also:

Constant Field Values

FIELD_USERNAME

public static final String FIELD_USERNAME

See Also:

Constant Field Values

FIELD_START_DATE

public static final String FIELD_START_DATE

See Also:

Constant Field Values

FIELD_END_DATE

public static final String FIELD_END_DATE

See Also:

Constant Field Values

FIELD_STATE

public static final String FIELD_STATE

See Also:

Constant Field Values

FIELD_TEST_RUN

public static final String FIELD_TEST_RUN

See Also:

Constant Field Values

Constructor Detail

WorkflowDAO

public WorkflowDAO(com.mongodb.DB db,
                   String collection,
                   String testRun)

Parameters:

db - MongoDB

collection - name of DB collection containing workflow data

testRun - name of the test run to separate all workflows

Method Detail

createWorkflow

public String createWorkflow(String workflowDefinition)

Create a new data object using the definition provided (for the current test run)

Returns:

the generated ID of the data instance

findById

public com.mongodb.DBObject findById(String id)

Find data by generated ID.

Returns:

the matching data. Returns null if no data is found for the given id.

setState

public void setState(String id,
                     org.alfresco.bm.data.DataCreationState state)

Mark a workflow as scheduled.

Parameters:

id - id of the workflow in Mongo

state - the current state from a test perspective

setStarted

public void setStarted(String id,
                       String username,
                       String workflowId,
                       Date startDate)

Mark a workflow as started.

Parameters:

id - id of the workflow in Mongo

username - the name of the use that started the process

workflowId - id of the workflow in Alfresco

setEnded

public void setEnded(String id,
                     Date endDate)

Mark a workflow as ended.

Parameters:

id - id of the workflow in Mongo

countWorkflows

public long countWorkflows(org.alfresco.bm.data.DataCreationState state)

Count the workflows in the given state (for the current test run)

Parameters:

state - the state of the workflows or null to ignore

findWorkflows

public List<com.mongodb.DBObject> findWorkflows(org.alfresco.bm.data.DataCreationState state,
                                                int count)

Find a number of processes with a given state (for the current test run)

Parameters:

state - the state of the workflows or null to ignore

count - number of results that should be returned

Returns:

workflows of the given state up to the give count