Interface CourseEntrySearchSession

All Superinterfaces:

AutoCloseable, Closeable, CourseEntryQuerySession, OsidSession, OsidSession

public interface CourseEntrySearchSession
extends CourseEntryQuerySession

This session provides methods for searching among CourseEntries . The search query is constructed using the CourseEntryQuery .

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

This session defines views that offer differing behaviors for searching.

• federated course catalog view: searches include course entries 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

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

Method Summary

Modifier and Type	Method	Description
CourseEntrySearchResults	getCourseEntriesBySearch(CourseEntryQuery courseEntryQuery, CourseEntrySearch courseEntrySearch)	Gets the search results matching the given search query using the given search.
CourseEntryQuery	getCourseEntryQueryFromInspector(CourseEntryQueryInspector courseEntryQueryInspector)	Gets a course entry query from an inspector.
CourseEntrySearch	getCourseEntrySearch()	Gets a course entry search.
CourseEntrySearchOrder	getCourseEntrySearchOrder()	Gets a course entry search order.

Methods inherited from interface Closeable

close

Methods inherited from interface CourseEntryQuerySession

canSearchCourseEntries, getCourseCatalog, getCourseCatalogId, getCourseEntriesByQuery, getCourseEntryQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchCourseEntries()	Tests if this user can perform CourseEntry searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
CourseEntryList	getCourseEntriesByQuery(CourseEntryQuery courseEntryQuery)	Gets a list of CourseEntries matching the given course entry query.
CourseEntryQuery	getCourseEntryQuery()	Gets a course entry query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

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

getCourseEntrySearch

CourseEntrySearch getCourseEntrySearch()

Gets a course entry search.

Returns:

the course entry search

Compliance:

mandatory - This method must be implemented.

getCourseEntrySearchOrder

CourseEntrySearchOrder getCourseEntrySearchOrder()

Gets a course entry search order. The CourseEntrySearchOrder is supplied to a CourseEntrySearch to specify the ordering of results.

Returns:

the course entry search order

Compliance:

mandatory - This method must be implemented.

getCourseEntriesBySearch

CourseEntrySearchResults getCourseEntriesBySearch(CourseEntryQuery courseEntryQuery,
 CourseEntrySearch courseEntrySearch)
                                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

courseEntryQuery - the course entry query

courseEntrySearch - the course entry search

Returns:

the course entry search results

Throws:

NullArgumentException - courseEntryQuery or courseEntrySearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - courseEntryQuery or CourseEntrySearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCourseEntryQueryFromInspector

CourseEntryQuery getCourseEntryQueryFromInspector(CourseEntryQueryInspector courseEntryQueryInspector)

Gets a course entry query from an inspector. The inspector is available from a CourseEntrySearchResults .

Parameters:

courseEntryQueryInspector - a course entry query inspector

Returns:

the course entry query

Throws:

NullArgumentException - courseEntryQueryInspector is null

UnsupportedException - courseEntryQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.