org.osid.offering.rules

Interface CanonicalUnitProcessorEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, CanonicalUnitProcessorEnablerQuerySession, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.offering.rules.CanonicalUnitProcessorEnablerQuerySession

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

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.