blackboard.cms.workflow
Class Workflow

java.lang.Object
  blackboard.data.BbObject
      blackboard.cms.workflow.Workflow

All Implemented Interfaces:

java.lang.Cloneable, blackboard.data.IBbObject

public class Workflow

extends blackboard.data.BbObject

The Workflow class provides a representation of a workflow within the Blackboard application. A Workflow must has a type associated with it. The current valid types are:

WorkflowType.APPROVE;
WorkflowType.COMPLETE
WorkflowType.GRADE
WorkflowType.REMIND
WorkflowType.REVIEW
WorkflowType.SHARE

See WorkflowType for more details

Since:

Bb CS 1.0

Version:

$Revision: $

Nested Class Summary

static class

Workflow.Priority

Field Summary

static blackboard.persist.DataType

DATA_TYPE Object data type constant used in brokering loaders and persisters

Fields inherited from class blackboard.data.BbObject

_bbAttributes

Constructor Summary

Workflow()
Creates an instance of Workflow with default property values.

Method Summary

blackboard.persist.DataType	getDataType() Returns the DataType identifier for this object.
java.lang.String	getDescription() Returns the description for the Workflow.
java.util.Calendar	getDueDate() Returns the Due Date for the Workflow.
long	getDueDateSortValue() Returns the sort value by Due Date for the Workflow.
blackboard.persist.Id	getOwnerId() Returns the Owner Id for the Workflow.
Workflow.Priority	getPriority() Returns the Workflow Priority for the Workflow.
java.lang.String	getTitle() Returns the Title for the Workflow.
java.lang.String	getType() Returns the type for the Workflow.
void	setDescription(java.lang.String str) Sets the description for the Workflow.
void	setDueDate(java.util.Calendar cal) Sets the Due Date for the Workflow.
void	setOwnerId(blackboard.persist.Id id) Sets the Owner Id for the Workflow.
void	setPriority(Workflow.Priority ePriority) Sets the Workflow Priority for the Workflow.
void	setTitle(java.lang.String strTitle) Sets the Title for the Workflow.
void	setType(java.lang.String strType) Sets the type for the Workflow.

Methods inherited from class blackboard.data.BbObject

clone, getBbAttributes, getCreatedDate, getId, getModifiedDate, persist, setCreatedDate, setId, setModifiedDate, toString, validate

Methods inherited from class java.lang.Object

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

Field Detail

DATA_TYPE

public static final blackboard.persist.DataType DATA_TYPE

Object data type constant used in brokering loaders and persisters

Constructor Detail

Workflow

public Workflow()

Creates an instance of Workflow with default property values.

Method Detail

getDescription

public java.lang.String getDescription()

Returns the description for the Workflow.

Returns:

a String representing the description for the Workflow.

setDescription

public void setDescription(java.lang.String str)

Sets the description for the Workflow.

Parameters:

str - a String representing the description for the Workflow.

getDueDate

public java.util.Calendar getDueDate()

Returns the Due Date for the Workflow.

Returns:

a Calendar representing the Due Date for the Workflow.

setDueDate

public void setDueDate(java.util.Calendar cal)

Sets the Due Date for the Workflow.

Parameters:

cal - a Calendar representing the Due Date for the Workflow.

getDueDateSortValue

public long getDueDateSortValue()

Returns the sort value by Due Date for the Workflow.

Returns:

a long representing the Due Date sort value for the Workflow.

getOwnerId

public blackboard.persist.Id getOwnerId()

Returns the Owner Id for the Workflow.

Returns:

an Id representing the Owner <@link Id} for the Workflow.

setOwnerId

public void setOwnerId(blackboard.persist.Id id)

Sets the Owner Id for the Workflow.

Parameters:

id - an Id representing the Owner <@link Id} for the Workflow.

getPriority

public Workflow.Priority getPriority()

Returns the Workflow Priority for the Workflow.

Returns:

a Workflow.Priority representing the Priority for the Workflow.

setPriority

public void setPriority(Workflow.Priority ePriority)

Sets the Workflow Priority for the Workflow.

Parameters:

ePriority - a Workflow.Priority representing the Priority for the Workflow.

getTitle

public java.lang.String getTitle()

Returns the Title for the Workflow.

Returns:

a String representing the Title for the Workflow.

setTitle

public void setTitle(java.lang.String strTitle)

Sets the Title for the Workflow.

Parameters:

strTitle - a String representing the Title for the Workflow.

getType

public java.lang.String getType()

Returns the type for the Workflow.

Returns:

a String representing the type for the Workflow.

setType

public void setType(java.lang.String strType)

Sets the type for the Workflow.

Parameters:

strType - a String representing the type for the Workflow.

getDataType

public blackboard.persist.DataType getDataType()

Returns the DataType identifier for this object. Can be used to uniquely identify the "type" of this data object.

Returns:

the DataType for this object