com.webmethods.portal.service.task

Class TaskSearchQueryV2

java.lang.Object

com.webmethods.portal.service.task.TaskSearchQuery

com.webmethods.portal.service.task.TaskSearchQueryV2

All Implemented Interfaces:

ITaskConstants, ITaskSearchQuery, ITaskSearchQueryExtended, Serializable

Direct Known Subclasses:

TaskInboxIndexedSearchContentProvider.InboxSearchQuery, TaskSearchQueryExtended, TaskSearchQueryV2

public class TaskSearchQueryV2
extends TaskSearchQuery

TaskSearchQueryV2 extends TaskSearchQuery. It adds properties to support paging and sorting.
This query should be used only for for indexed task searches. When using indexed searches you need to specify the sortField and sortOrder for the search results and also what range of tasks (page) return.

When indexed search result is used from table control on the page, it will automatically set paging and sorting parameters on the query from table control being used on the page.

If using query directly from java code then paging and sorting parameters should be explicitly set by caller

See Also:

Serialized Form

Field Summary

Fields inherited from class com.webmethods.portal.service.task.TaskSearchQuery

m_activeVoting, m_checkPermissions, m_doNotShowAcceptedByOthers, m_invocationID, m_maxResults, m_principalID, m_showNonActiveTasks, m_terms

Fields inherited from interface com.webmethods.portal.service.task.ITaskSearchQuery

OPERATOR_AND, OPERATOR_BETWEEN, OPERATOR_CONTAINS, OPERATOR_EQUALS, OPERATOR_EQUALS_OR_LESS, OPERATOR_EQUALS_OR_MORE, OPERATOR_IN, OPERATOR_IS_EMPTY, OPERATOR_IS_NOT_EMPTY, OPERATOR_IS_NOT_NULL, OPERATOR_IS_NULL, OPERATOR_LESS, OPERATOR_LIKE, OPERATOR_MORE, OPERATOR_NOT_EQUALS, OPERATOR_NOT_IN, OPERATOR_NOT_LIKE, OPERATOR_OR, SORT_ORDER_ASCENDING, SORT_ORDER_DESCENDING

Fields inherited from interface com.webmethods.portal.service.task.ITaskConstants

