OSID Logo
OSID Specifications
tracking rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.tracking.rules.QueueProcessorSearchSession
Implementsosid.tracking.rules.QueueProcessorQuerySession
Description

This session provides methods for searching among QueueProcessor objects. The search query is constructed using the QueueProcessoryQuery.

getQueueProcessorsByQuery() is the basic search method and returns a list of QueueProcessors. A more advanced search may be performed with getQueueProcessorsBySearch(). It accepts a QueueProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as tracking. getQueueProcessorsBySearch() returns a QueueProcessorSearchResults that can be used to access the resulting QueueProcessorList or be used to perform a search within the result set through QueueProcessorSearch.

This session defines views that offer differing behaviors for searching.

  • federated front office view: searches include queue processor in front office of which this front office matchmaker is an ancestor in the front office hierarchy
  • isolated front office view: searches are restricted to queue processor in this office

QueueProcessors may have a query record indicated by their respective record types. Thequery record is accessed via the QueueProcessorQuery.

MethodgetQueueProcessorSearch
Description

Gets a queue processor search.

Returnosid.tracking.rules.QueueProcessorSearchthe queue processor search
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorSearchOrder
Description

Gets a queue processor search order. The QueueProcessorSearchOrder is supplied to a QueueProcessorSearch to specify the ordering of results.

Returnosid.tracking.rules.QueueProcessorSearchOrderthe queue processor search order
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorsBySearch
Description

Gets the search results matching the given search query using the given search.

Parametersosid.tracking.rules.QueueProcessorQueryqueueProcessorQuerythe queue processor query
osid.tracking.rules.QueueProcessorSearchqueueProcessorSearchthe queue processor search
Returnosid.tracking.rules.QueueProcessorSearchResultsthe returned search results
ErrorsNULL_ARGUMENT queueProcessorQuery or queueProcessorSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED queueProcessorQuery or queueProcessorSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetQueueProcessorQueryFromInspector
Description

Gets a queue processor query from an inspector. The inspector is available from a QueueProcessorSearchResults.

Parametersosid.tracking.rules.QueueProcessorQueryInspectorqueueProcessorQueryInspectora queue processor query inspector
Returnosid.tracking.rules.QueueProcessorQuerythe queue processor query
ErrorsNULL_ARGUMENT queueProcessorQueryInspector is null
UNSUPPORTED queueProcessorQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.