org.osid.offering.rules

Interface CanonicalUnitProcessorSearchSession

All Superinterfaces:

java.lang.AutoCloseable, CanonicalUnitProcessorQuerySession, java.io.Closeable, OsidSession

public interface CanonicalUnitProcessorSearchSession
extends CanonicalUnitProcessorQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
CanonicalUnitProcessorQuery	getCanonicalUnitProcessorQueryFromInspector(CanonicalUnitProcessorQueryInspector canonicalUnitProcessorQueryInspector) Gets a canonical unit processor query from an inspector.
CanonicalUnitProcessorSearchResults	getCanonicalUnitProcessorsBySearch(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery, CanonicalUnitProcessorSearch canonicalUnitProcessorSearch) Gets the search results matching the given search query using the given search.
CanonicalUnitProcessorSearch	getCanonicalUnitProcessorSearch() Gets a canonical unit processor search.
CanonicalUnitProcessorSearchOrder	getCanonicalUnitProcessorSearchOrder() Gets a canonical unit processor search order.

Methods inherited from interface org.osid.offering.rules.CanonicalUnitProcessorQuerySession

canSearchCanonicalUnitProcessors, getCanonicalUnitProcessorQuery, getCanonicalUnitProcessorsByQuery, 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

getCanonicalUnitProcessorSearch

CanonicalUnitProcessorSearch getCanonicalUnitProcessorSearch()

Gets a canonical unit processor search.

Returns:

the canonical unit processor search

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorSearchOrder

CanonicalUnitProcessorSearchOrder getCanonicalUnitProcessorSearchOrder()

Gets a canonical unit processor search order. The CanonicalUnitProcessorSearchOrder is supplied to a CanonicalUnitProcessorSearch to specify the ordering of results.

Returns:

the canonical unit processor search order

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorsBySearch

CanonicalUnitProcessorSearchResults getCanonicalUnitProcessorsBySearch(CanonicalUnitProcessorQuery canonicalUnitProcessorQuery,
                                                                     CanonicalUnitProcessorSearch canonicalUnitProcessorSearch)
                                                                       throws OperationFailedException,
                                                                              PermissionDeniedException

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

Parameters:

canonicalUnitProcessorQuery - the canonical unit processor query

canonicalUnitProcessorSearch - the canonical unit processor search

Returns:

the returned search results

Throws:

NullArgumentException - canonicalUnitProcessorQuery or canonicalUnitProcessorSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - canonicalUnitProcessorQuery or canonicalUnitProcessorSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCanonicalUnitProcessorQueryFromInspector

CanonicalUnitProcessorQuery getCanonicalUnitProcessorQueryFromInspector(CanonicalUnitProcessorQueryInspector canonicalUnitProcessorQueryInspector)

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

Parameters:

canonicalUnitProcessorQueryInspector - a canonical unit processor query inspector

Returns:

the canonical unit processor query

Throws:

NullArgumentException - canonicalUnitProcessorQueryInspector is null

UnsupportedException - canonicalUnitProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.