Interface CanonicalUnitProcessorEnablerSearchSession

All Superinterfaces:

AutoCloseable, CanonicalUnitProcessorEnablerQuerySession, Closeable, OsidSession, OsidSession

public interface CanonicalUnitProcessorEnablerSearchSession
extends CanonicalUnitProcessorEnablerQuerySession

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

getCanonicalUnitProcessorEnablersByQuery() is the basic search method and returns a list of CanonicalUnitProcessorEnablers . A more advanced search may be performed with getCanonicalUnitProcessorEnablersBySearch() .It accepts a CanonicalUnitProcessorEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as offering. getCanonicalUnitProcessorEnablersBySearch() returns a CanonicalUnitProcessorEnablerSearchResults that can be used to access the resulting CanonicalUnitProcessorEnablerList or be used to perform a search within the result set through CanonicalUnitProcessorEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
CanonicalUnitProcessorEnablerQuery	getCanonicalUnitProcessorEnablerQueryFromInspector(CanonicalUnitProcessorEnablerQueryInspector canonicalUnitProcessorEnablerQueryInspector)	Gets a canonical unit processor enabler query from an inspector.
CanonicalUnitProcessorEnablerSearchResults	getCanonicalUnitProcessorEnablersBySearch(CanonicalUnitProcessorEnablerQuery canonicalUnitProcessorEnablerQuery, CanonicalUnitProcessorEnablerSearch canonicalUnitProcessorEnablerSearch)	Gets the search results matching the given search query using the given search.
CanonicalUnitProcessorEnablerSearch	getCanonicalUnitProcessorEnablerSearch()	Gets a canonical unit processor enabler search.
CanonicalUnitProcessorEnablerSearchOrder	getCanonicalUnitProcessorEnablerSearchOrder()	Gets a canonical unit processor enabler search order.

Methods inherited from interface CanonicalUnitProcessorEnablerQuerySession

canSearchCanonicalUnitProcessorEnablers, getCanonicalUnitProcessorEnablerQuery, getCanonicalUnitProcessorEnablersByQuery, getCatalogue, getCatalogueId, useFederatedCatalogueView, useIsolatedCatalogueView

Modifier and Type	Method	Description
boolean	canSearchCanonicalUnitProcessorEnablers()	Tests if this user can perform CanonicalUnitProcessorEnabler lookups.
CanonicalUnitProcessorEnablerQuery	getCanonicalUnitProcessorEnablerQuery()	Gets a canonical unit processor enabler query.
CanonicalUnitProcessorEnablerList	getCanonicalUnitProcessorEnablersByQuery(CanonicalUnitProcessorEnablerQuery canonicalUnitProcessorEnablerQuery)	Gets a list of CanonicalUnitProcessorEnablers matching the given search.
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

getCanonicalUnitProcessorEnablerSearch

CanonicalUnitProcessorEnablerSearch getCanonicalUnitProcessorEnablerSearch()

Gets a canonical unit processor enabler search.

Returns:

the canonical unit processor enabler search

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorEnablerSearchOrder

CanonicalUnitProcessorEnablerSearchOrder getCanonicalUnitProcessorEnablerSearchOrder()

Gets a canonical unit processor enabler search order. The CanonicalUnitProcessorEnablerSearchOrder is supplied to a CanonicalUnitProcessorEnablerSearch to specify the ordering of results.

Returns:

the canonical unit processor enabler search order

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorEnablersBySearch

CanonicalUnitProcessorEnablerSearchResults getCanonicalUnitProcessorEnablersBySearch(CanonicalUnitProcessorEnablerQuery canonicalUnitProcessorEnablerQuery,
 CanonicalUnitProcessorEnablerSearch canonicalUnitProcessorEnablerSearch)
                                                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

canonicalUnitProcessorEnablerQuery - the canonical unit processor enabler query

canonicalUnitProcessorEnablerSearch - the canonical unit processor enabler search

Returns:

the returned search results

Throws:

NullArgumentException - canonicalUnitProcessorEnablerQuery or canonicalUnitProcessorEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - canonicalUnitProcessorEnablerQuery or canonicalUnitProcessorEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorEnablerQueryFromInspector

CanonicalUnitProcessorEnablerQuery getCanonicalUnitProcessorEnablerQueryFromInspector(CanonicalUnitProcessorEnablerQueryInspector canonicalUnitProcessorEnablerQueryInspector)

Gets a canonical unit processor enabler query from an inspector. The inspector is available from a CanonicalUnitProcessorEnablerSearchResults .

Parameters:

canonicalUnitProcessorEnablerQueryInspector - a canonical unit processor enabler query inspector

Returns:

the canonical unit processor enabler query

Throws:

NullArgumentException - canonicalUnitProcessorEnablerQueryInspector is null

UnsupportedException - canonicalUnitProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.