Interface CompositionSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CompositionQuerySession, OsidSession, OsidSession

public interface CompositionSearchSession
extends CompositionQuerySession

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

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

This session defines views that offer differing behaviors when searching.

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

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

Method Summary

Modifier and Type	Method	Description
CompositionQuery	getCompositionQueryFromInspector(CompositionQueryInspector compositionQueryInspector)	Gets a composition query from an inspector.
CompositionSearchResults	getCompositionsBySearch(CompositionQuery compositionQuery, CompositionSearch compositionSearch)	Gets the search results matching the given search query using the given search.
CompositionSearch	getCompositionSearch()	Gets a composition search.
CompositionSearchOrder	getCompositionSearchOrder()	Gets a composition search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CompositionQuerySession

canSearchCompositions, getCompositionQuery, getCompositionsByQuery, getRepository, getRepositoryId, useFederatedRepositoryView, useIsolatedRepositoryView, useSequesteredCompositionView, useUnsequesteredCompositionView

Modifier and Type	Method	Description
boolean	canSearchCompositions()	Tests if this user can perform Composition searches.
CompositionQuery	getCompositionQuery()	Gets a composition query.
CompositionList	getCompositionsByQuery(CompositionQuery compositionQuery)	Gets a list of Compositions matching the given composition 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.
void	useSequesteredCompositionView()	The methods in this session omit sequestered compositions.
void	useUnsequesteredCompositionView()	The methods in this session return all compositions, including sequestered compositions.

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

getCompositionSearch

CompositionSearch getCompositionSearch()

Gets a composition search.

Returns:

the composition search

Compliance:

mandatory - This method must be implemented.

getCompositionSearchOrder

CompositionSearchOrder getCompositionSearchOrder()

Gets a composition search order. The CompositionSearchOrder is supplied to an CompositionSearch to specify the ordering of results.

Returns:

the composition search order

Compliance:

mandatory - This method must be implemented.

getCompositionsBySearch

CompositionSearchResults getCompositionsBySearch(CompositionQuery compositionQuery,
 CompositionSearch compositionSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

compositionQuery - the composition query

compositionSearch - the composition search

Returns:

the composition search results

Throws:

NullArgumentException - compositionQuery or compositionSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - compositionQuery or compositionSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCompositionQueryFromInspector

CompositionQuery getCompositionQueryFromInspector(CompositionQueryInspector compositionQueryInspector)

Gets a composition query from an inspector. The inspector is available from a CompositionSearchResults .

Parameters:

compositionQueryInspector - a composition query inspector

Returns:

the composition query

Throws:

NullArgumentException - compositionQueryInspector is null

UnsupportedException - compositionQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.