org.osid.course.requisite

Interface RequisiteSearchSession

All Superinterfaces:

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

public interface RequisiteSearchSession
extends RequisiteQuerySession

This session provides methods for searching among Requisites. The search query is constructed using the RequisiteQuery.

getRequisitesByQuery() is the basic search method and returns a list of Requisites. A more advanced search may be performed with getRequisitesBySearch(). It accepts a RequisiteSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getRequisitesBySearch() returns a RequisiteSearchResults that can be used to access the resulting RequisiteList or be used to perform a search within the result set through RequisiteSearch.

This session defines views that offer differing behaviors for searching.

• federated course catalog view: searches include requisites in course catalogs of which this course catalog is an ancestor in the course catalog hierarchy
• isolated course catalog view: searches are restricted to courses in this course catalog

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

Method Summary

Methods

Modifier and Type	Method and Description
RequisiteQuery	getRequisiteQueryFromInspector(RequisiteQueryInspector requisiteQueryInspector) Gets a requisite query from an inspector.
RequisiteSearchResults	getRequisitesBySearch(RequisiteQuery requisiteQuery, RequisiteSearch requisiteSearch) Gets the search results matching the given search query using the given search.
RequisiteSearch	getRequisiteSearch() Gets a requisite search.
RequisiteSearchOrder	getRequisiteSearchOrder() Gets a requisite search order.

Methods inherited from interface org.osid.course.requisite.RequisiteQuerySession

canSearchRequisites, getCourseCatalog, getCourseCatalogId, getRequisiteQuery, getRequisitesByQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView, useSequesteredRequisiteView, useUnsequesteredRequisiteView

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

getRequisiteSearch

RequisiteSearch getRequisiteSearch()

Gets a requisite search.

Returns:

the requisite search

Compliance:

mandatory - This method must be implemented.

getRequisiteSearchOrder

RequisiteSearchOrder getRequisiteSearchOrder()

Gets a requisite search order. The RequisiteSearchOrder is supplied to a RequisiteSearch to specify the ordering of results.

Returns:

the requisite search order

Compliance:

mandatory - This method must be implemented.

getRequisitesBySearch

RequisiteSearchResults getRequisitesBySearch(RequisiteQuery requisiteQuery,
                                           RequisiteSearch requisiteSearch)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

requisiteQuery - the requisite query

requisiteSearch - the requisite search

Returns:

the requisite search results

Throws:

NullArgumentException - requisiteQuery or requisiteSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - requisiteQuery or requisiteSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getRequisiteQueryFromInspector

RequisiteQuery getRequisiteQueryFromInspector(RequisiteQueryInspector requisiteQueryInspector)

Gets a requisite query from an inspector. The inspector is available from a RequisiteSearchResults.

Parameters:

requisiteQueryInspector - a requisite query inspector

Returns:

the requisite query

Throws:

NullArgumentException - requisiteQueryInspector is null

UnsupportedException - requisiteQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.