ACCEPT_OTHERS_RIGHT, ACCEPT_RIGHT, ASSIGN_RIGHT, ATTRIBUTE_CALLBACK_DATA, ATTRIBUTE_CALLBACK_SERVICE, ATTRIBUTE_RULE_SET, CALLBACK_TASK_CALLBACK_DATA, CALLBACK_TASK_COMPLETION_INFO, CALLBACK_TASK_DATA, CONFIG_PORTLET_ALIAS, DELETE_RIGHT, EDA_MASK_TASK_CREATED, EDA_MASK_TASK_DELETED, EDA_MASK_TASK_UPDATED, MODIFY_PERMISSION_RIGHT, MODIFY_TASK_DATA_RIGHT, MODIFY_TASK_INFO_RIGHT, OPERATION_ACCEPTED, OPERATION_CREATED, OPERATION_DELEGATION_RULE, OPERATION_DIST_FILTER_RULE, OPERATION_DIST_RULE, OPERATION_ERROR, OPERATION_RESUME, OPERATION_REVERTED, OPERATION_SCHEDULE_RULE, OPERATION_SUSPEND, OPERATION_TRIGGER_RULE, OPERATION_UNACCEPTED, OPERATION_UPDATE, PRIORITY_CRITICAL, PRIORITY_HIGH, PRIORITY_LOW, PRIORITY_MEDIUM, PRIORITY_NONE, PROCESS_AUDIT_POOL_NAME, PROCESS_PRE_TDE_STEP, PROPERTY_TASK_ID, PRT_STEP_CANCEL, PRT_STEP_COMPLETE, PRT_STEP_EXPIRE, PRT_STEP_FAIL, PRT_TASK_ANALYTICS_ENABLED, PRT_TASK_AUDIT_ENABLED, QUEUE_TASK_RIGHT, ROLLBACK_RIGHT, RULE_ATTR_BUSINESS_RULES, RULE_ATTR_CHECK_TIME, RULE_ATTR_DELEGATION_SOURCE, RULE_ATTR_DO_NOT_FIRE, RULE_ATTR_ERROR_CODE, RULE_ATTR_ERROR_MESSAGE, RULE_ATTR_EXPAND_ROLE_MEMBERS, RULE_ATTR_EXPIRING, RULE_ATTR_FIRE_ONCE, RULE_ATTR_FROM_TIMESTAMP, RULE_ATTR_PRINCIPAL_TYPES, RULE_ATTR_PRINCIPAL_TYPES_DELIM, RULE_ATTR_RESULT_TYPE, RULE_ATTR_RULE_SET, RULE_ATTR_RULE_TYPE, RULE_ATTR_RUNNING, RULE_ATTR_SCHEDULE_DATE_BEAN, RULE_ATTR_START_TIME, RULE_ATTR_TASK_DEF_URI, RULE_ATTR_TO_TIMESTAMP, RULE_ATTR_WORKLOAD_PROVIDER, RULE_ATTR_WORKLOAD_PROVIDER_TYPE, RULE_COMMENTS, RULE_CONTEXT_CHANGE_RULES, RULE_CONTEXT_ROUTING_RULES, RULE_CONTEXT_SYSTEM_OBJECT, RULE_CURRENT_TASK, RULE_CURRENT_TASK_EXTENDED, RULE_FACES_CONTEXT, RULE_NEW_CHILD_TASK, RULE_NEW_TASK, RULE_OLD_TASK, RULE_PARENT_TASK, RULE_PRINCIPAL, RULE_RESULT_CANCEL, RULE_RESULT_COMPLETE, RULE_RESULT_ERROR, RULE_RESULT_EXPIRE, RULE_RESULT_EXPRESSION, RULE_RESULT_LAST_ACCEPTED_BY, RULE_RESULT_PRINCIPALS, RULE_RESULT_REPLY, RULE_RESULT_STOP, RULE_ROLE, RULE_TYPE_CHANGE, RULE_TYPE_DELEGATION, RULE_TYPE_DISTRIBUTION, RULE_TYPE_FILTER, RULE_TYPE_SCHEDULE, RULE_USER, START_STOP_RIGHT, STATUS_ACTIVE, STATUS_CANCELLED, STATUS_COMPLETED, STATUS_ERROR, STATUS_EXPIRED, STATUS_NEW, STATUS_OUTDATED, STATUS_SCHEDULED, STATUS_SUSPENDED, STATUS_UNDEFINED, STORAGE_ROOT, STORAGE_TYPE_COLLABORATION_PROCESS, STORAGE_TYPE_NAME_COLLABORATION_PROCESS, STORAGE_TYPE_NAME_PREFIX, STORAGE_TYPE_NAME_PROCESS, STORAGE_TYPE_NAME_PROCESS_RULESET, STORAGE_TYPE_PATTERN, STORAGE_TYPE_PROCESS, STORAGE_TYPE_PROCESS_RULESET, STORAGE_TYPE_TASK, TASK_ATTACHMENTS_FOLDER, TASK_ATTACHMENTS_FOLDER_TYPE, TASK_ATTACHMENTS_RELATION, TASK_AUDIT_DELEGATED_BY, TASK_AUDIT_DIFFERENCE, TASK_AUDIT_PROPERTIES, TASK_AUDIT_VOTE, TASK_AUDIT_VOTING_FINISHED, TASK_COMMENTS_FOLDER, TASK_COMMENTS_FOLDER_TYPE, TASK_COMMENTS_RELATION, TASK_DATA_BINDING, TASK_DATA_BINDING_PREFIX, TASK_DATA_PROPERTY_PREFIX, TASK_DEFINITION_STORAGE, TASK_DETAILS_PAGE, TASK_DETAILS_PORTLET, TASK_FIELD_ACCEPT_BY_CSV, TASK_FIELD_ACCEPT_BY_NAME, TASK_FIELD_ACCEPT_BY_URI, TASK_FIELD_ACCEPTED_BY_CURRENT, TASK_FIELD_ACCEPTED_BY_LIST, TASK_FIELD_ASSIGNED_TO_CSV, TASK_FIELD_ASSIGNED_TO_LIST, TASK_FIELD_ASSIGNED_TO_NAME, TASK_FIELD_ASSIGNED_TO_URI, TASK_FIELD_ATTRIBUTES, TASK_FIELD_AUDIT_CONTEXT, TASK_FIELD_CHILD_TASK_COUNT, TASK_FIELD_COLLABORATION_PROCESS_ID, TASK_FIELD_COLLABORATION_STEP_ID, TASK_FIELD_CONTRIBUTED_BY_LIST, TASK_FIELD_CREATED_BY, TASK_FIELD_CREATED_BY_NAME, TASK_FIELD_CREATED_BY_URI, TASK_FIELD_CREATED_DATE, TASK_FIELD_CUSTOM_TASK_ID, TASK_FIELD_DELEGATED_FROM_LIST, TASK_FIELD_DELEGATED_TO_LIST, TASK_FIELD_DESCRIPTION, TASK_FIELD_ERROR_CODE, TASK_FIELD_ERROR_MESSAGE, TASK_FIELD_EXPIRE_DATE, TASK_FIELD_FOR_PROCESS, TASK_FIELD_IS_MANDATORY, TASK_FIELD_IS_VOTABLE, TASK_FIELD_LAST_ACCEPTED_BY, TASK_FIELD_LAST_ACCEPTED_BY_NAME, TASK_FIELD_LAST_ACCEPTED_DATE, TASK_FIELD_LAST_MODIFIED_BY, TASK_FIELD_LAST_MODIFIED_BY_NAME, TASK_FIELD_LAST_MODIFIED_BY_URI, TASK_FIELD_LAST_MODIFIED_DATE, TASK_FIELD_NAME, TASK_FIELD_PARENT_TASK_ID, TASK_FIELD_PRIORITY, TASK_FIELD_PRIORITY_NAME, TASK_FIELD_PROCESS_INSTANCE_ID, TASK_FIELD_PROCESS_ITERATION, TASK_FIELD_PROCESS_MODEL_ID, TASK_FIELD_PROCESS_MODEL_VERSION, TASK_FIELD_PROCESSED_RULES_LIST, TASK_FIELD_ROOT_PROCESS_INSTANCE_ID, TASK_FIELD_STATUS, TASK_FIELD_STATUS_NAME, TASK_FIELD_STEP_ID, TASK_FIELD_STEP_ITERATION, TASK_FIELD_TASK_DATA, TASK_FIELD_TASK_ID, TASK_FIELD_TASK_SCHEDULE_DATE, TASK_FIELD_TASK_TYPE_ID, TASK_FIELD_TASK_TYPE_NAME, TASK_FIELD_TASK_TYPE_URI, TASK_FIELD_TASK_URL, TASK_FIELD_UNACCEPT_FROM_NAME, TASK_FIELD_UNACCEPT_FROM_URI, TASK_FIELD_VERSION, TASK_GLOBAL_DISTRIBUTION_RULES, TASK_GLOBAL_SCHEDULE_RULES, TASK_GLOBAL_TRIGGER_RULES, TASK_INFO_BINDING, TASK_INFO_BINDING_PREFIX, TASK_OPERATION_ACCEPTED, TASK_OPERATION_ASSIGNMENT_CHANGED, TASK_OPERATION_ATTACHMENT_ADDED, TASK_OPERATION_ATTACHMENT_DELETED, TASK_OPERATION_ATTACHMENT_UPDATED, TASK_OPERATION_CANCEL, TASK_OPERATION_COMMENT_ADDED, TASK_OPERATION_COMMENT_DELETED, TASK_OPERATION_COMMENT_UPDATED, TASK_OPERATION_COMPLETE, TASK_OPERATION_CREATED, TASK_OPERATION_DELEGATION_CHANGED, TASK_OPERATION_DELEGATION_RULE_FIRED, TASK_OPERATION_DISTRIBUTION_RULE_FIRED, TASK_OPERATION_ERROR, TASK_OPERATION_EXPIRE, TASK_OPERATION_NOTIFICATION, TASK_OPERATION_REPLY, TASK_OPERATION_RESUME, TASK_OPERATION_REVERTED, TASK_OPERATION_ROLLEDBACK, TASK_OPERATION_SCHEDULE_RULE_FIRED, TASK_OPERATION_SINK_REQUEST, TASK_OPERATION_START, TASK_OPERATION_STOP, TASK_OPERATION_SUSPEND, TASK_OPERATION_TRIGGER_RULE_FIRED, TASK_OPERATION_UNACCEPTED, TASK_OPERATION_UNHANDLED_ERROR, TASK_OPERATION_UPDATE, TASK_OPERATION_VOTE, TASK_OPERATION_VOTING_STRATEGY_UPDATE, TASK_PRIORITY_CRITICAL, TASK_PRIORITY_HIGH, TASK_PRIORITY_LOW, TASK_PRIORITY_MEDIUM, TASK_PRIORITY_NONE, TASK_RULES_STORAGE, TASK_SEARCH_RAW_WHERE_CLAUSE, TASK_SEARCH_RAW_WHERE_CLAUSE_PREFIX, TASK_STATUS_ACTIVE, TASK_STATUS_CANCELLED, TASK_STATUS_COMPLETED, TASK_STATUS_ERROR, TASK_STATUS_EXPIRED, TASK_STATUS_NEW, TASK_STATUS_OUTDATED, TASK_STATUS_SCHEDULED, TASK_STATUS_SUSPENDED, TASK_STATUS_UNDEFINED, TASK_STORAGE, TASK_TABLE_TASK, TASK_TABLE_TASK_INBOX, TASK_TAGS, TASK_VOTING_STRATEGY_FIXED_NUMBER, TASK_VOTING_STRATEGY_PERCENTAGE, VIEW_TASK_AUDIT_RIGHT, VIEW_TASK_DATA_RIGHT, VIEW_TASK_INFO_RIGHT

