org.osid.control

Interface TriggerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession, TriggerQuerySession

public interface TriggerSearchSession
extends TriggerQuerySession

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.

Method Summary

Methods

Modifier and Type	Method and Description
TriggerQuery	getTriggerQueryFromInspector(TriggerQueryInspector triggerQueryInspector) Gets a trigger query from an inspector.
TriggerSearchResults	getTriggersBySearch(TriggerQuery triggerQuery, TriggerSearch triggerSearch) Gets the search results matching the given search query using the given search.
TriggerSearch	getTriggerSearch() Gets a trigger search.
TriggerSearchOrder	getTriggerSearchOrder() Gets a trigger search order.

Methods inherited from interface org.osid.control.TriggerQuerySession

canSearchTriggers, getSystem, getSystemId, getTriggerQuery, getTriggersByQuery, useFederatedSystemView, useIsolatedSystemView

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getTriggerSearch

TriggerSearch getTriggerSearch()

Gets a trigger search.

Returns:

the trigger search

Compliance:

mandatory - This method must be implemented.

getTriggerSearchOrder

TriggerSearchOrder getTriggerSearchOrder()

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

Returns:

the trigger search order

Compliance:

mandatory - This method must be implemented.

getTriggersBySearch

TriggerSearchResults getTriggersBySearch(TriggerQuery triggerQuery,
                                       TriggerSearch triggerSearch)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

triggerQuery - the trigger query

triggerSearch - the trigger search

Returns:

the returned search results

Throws:

NullArgumentException - triggerQuery or triggerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - triggerQuery or triggerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getTriggerQueryFromInspector

TriggerQuery getTriggerQueryFromInspector(TriggerQueryInspector triggerQueryInspector)

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

Parameters:

triggerQueryInspector - a trigger query inspector

Returns:

the trigger query

Throws:

NullArgumentException - triggerQueryInspector is null

UnsupportedException - triggerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.