org.osid.course.chronicle

Interface CourseEntrySearchSession

All Superinterfaces:

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

Methods

Modifier and Type	Method and 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 org.osid.course.chronicle.CourseEntryQuerySession

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

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

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.