|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object PWSResourceFileTagSupport atg.epub.pws.taglib.GetTasksTag
public class GetTasksTag
Tag for obtaining a list of tasks from the workflow engine. By supplying the processId, it will return only tasks for that process' workflow instance. If null, will return active tasks for the entire system. By supplying the userOnly property, it will return tasks for the current user only. When processId and userOnly are supplied, will return current user's tasks for given process' workflow. If unowned is true, then it will filter the results to include only those active tasks which are unowned. It will include the user's and unowned tasks if userOnly and unowned are both true. Everything above assumes active is true (default). If active is false, then processId is required and userOnly and unowned are ignored. This will return all the tasks for the given process.
TaskInfo
Nested Class Summary | |
---|---|
class |
GetTasksTag.Results
Results class for returning output for this tag |
static class |
GetTasksTag.TEI
TagExtraInfo class to handle var/id processing. |
Field Summary | |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string |
Constructor Summary | |
---|---|
GetTasksTag()
Empty Constructor |
Method Summary | |
---|---|
int |
doStartTag()
Sets the page variable defined in the id/var property to a collection of TaskInfo objects. |
boolean |
getActive()
|
java.lang.String |
getProcessId()
|
java.lang.String |
getTaskElementId()
|
boolean |
getUnowned()
|
boolean |
getUserOnly()
|
java.lang.String |
getWorkflowId()
|
void |
release()
|
void |
setActive(boolean pActive)
Sets a flag indicating whether or not to return active tasks, default is true. |
void |
setProcessId(java.lang.String string)
Sets the processId to get the tasks for |
void |
setTaskElementId(java.lang.String string)
Sets the task element ID to get a specific taskInfo |
void |
setUnowned(boolean pUnowned)
Sets a flag indicating whether or not to return unowned tasks. |
void |
setUserOnly(boolean pUserOnly)
Sets the userOnly flag which indicates that only the tasks for the current user should be returned |
void |
setWorkflowId(java.lang.String string)
Sets the workflow ID to get tasks for a specific workflow in the process |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static java.lang.String CLASS_VERSION
Constructor Detail |
---|
public GetTasksTag()
Method Detail |
---|
public void setUserOnly(boolean pUserOnly)
pUserOnly
- true to return only the tasks for the current user, false
to return all taskspublic boolean getUserOnly()
public void setUnowned(boolean pUnowned)
pUnowned
- flag indicating whether or not to return unowned taskspublic boolean getUnowned()
public void setActive(boolean pActive)
pActive
- a flag indicating whether or not to return active taskspublic boolean getActive()
public void setProcessId(java.lang.String string)
string
- the processId to get the tasks forpublic java.lang.String getProcessId()
public void setWorkflowId(java.lang.String string)
string
- the workflow Idpublic java.lang.String getWorkflowId()
public void setTaskElementId(java.lang.String string)
string
- the task element Idpublic java.lang.String getTaskElementId()
public int doStartTag() throws javax.servlet.jsp.JspException
javax.servlet.jsp.JspException
- if a workflow error occurs or if active is true
and projectId is nullTaskInfo
public void release()
Tag.release()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |