Interface ActionGroupSearchSession

All Superinterfaces:

ActionGroupQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface ActionGroupSearchSession
extends ActionGroupQuerySession

This session provides methods for searching among ActionGroups . The search query is constructed using the ActionGroupQuery .

getActionGroupsByQuery() is the basic search method and returns a list of ActionGroups . A more advanced search may be performed with getActionGroupsBySearch() .It accepts an ActionGroupSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getActionGroupsBySearch() returns an ActionGroupSearchResults that can be used to access the resulting ActionGroupList or be used to perform a search within the result set through ActionGroupSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
ActionGroupQuery	getActionGroupQueryFromInspector(ActionGroupQueryInspector actuionGroupQueryInspector)	Gets an action group query from an inspector.
ActionGroupSearchResults	getActionGroupsBySearch(ActionGroupQuery actuionGroupQuery, ActionGroupSearch actionGroupSearch)	Gets the search results matching the given search query using the given search.
ActionGroupSearch	getActionGroupSearch()	Gets an action group search.
ActionGroupSearchOrder	getActionGroupSearchOrder()	Gets an action group search order.

Methods inherited from interface ActionGroupQuerySession

canSearchActionGroups, getActionGroupQuery, getActionGroupsByQuery, getSystem, getSystemId, useFederatedSystemView, useIsolatedSystemView

Modifier and Type	Method	Description
boolean	canSearchActionGroups()	Tests if this user can perform ActionGroup lookups.
ActionGroupQuery	getActionGroupQuery()	Gets an action group query.
ActionGroupList	getActionGroupsByQuery(ActionGroupQuery actuionGroupQuery)	Gets a list of ActionGroups matching the given action group query.
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

getActionGroupSearch

ActionGroupSearch getActionGroupSearch()

Gets an action group search.

Returns:

the action group search

Compliance:

mandatory - This method must be implemented.

getActionGroupSearchOrder

ActionGroupSearchOrder getActionGroupSearchOrder()

Gets an action group search order. The ActionGroupSearchOrder is supplied to an ActionGroupSearch to specify the ordering of results.

Returns:

the action group search order

Compliance:

mandatory - This method must be implemented.

getActionGroupsBySearch

ActionGroupSearchResults getActionGroupsBySearch(ActionGroupQuery actuionGroupQuery,
 ActionGroupSearch actionGroupSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

actuionGroupQuery - the action group query

actionGroupSearch - the action group search

Returns:

the returned search results

Throws:

NullArgumentException - actuionGroupQuery or actionGroupSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - actuionGroupQuery or actionGroupSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getActionGroupQueryFromInspector

ActionGroupQuery getActionGroupQueryFromInspector(ActionGroupQueryInspector actuionGroupQueryInspector)

Gets an action group query from an inspector. The inspector is available from an ActionGroupSearchResults .

Parameters:

actuionGroupQueryInspector - an action group query inspector

Returns:

the action group query

Throws:

NullArgumentException - actuionGroupQueryInspector is null

UnsupportedException - actuionGroupQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.