OSID Logo
OSID Specifications
control package
Version 3.0.0
Release Candidate Preview
Interfaceosid.control.TriggerSearchSession
Implementsosid.control.TriggerQuerySession
Description

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

getTriggersByQuery() is the basic search method and returns a list of Triggers. A more advanced search may be performed with getTriggersBySearch(). It accepts a TriggerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getTriggersBySearch() returns a TriggerSearchResults that can be used to access the resulting TriggerList or be used to perform a search within the result set through TriggerSearch.

This session defines views that offer differing behaviors for searching.

  • federated system view: searches include triggers in systems of which this system is an ancestor in the system hierarchy
  • isolated system view: searches are restricted to triggers in this system

Triggers may have a query record indicated by their respective record types. The query record is accessed via the TriggerQuery.

MethodgetTriggerSearch
Description

Gets a trigger search.

Returnosid.control.TriggerSearchthe trigger search
CompliancemandatoryThis method must be implemented.
MethodgetTriggerSearchOrder
Description

Gets a trigger search order. The TriggerSearchOrder is supplied to a TriggerSearch to specify the ordering of results.

Returnosid.control.TriggerSearchOrderthe trigger search order
CompliancemandatoryThis method must be implemented.
MethodgetTriggersBySearch
Description

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

Parametersosid.control.TriggerQuerytriggerQuerythe trigger query
osid.control.TriggerSearchtriggerSearchthe trigger search
Returnosid.control.TriggerSearchResultsthe returned search results
ErrorsNULL_ARGUMENT triggerQuery or triggerSearch is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED triggerQuery or triggerSearch is not of this service
CompliancemandatoryThis method must be implemented.
MethodgetTriggerQueryFromInspector
Description

Gets a trigger query from an inspector. The inspector is available from a TriggerSearchResults.

Parametersosid.control.TriggerQueryInspectortriggerQueryInspectora trigger query inspector
Returnosid.control.TriggerQuerythe trigger query
ErrorsNULL_ARGUMENT triggerQueryInspector is null
UNSUPPORTED triggerQueryInspector is not of this service
CompliancemandatoryThis method must be implemented.