org.osid.control.rules

Interface TriggerEnablerSearchSession

All Superinterfaces:

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

public interface TriggerEnablerSearchSession
extends TriggerEnablerQuerySession

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

getTriggerEnablersByQuery() is the basic search method and returns a list of TriggerEnablers. A more advanced search may be performed with getTriggerEnablersBySearch(). It accepts a TriggerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. getTriggerEnablersBySearch() returns a TriggerEnablerSearchResults that can be used to access the resulting TriggerEnablerList or be used to perform a search within the result set through TriggerEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
TriggerEnablerQuery	getTriggerEnablerQueryFromInspector(TriggerEnablerQueryInspector triggerEnablerQueryInspector) Gets a trigger enabler query from an inspector.
TriggerEnablerSearchResults	getTriggerEnablersBySearch(TriggerEnablerQuery triggerEnablerQuery, TriggerEnablerSearch triggerEnablerSearch) Gets the search results matching the given search query using the given search.
TriggerEnablerSearch	getTriggerEnablerSearch() Gets a trigger enabler search.
TriggerEnablerSearchOrder	getTriggerEnablerSearchOrder() Gets a trigger enabler search order.

Methods inherited from interface org.osid.control.rules.TriggerEnablerQuerySession

canSearchTriggerEnablers, getSystem, getSystemId, getTriggerEnablerQuery, getTriggerEnablersByQuery, 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

getTriggerEnablerSearch

TriggerEnablerSearch getTriggerEnablerSearch()

Gets a trigger enabler search.

Returns:

the trigger enabler search

Compliance:

mandatory - This method must be implemented.

getTriggerEnablerSearchOrder

TriggerEnablerSearchOrder getTriggerEnablerSearchOrder()

Gets a trigger enabler search order. The TriggerEnablerSearchOrder is supplied to a TriggerEnablerSearch to specify the ordering of results.

Returns:

the trigger enabler search order

Compliance:

mandatory - This method must be implemented.

getTriggerEnablersBySearch

TriggerEnablerSearchResults getTriggerEnablersBySearch(TriggerEnablerQuery triggerEnablerQuery,
                                                     TriggerEnablerSearch triggerEnablerSearch)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

triggerEnablerQuery - the trigger enabler query

triggerEnablerSearch - the trigger enabler search

Returns:

the returned search results

Throws:

NullArgumentException - triggerEnablerQuery or triggerEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - triggerEnablerQuery or triggerEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getTriggerEnablerQueryFromInspector

TriggerEnablerQuery getTriggerEnablerQueryFromInspector(TriggerEnablerQueryInspector triggerEnablerQueryInspector)

Gets a trigger enabler query from an inspector. The inspector is available from a TriggerEnablerSearchResults.

Parameters:

triggerEnablerQueryInspector - a trigger enabler query inspector

Returns:

the trigger enabler query

Throws:

NullArgumentException - triggerEnablerQueryInspector is null

UnsupportedException - triggerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.