Interface ActionEnablerSearchSession

All Superinterfaces:

ActionEnablerQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface ActionEnablerSearchSession
extends ActionEnablerQuerySession

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

getActionEnablersByQuery() is the basic search method and returns a list of ActionEnablers . A more advanced search may be performed with getActionEnablersBySearch() .It accepts an ActionEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as control. getActionEnablersBySearch() returns an ActionEnablerSearchResults that can be used to access the resulting ActionEnablerList or be used to perform a search within the result set through ActionEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
ActionEnablerQuery	getActionEnablerQueryFromInspector(ActionEnablerQueryInspector actionEnablerQueryInspector)	Gets an action enabler query from an inspector.
ActionEnablerSearchResults	getActionEnablersBySearch(ActionEnablerQuery actionEnablerQuery, ActionEnablerSearch actionEnablerSearch)	Gets the search results matching the given search query using the given search.
ActionEnablerSearch	getActionEnablerSearch()	Gets an action enabler search.
ActionEnablerSearchOrder	getActionEnablerSearchOrder()	Gets an action enabler search order.

Methods inherited from interface ActionEnablerQuerySession

canSearchActionEnablers, getActionEnablerQuery, getActionEnablersByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchActionEnablers()	Tests if this user can perform ActionEnabler lookups.
ActionEnablerQuery	getActionEnablerQuery()	Gets an action enabler query.
ActionEnablerList	getActionEnablersByQuery(ActionEnablerQuery actionEnablerQuery)	Gets a list of ActionEnablers matching the given search.
System	getSystem()	Gets the System associated with this session.
Id	getSystemId()	Gets the System Id associated with this session.
void	useFederatedSystemView()	Federates the view for methods in this session.
void	useIsolatedSystemView()	Isolates the view for methods in this session.

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.

Method Details

getActionEnablerSearch

ActionEnablerSearch getActionEnablerSearch()

Gets an action enabler search.

Returns:

the action enabler search

Compliance:

mandatory - This method must be implemented.

getActionEnablerSearchOrder

ActionEnablerSearchOrder getActionEnablerSearchOrder()

Gets an action enabler search order. The ActionEnablerSearchOrder is supplied to an ActionEnablerSearch to specify the ordering of results.

Returns:

the action enabler search order

Compliance:

mandatory - This method must be implemented.

getActionEnablersBySearch

ActionEnablerSearchResults getActionEnablersBySearch(ActionEnablerQuery actionEnablerQuery,
 ActionEnablerSearch actionEnablerSearch)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

actionEnablerQuery - the action enabler query

actionEnablerSearch - the action enabler search

Returns:

the returned search results

Throws:

NullArgumentException - actionEnablerQuery or actionEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - actionEnablerQuery or actionEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getActionEnablerQueryFromInspector

ActionEnablerQuery getActionEnablerQueryFromInspector(ActionEnablerQueryInspector actionEnablerQueryInspector)

Gets an action enabler query from an inspector. The inspector is available from an ActionEnablerSearchResults .

Parameters:

actionEnablerQueryInspector - an action enabler query inspector

Returns:

the action enabler query

Throws:

NullArgumentException - actionEnablerQueryInspector is null

UnsupportedException - actionEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.