Interface CompositionEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CompositionEnablerQuerySession, OsidSession, OsidSession

public interface CompositionEnablerSearchSession
extends CompositionEnablerQuerySession

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

getCompositionEnablersByQuery() is the basic search method and returns a list of CompositionEnablers. A more advanced search may be performed with getCompositionEnablersBySearch(). It accepts a CompositionEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCompositionEnablersBySearch() returns a CompositionEnablerSearchResults that can be used to access the resulting CompositionEnablerList or be used to perform a search within the result set through CompositionEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
CompositionEnablerQuery	getCompositionEnablerQueryFromInspector(CompositionEnablerQueryInspector compositionEnablerQueryInspector)	Gets a composition enabler query from an inspector.
CompositionEnablerSearchResults	getCompositionEnablersBySearch(CompositionEnablerQuery compositionEnablerQuery, CompositionEnablerSearch compositionEnablerSearch)	Gets the search results matching the given search query using the given search.
CompositionEnablerSearch	getCompositionEnablerSearch()	Gets a composition enabler search.
CompositionEnablerSearchOrder	getCompositionEnablerSearchOrder()	Gets a composition enabler search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CompositionEnablerQuerySession

canSearchCompositionEnablers, getCompositionEnablerQuery, getCompositionEnablersByQuery, getRepository, getRepositoryId, useFederatedRepositoryView, useIsolatedRepositoryView

Modifier and Type	Method	Description
boolean	canSearchCompositionEnablers()	Tests if this user can perform CompositionEnabler lookups.
CompositionEnablerQuery	getCompositionEnablerQuery()	Gets a composition enabler query.
CompositionEnablerList	getCompositionEnablersByQuery(CompositionEnablerQuery compositionEnablerQuery)	Gets a list of CompositionEnablers matching the given composition enabler query.
Repository	getRepository()	Gets the Repository associated with this session.
Id	getRepositoryId()	Gets the Repository Id associated with this session.
void	useFederatedRepositoryView()	Federates the view for methods in this session.
void	useIsolatedRepositoryView()	Isolates the view for methods in this session.

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

getCompositionEnablerSearch

CompositionEnablerSearch getCompositionEnablerSearch()

Gets a composition enabler search.

Returns:

the composition enabler search

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerSearchOrder

CompositionEnablerSearchOrder getCompositionEnablerSearchOrder()

Gets a composition enabler search order. The CompositionEnablerSearchOrder is supplied to a CompositionEnablerSearch to specify the ordering of results.

Returns:

the composition enabler search order

Compliance:

mandatory - This method must be implemented.

getCompositionEnablersBySearch

CompositionEnablerSearchResults getCompositionEnablersBySearch(CompositionEnablerQuery compositionEnablerQuery,
 CompositionEnablerSearch compositionEnablerSearch)
                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

compositionEnablerQuery - the composition enabler query

compositionEnablerSearch - the composition enabler search

Returns:

the returned search results

Throws:

NullArgumentException - compositionEnablerQuery or compositionEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - compositionEnablerQuery or compositionEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCompositionEnablerQueryFromInspector

CompositionEnablerQuery getCompositionEnablerQueryFromInspector(CompositionEnablerQueryInspector compositionEnablerQueryInspector)

Gets a composition enabler query from an inspector. The inspector is available from a CompositionEnablerSearchResults.

Parameters:

compositionEnablerQueryInspector - a composition enabler query inspector

Returns:

the composition enabler query

Throws:

NullArgumentException - compositionEnablerQueryInspector is null

UnsupportedException - compositionEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.