Constructor Summary

Constructors

Constructor and Description
TaskSearchQueryV2() Default constructor.
TaskSearchQueryV2(TaskSearchQuery taskQuery)
TaskSearchQueryV2(TaskSearchQueryV2 taskQuery) Copy constructor

Method Summary

Modifier and Type	Method and Description
int	getFromIndex() Returns start index for search paging
String	getSortBy() Returns sortBy value.
String	getSortOrder() Returns sortOrder value.
int	getToIndex() Returns end index for search paging
void	setFromIndex(int fromIndex) Set start index for search paging
void	setSortBy(String sortBy) Sets sortBy value.
void	setSortOrder(String sortOrder) Set sort order.
void	setToIndex(int toIndex) Sets end index for search pageing
String	toString()

Methods inherited from class com.webmethods.portal.service.task.TaskSearchQuery

addQueryTerm, addQueryTerm, findTerm, findTerm, getInvocationID, getMaxResults, getPrincipalID, getSearchEngineType, getTerms, isActiveVoting, isCheckPermissions, isDoNotShowAcceptedByOthers, isShowNonActiveTasks, matches, matches, removeQueryTerm, reset, setActiveVoting, setCheckPermissions, setDoNotShowAcceptedByOthers, setInvocationID, setMaxResults, setPrincipalID, setSearchEngineType, setShowNonActiveTasks, setTerms, validate

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.webmethods.portal.service.task.ITaskSearchQueryExtended

getQueryAggregationInfo

Constructor Detail

TaskSearchQueryV2

public TaskSearchQueryV2()

Default constructor.

TaskSearchQueryV2

public TaskSearchQueryV2(TaskSearchQueryV2 taskQuery)

Copy constructor

TaskSearchQueryV2

public TaskSearchQueryV2(TaskSearchQuery taskQuery)

Method Detail

getSortBy

public String getSortBy()

Returns sortBy value.

Returns:

the comma-separated list of fields which are used for sorting. Defaults to null.

setSortBy

public void setSortBy(String sortBy)

Sets sortBy value.

Parameters:

sortBy - sort by value. This property contains single field name or comma-separated list of field names to sort search results For list of TaskInfo fields see ITaskSearchQuery. For sorting by indexed business data fields you need to specify index name as defined for the field.

getSortOrder

public String getSortOrder()

Returns sortOrder value.

Returns:

the comma-separated list of the sort orders, corresponding to the fields defined in ITaskSearchQueryExtended.getSortBy(). Defaults to null.

setSortOrder

public void setSortOrder(String sortOrder)

Set sort order. See ITaskSearchQuery.SORT_ORDER_ASCENDING and ITaskSearchQuery.SORT_ORDER_DESCENDING. When more than a single field is used for sorting (as comma-separated list of fields) then you have to specify a comma-separated list of sort order for each field to be sorted

Parameters:

sortOrder -

getFromIndex

public int getFromIndex()

Returns start index for search paging

Returns:

the start index for search paging, if any. Defaults to -1.

setFromIndex

public void setFromIndex(int fromIndex)

Set start index for search paging

Parameters:

fromIndex - start index value

getToIndex

public int getToIndex()

Returns end index for search paging

Returns:

the end index for search paging, if any. Defaults to -1.

setToIndex

public void setToIndex(int toIndex)

Sets end index for search pageing

Parameters:

toIndex - end index value

toString

public String toString()

Overrides:

toString in class TaskSearchQuery