Interface CanonicalUnitSearchSession

All Superinterfaces:

AutoCloseable, CanonicalUnitQuerySession, Closeable, OsidSession, OsidSession

public interface CanonicalUnitSearchSession
extends CanonicalUnitQuerySession

This session provides methods for searching CanonicalUnits . The search query is constructed using the CanonicalUnitQuery . The canonical unit record Type also specifies the record for the canonical unit query.

getCanonicalUnitsByQuery() is the basic search method and returns a list of CanonicalUnit elements. A more advanced search may be performed with getCanonicalUnitsBySearch() . It accepts a CanonicalUnitSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getCanonicalUnitsBySearch() returns a CanonicalUnitSearchResults that can be used to access the resulting CanonicalUnitList or be used to perform a search within the result set through CanonicalUnitSearch .

This session defines views that offer differing behaviors for searching.

• federated catalogue view: searches include canonical units in catalogues of which this catalogue is an ancestor in the catalogue hierarchy
• isolated catalogue view: searches are restricted to canonical units in this catalogue

CanonicalUnits may have a query record indicated by their respective record types. The query record is accessed via the CanonicalUnitQuery . The returns in this session may not be cast directly to these interfaces.

Method Summary

Modifier and Type	Method	Description
CanonicalUnitQuery	getCanonicalUnitQueryFromInspector(CanonicalUnitQueryInspector canonicalUnitQueryInspector)	Gets a canonical unit query from an inspector.
CanonicalUnitSearchResults	getCanonicalUnitsBySearch(CanonicalUnitQuery canonicalUnitQuery, CanonicalUnitSearch canonicalUnitSearch)	Gets the search results matching the given search.
CanonicalUnitSearch	getCanonicalUnitSearch()	Gets a canonical unit search.
CanonicalUnitSearchOrder	getCanonicalUnitSearchOrder()	Gets a canonical unit search order.

Methods inherited from interface CanonicalUnitQuerySession

canSearchCanonicalUnits, getCanonicalUnitQuery, getCanonicalUnitsByQuery, getCatalogue, getCatalogueId, useFederatedCatalogueView, useIsolatedCatalogueView

Modifier and Type	Method	Description
boolean	canSearchCanonicalUnits()	Tests if this user can perform CanonicalUnit searches.
CanonicalUnitQuery	getCanonicalUnitQuery()	Gets a canonical unit query.
CanonicalUnitList	getCanonicalUnitsByQuery(CanonicalUnitQuery canonicalUnitQuery)	Gets a list of canonical units matching the given canonical unit query.
Catalogue	getCatalogue()	Gets the Catalogue associated with this session.
Id	getCatalogueId()	Gets the Catalogue Id associated with this session.
void	useFederatedCatalogueView()	Federates the view for methods in this session.
void	useIsolatedCatalogueView()	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

getCanonicalUnitSearch

CanonicalUnitSearch getCanonicalUnitSearch()

Gets a canonical unit search.

Returns:

the canonical unit search

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitSearchOrder

CanonicalUnitSearchOrder getCanonicalUnitSearchOrder()

Gets a canonical unit search order. The CanonicalUnitSearchOrder is supplied to a CanonicalUnitSearch to specify the ordering of results.

Returns:

the canonical unit search order

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitsBySearch

CanonicalUnitSearchResults getCanonicalUnitsBySearch(CanonicalUnitQuery canonicalUnitQuery,
 CanonicalUnitSearch canonicalUnitSearch)
                                              throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search.

Parameters:

canonicalUnitQuery - the canonical unit query

canonicalUnitSearch - the canonical unit search

Returns:

the search results

Throws:

NullArgumentException - canonicalUnitQuery or canonicalUnitSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - canonicalUnitQuery or canonicalUnitSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitQueryFromInspector

CanonicalUnitQuery getCanonicalUnitQueryFromInspector(CanonicalUnitQueryInspector canonicalUnitQueryInspector)

Gets a canonical unit query from an inspector. The inspector is available from a CanonicalUnitSearchResults .

Parameters:

canonicalUnitQueryInspector - a canonical unit query inspector

Returns:

the canonical unit query

Throws:

NullArgumentException - canonicalUnitQueryInspector is null

UnsupportedException - canonicalUnitQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.