|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface TaskDataCursor
A cursor to browse a result set of tasks defined by a TaskQuery object. This cursor represents a set of tasks that satisfy the query used to create it at the moment the cursor is created (see below for more information). This cursor provides access to a 'page' of tasks at a time. You must use the WorklistTaskQuery interface to scroll the cursor forward and backward one page at a time.
You should note that this interface does NOT represent a true cursor as those familiar with database terminology would assume. This cursor does not hold any database locks, and makes no guarantees that the tasks for which it contains data will be up-to-date. This interface is most useful when the tasks it represents are not very likely to be updated over the course of the lifetime of this cursor.
The WorklistTaskQuery interface allows for refreshing a cursor at its current location, and refreshes a cursor automatically when moving it forward or backward. A refresh on this cursor refreshes the tasks the cursor represents, and the task data it holds for those tasks.
Method Summary | |
---|---|
boolean |
getIncludeTaskAssignee()
Should we retrieve assignee information along with the TaskData? This flag is set upon creation of the cursor according to the value of getIncludeTaskAssignee on the provided TaskQuery. |
boolean |
getIncludeTaskProperties()
Should we retrieve property information along with the TaskData? This flag is set upon creation of the cursor according to the value of getIncludeTaskProperties on the provided TaskQuery. |
boolean |
getIncludeTaskStepTimeEstimates()
Should we retrieve step time estimate information along with the TaskData? This flag is set upon creation of the cursor according to the value of getIncludeTaskStepTimeEstimates on the provided TaskQuery. |
List<String> |
getTaskIds()
Not for public use. |
TaskData[] |
getTasks()
|
boolean |
hasNextPage()
Can this cursor be moved forward without being after the last task? Note that this method bases its response on the current view it has of the tasks it represents. |
boolean |
hasPreviousPage()
Can this cursor be moved backward without being before the first task? Note that this method bases its response on the current view it has of the tasks it represents. |
boolean |
isWithAffinity()
|
void |
merge(TaskDataCursor other,
int maxTasks)
Merge the tasks from the given cursor with the tasks in this cursor, yielding a new cursor with a maximum of maxTasks tasks within it. |
Methods inherited from interface com.bea.wli.worklist.api.TaskInfoCursor |
---|
getCurrentPage, getTaskCount, getTaskInfos, getTotalPages, isAfterLast, isBeforeFirst, setCurrentPage |
Method Detail |
---|
TaskData[] getTasks() throws ManagementException, RemoteException
ManagementException
RemoteException
void merge(TaskDataCursor other, int maxTasks)
List<String> getTaskIds()
boolean hasNextPage()
boolean hasPreviousPage()
boolean isWithAffinity()
WorklistTaskQuery.getTaskDataCursorWithAffinity(TaskQuery, int)
boolean getIncludeTaskAssignee()
TaskQuery.getIncludeTaskAssignee()
,
WorklistTaskQuery.getTaskDataCursor(TaskQuery, int)
,
WorklistTaskQuery.getTaskDataCursorWithAffinity(TaskQuery, int)
boolean getIncludeTaskStepTimeEstimates()
TaskQuery.getIncludeTaskStepTimeEstimates()
,
WorklistTaskQuery.getTaskDataCursor(TaskQuery, int)
,
WorklistTaskQuery.getTaskDataCursorWithAffinity(TaskQuery, int)
boolean getIncludeTaskProperties()
TaskSelector.getIncludeTaskProperties()
,
WorklistTaskQuery.getTaskDataCursor(TaskQuery, int)
,
WorklistTaskQuery.getTaskDataCursorWithAffinity(TaskQuery, int)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |