|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.bea.wli.worklist.api.ui.TaskListViewInfo
public abstract class TaskListViewInfo
Utility class describing a unique view of tasks available in the worklist system. Each instance of this class has a display label, and a key representing a unique identifier for the view. This key should be passed to the calling page flow taskUIShowTaskListAction(String view) action method.
Field Summary | |
---|---|
static int |
DEFAULT_MAX_TASKS
|
static int |
DEFAULT_MAX_TASKS_PER_PAGE
|
Constructor Summary | |
---|---|
TaskListViewInfo()
|
|
TaskListViewInfo(String key,
String label)
|
Method Summary | |
---|---|
protected String |
formatDate(Date date)
|
int |
getCursorBatchSize()
|
TaskListCustomParams |
getCustomCriteria()
|
DateFormat |
getDateFormat()
|
String |
getKey()
The key to identify in the view map. |
String |
getLabel()
Label to be shown on the task list page. |
int |
getMaxTasks()
Get a hint for how many tasks should be returned by this view. |
protected TaskListCustomParams |
getOrCreateCustomCriteria()
|
String |
getSampleDateStr()
|
abstract TaskDataCursor |
getTasksInView(String userName,
TaskQuery query,
WorklistContext context)
Get a cursor over tasks in this view. |
TaskDataCursor |
getTasksInView(String userName,
TaskQuery query,
WorklistContext context,
TaskListCustomParams customCriteria)
Get a cursor over tasks in this view using custom parameters in the customCriteria parameter. |
boolean |
isPredefined()
Return true for those task list view infos that are predefined and auto-created added by worklist system, like |
boolean |
isShowOnTaskListPage()
If set to true the task list page will have an option to view this task list view. |
protected Date |
parseDate(String dateStr)
|
protected String |
replaceAsteriskWithPercent(String searchByOrg)
|
void |
setCursorBatchSize(int cursorBatchSize)
|
void |
setCustomCriteria(TaskListCustomParams customCriteria)
|
void |
setDateFormat(DateFormat dateFormat)
|
void |
setIsPredefined(boolean predefined)
|
void |
setKey(String key)
|
void |
setLabel(String label)
|
void |
setMaxTasks(int maxTasks)
Set a hint for how many tasks should be returned by this view. |
void |
setMaxTasks(int maxTasks,
boolean preserve)
Set a hint for how many tasks should be returned by this view. |
void |
setShowOnTaskListPage(boolean showOnTaskListPage)
|
protected TaskQuery |
updateQuery(TaskListCustomParams customCriteria,
TaskQuery query)
Helper class to extended the task view query with the custom criteria. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int DEFAULT_MAX_TASKS
public static final int DEFAULT_MAX_TASKS_PER_PAGE
Constructor Detail |
---|
public TaskListViewInfo()
public TaskListViewInfo(String key, String label)
Method Detail |
---|
public String getKey()
public void setKey(String key)
public String getLabel()
public void setLabel(String label)
public boolean isShowOnTaskListPage()
public void setShowOnTaskListPage(boolean showOnTaskListPage)
public int getMaxTasks()
public void setMaxTasks(int maxTasks)
public void setMaxTasks(int maxTasks, boolean preserve)
public int getCursorBatchSize()
public void setCursorBatchSize(int cursorBatchSize)
public boolean isPredefined()
public void setIsPredefined(boolean predefined)
public TaskListCustomParams getCustomCriteria()
public void setCustomCriteria(TaskListCustomParams customCriteria)
protected TaskListCustomParams getOrCreateCustomCriteria()
public DateFormat getDateFormat()
public void setDateFormat(DateFormat dateFormat)
protected Date parseDate(String dateStr) throws ParseException
ParseException
protected String formatDate(Date date)
public String getSampleDateStr()
public abstract TaskDataCursor getTasksInView(String userName, TaskQuery query, WorklistContext context) throws Exception
userName
- query
- context
-
Exception
public TaskDataCursor getTasksInView(String userName, TaskQuery query, WorklistContext context, TaskListCustomParams customCriteria) throws Exception
userName
- query
- context
- customCriteria
-
Exception
protected TaskQuery updateQuery(TaskListCustomParams customCriteria, TaskQuery query)
customCriteria
- query
-
protected String replaceAsteriskWithPercent(String searchByOrg)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |