Interface CourseCatalogSearchSession

All Superinterfaces:

AutoCloseable, Closeable, CourseCatalogQuerySession, OsidSession, OsidSession

public interface CourseCatalogSearchSession
extends CourseCatalogQuerySession

This session provides methods for searching among CourseCatalogs . The search query is constructed using the CourseCatalogQuery .

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

This session defines views that offer differing behaviors for searching.

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

Course catalogs may have a query record indicated by their respective record types. The query record is accessed via the CourseCatalogQuery .

Method Summary

Modifier and Type	Method	Description
CourseCatalogQuery	getCourseCatalogQueryFromInspector(CourseCatalogQueryInspector courseCatalogQueryInspector)	Gets a course catalog query from an inspector.
CourseCatalogSearchResults	getCourseCatalogsBySearch(CourseCatalogQuery courseCatalogQuery, CourseCatalogSearch courseCatalogSearch)	Gets the search results matching the given search query using the given search.
CourseCatalogSearch	getCourseCatalogSearch()	Gets a course catalog search.
CourseCatalogSearchOrder	getCourseCatalogSearchOrder()	Gets a course catalog search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CourseCatalogQuerySession

canSearchCourseCatalogs, getCourseCatalogQuery, getCourseCatalogsByQuery

Modifier and Type	Method	Description
boolean	canSearchCourseCatalogs()	Tests if this user can perform CourseCatalog lookups.
CourseCatalogQuery	getCourseCatalogQuery()	Gets a course catalog query.
CourseCatalogList	getCourseCatalogsByQuery(CourseCatalogQuery courseCatalogQuery)	Gets a list of CourseCatalogs matching the given course catalog query.

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

getCourseCatalogSearch

CourseCatalogSearch getCourseCatalogSearch()

Gets a course catalog search.

Returns:

the course catalog search

Compliance:

mandatory - This method must be implemented.

getCourseCatalogSearchOrder

CourseCatalogSearchOrder getCourseCatalogSearchOrder()

Gets a course catalog search order. The CourseCatalogSearchOrder is supplied to a CourseCatalogSearch to specify the ordering of results.

Returns:

the course catalog search order

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsBySearch

CourseCatalogSearchResults getCourseCatalogsBySearch(CourseCatalogQuery courseCatalogQuery,
 CourseCatalogSearch courseCatalogSearch)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

courseCatalogQuery - the course catalog query

courseCatalogSearch - the course catalog search

Returns:

the course catalog search results

Throws:

NullArgumentException - courseCatalogQuery or courseCatalogSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - courseCatalogQuery or courseCatalogSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCourseCatalogQueryFromInspector

CourseCatalogQuery getCourseCatalogQueryFromInspector(CourseCatalogQueryInspector courseCatalogQueryInspector)

Gets a course catalog query from an inspector. The inspector is available from a CourseCatalogSearchResults .

Parameters:

courseCatalogQueryInspector - a course catalog query inspector

Returns:

the course catalog query

Throws:

NullArgumentException - courseCatalogQueryInspector is null

UnsupportedException - courseCatalogQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.