|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.arsdigita.domain.DomainObject
com.arsdigita.domain.ObservableDomainObject
com.arsdigita.kernel.ACSObject
com.arsdigita.auditing.AuditedACSObject
com.arsdigita.workflow.simple.Task
com.arsdigita.workflow.simple.Workflow
com.arsdigita.workflow.simple.WorkflowTemplate
Field Summary | |
static String |
BASE_DATA_OBJECT_TYPE
|
static String |
versionId
|
Fields inherited from class com.arsdigita.workflow.simple.Workflow |
DELETED, INIT, NONE, STARTED, STOPPED |
Fields inherited from class com.arsdigita.workflow.simple.Task |
DISABLED, ENABLED, FINISHED, INACTIVE |
Fields inherited from class com.arsdigita.kernel.ACSObject |
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE |
Constructor Summary | |
|
WorkflowTemplate()
Creates a new workflow process definition with the properties label and description set to null. |
|
WorkflowTemplate(BigDecimal id)
Restores a workflow process definition with a BigDecimal. |
|
WorkflowTemplate(DataObject workflowTemplateDataObject)
Restores a workflow process definition from task data object. |
protected |
WorkflowTemplate(ObjectType type)
Constructor for setting the object type name. |
|
WorkflowTemplate(OID oid)
Restores a workflow process definition with an OID. |
protected |
WorkflowTemplate(String typeName)
|
|
WorkflowTemplate(String label,
String description)
Creates a new workflow process definition. |
Method Summary | |
void |
addTask(Task task)
Adds a task to this process. |
void |
extendWorkflow(Workflow workflow)
Extends the workflow by appending the tasks from the workflow template |
Iterator |
getEnabledTasks()
Returns an iterator over all enabled tasks in the process. |
Iterator |
getFinishedTasks()
Returns an iterator over all finished tasks in the process. |
OID |
getObjectOID()
Returns the object associated with the process. |
Iterator |
getOverdueTasks()
|
int |
getProcessState()
Retrieves the state of the process. |
Workflow |
instantiateNewWorkflow()
Creates a workflow based on the supplied workflow definition ID. |
void |
setObject(ACSObject o)
Sets the Object that this workflow is applied to. |
void |
start(User user)
Starts the process. |
void |
stop(User user)
Stops the process. |
Methods inherited from class com.arsdigita.workflow.simple.Workflow |
clone, cloneTasks, disableEvt, enable, getBaseDataObjectType, getItemID, getItemID, getObject, getObjectWorkflow, getObjectWorkflow, getObjectWorkflowID, getObjectWorkflowID, getTaskCollection, getTaskCount, getTasks, getWorkflowTemplate, initialize, removeAllTasks, removeTask, removeTask, save, setObjectID, setWorkflowTemplate, startInternal |
Methods inherited from class com.arsdigita.auditing.AuditedACSObject |
getCreationDate, getCreationIP, getCreationUser, getLastModifiedDate, getLastModifiedIP, getLastModifiedUser |
Methods inherited from class com.arsdigita.kernel.ACSObject |
assertPrivilege, beforeSave, checkPrivilege, doCreateCheck, doWriteCheck, getContainer, getDefaultDomainClass, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, isContainerModified, setID, setID |
Methods inherited from class com.arsdigita.domain.ObservableDomainObject |
addObserver, getObservers |
Methods inherited from class com.arsdigita.domain.DomainObject |
add, add, addToAssociation, afterDelete, afterSave, beforeDelete, clear, disconnect, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject |
Methods inherited from class java.lang.Object |
finalize, getClass, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final String versionId
public static final String BASE_DATA_OBJECT_TYPE
Constructor Detail |
public WorkflowTemplate(String label, String description)
save()
method is called.
label
- the labeldescription
- the descriptionpublic WorkflowTemplate()
label
and description
set to null.
Properties of this
object are not made persistent until the save
method is called. If save() is called
without setting these properties, an IllegalArgumentException
will be thrown.
public WorkflowTemplate(DataObject workflowTemplateDataObject)
workflowTemplateDataObject
- the template object to restore the process fromprotected WorkflowTemplate(ObjectType type)
type
- the type nameprotected WorkflowTemplate(String typeName)
public WorkflowTemplate(OID oid) throws DataObjectNotFoundException
oid
- the OIDpublic WorkflowTemplate(BigDecimal id) throws DataObjectNotFoundException
id
- the BigDecimal ID of this object. An OID will be
created implicitly with the BASE_DATA_OBJECT_TYPE constant
specified in this file.Method Detail |
public Workflow instantiateNewWorkflow()
public void extendWorkflow(Workflow workflow)
public void addTask(Task task)
addTask
in class Workflow
task
- the task to add to this process
TODO: change this to use role relations. right now we just
change the parent of the task manually. This should be donevia
the PDL file.Task
public void stop(User user)
Workflow
stop
in class Workflow
user
- the user that stopped the processpublic void start(User user)
Workflow
start
in class Workflow
user
- the user that starts the processpublic int getProcessState()
Workflow
getProcessState
in class Workflow
public void setObject(ACSObject o)
Workflow
setObject
in class Workflow
o
- the object to which to apply this workflow.public Iterator getEnabledTasks()
Workflow
getEnabledTasks
in class Workflow
public Iterator getFinishedTasks()
Workflow
getFinishedTasks
in class Workflow
public Iterator getOverdueTasks()
getOverdueTasks
in class Workflow
public OID getObjectOID()
Workflow
getObjectOID
in class Workflow
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |