com.webmethods.portal.service.task

Interface ITaskSearchQueryExtended

All Superinterfaces:

ITaskConstants, ITaskSearchQuery

All Known Subinterfaces:

ITaskSearchQueryExtended

All Known Implementing Classes:

TaskInboxHpstraSearchContentProvider.HpstraInboxSearchQuery, TaskInboxIndexedSearchContentProvider.InboxSearchQuery, TaskInboxSearchContentProvider.InboxSearchQuery, TaskSearchQuery, TaskSearchQuery, TaskSearchQueryExtended, TaskSearchQueryV2, TaskSearchQueryV2

public interface ITaskSearchQueryExtended
extends ITaskSearchQuery

Interface, providing functionality for working with task search queries. Supports multiple task search query terms, paging, sorting, aggregation. The search engine can also be specified.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
TaskSearchQueryTerm	findTerm(String fieldName) Find the search term based on the fieldName specified.
TaskSearchQueryTerm	findTerm(String fieldName, String operator) Find the search term based on the field name and operator specified.
default int	getFromIndex()
long	getInvocationID()
int	getMaxResults()
String	getPrincipalID()
default IQueryAggregationInfo	getQueryAggregationInfo()
String	getSearchEngineType()
default String	getSortBy()
default String	getSortOrder()
TaskSearchQueryTerm[]	getTerms() Returns search query terms.
default int	getToIndex()
boolean	isActiveVoting()
boolean	isCheckPermissions()
boolean	isDoNotShowAcceptedByOthers()
boolean	isShowNonActiveTasks()
boolean	matches(FacesContext facesContext) Evaluates query against task set on facesContext.
void	reset() Resets a query before search.
void	validate() Validates this query, throws any exception if query is not valid.

Method Detail

getMaxResults

int getMaxResults()

Returns:

the max results to be returned. Default to -1, means no maximum is set. This is ignored when using task indexed searches. For indexed searches full count is always determined and only current page is returned.

isShowNonActiveTasks

boolean isShowNonActiveTasks()

Returns:

flag to show non active tasks in the search result. This only valid for inbox type searches. See ITaskSearchContentProvider#setSearchInbox(boolean).

isCheckPermissions

boolean isCheckPermissions()

Returns:

flag if current user permission should be checked for the task searches

getTerms

TaskSearchQueryTerm[] getTerms()

Returns search query terms.

Returns:

array of search terms

findTerm

TaskSearchQueryTerm findTerm(String fieldName,
                             String operator)

Find the search term based on the field name and operator specified. Return null if there is no match.

Parameters:

fieldName - field name to search

operator - operator to search

Returns:

found search term or null

findTerm

TaskSearchQueryTerm findTerm(String fieldName)

Find the search term based on the fieldName specified. Return null if there is no match.

Parameters:

fieldName - field name to find term for

Returns:

search term or null. It there are more than one term for the same field name it will return only the first term

getPrincipalID

String getPrincipalID()

Returns:

the principal id whose inbox should be searched. If null then current user is assumed.

matches

boolean matches(FacesContext facesContext)
         throws Exception

Evaluates query against task set on facesContext. This calls into TaskSearchQueryTerm.matches(FacesContext) for every term defined for this task. Some terms may implement a search in the database (for most TaskInfo fields). If term implements its search in the database, then this term is ignored as it already been evaluated.

Parameters:

facesContext - current facesContext. The current task is available on the context by #{currentTask} binding expression

Returns:

true if all terms from this query match the current task

Throws:

Exception - if any exception occurs during the operation execution

reset

void reset()

Resets a query before search. This needs to be called if the same query is used multiple times for different searches (e.g. only modifying search terms values).

validate

void validate()
       throws Exception

Validates this query, throws any exception if query is not valid.

Throws:

Exception - if the query is invalid

isDoNotShowAcceptedByOthers

boolean isDoNotShowAcceptedByOthers()

Returns:

whether query should display tasks accepted by other principals

getInvocationID

long getInvocationID()

Returns:

ID of the search invocation.

getSearchEngineType

String getSearchEngineType()

Returns:

the engine type, which will be referenced when a search is performed. More information can be found here IndexEngineType and here. Custom search engines can be defined as well.

getSortBy

default String getSortBy()

Returns:

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

getSortOrder

default String getSortOrder()

Returns:

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

getFromIndex

default int getFromIndex()

Returns:

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

getToIndex

default int getToIndex()

Returns:

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

getQueryAggregationInfo

default IQueryAggregationInfo getQueryAggregationInfo()

Returns:

the aggregation information for this query, if any. Defaults to null.

isActiveVoting

boolean isActiveVoting()

Returns:

returns true if search must include active voting tasks only (with at least one vote)