Interface TriggerEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface TriggerEnablerQuerySession

canSearchTriggerEnablers, getSystem, getSystemId, getTriggerEnablerQuery, getTriggerEnablersByQuery, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchTriggerEnablers()	Tests if this user can perform TriggerEnabler lookups.
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
TriggerEnablerQuery	getTriggerEnablerQuery()	Gets a trigger enabler query.
TriggerEnablerList	getTriggerEnablersByQuery(TriggerEnablerQuery triggerEnablerQuery)	Gets a list of TriggerEnablers matching the given search.
void	useFederatedSystemView()	Federates the view for methods in this session.
void	useIsolatedSystemView()	Isolates the view for methods in this session.

Method Details

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.