org.osid.course

Interface CourseOfferingSearchSession

All Superinterfaces:

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

public interface CourseOfferingSearchSession
extends CourseOfferingQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

Course Offerings may have a query record indicated by their respective record types. The queryrecord is accessed via the CourseOfferingQuery.

Method Summary

Methods

Modifier and Type	Method and Description
CourseOfferingQuery	getCourseOfferingQueryFromInspector(ItemQueryInspector courseOfferingQueryInspector) Gets a course offering query from an inspector.
CourseOfferingSearchResults	getCourseOfferingsBySearch(CourseOfferingQuery courseOfferingQuery, CourseOfferingSearch courseOfferingSearch) Gets the search results matching the given search query using the given search.
CourseOfferingSearch	getCourseOfferingSearch() Gets a course offering search.
CourseOfferingSearchOrder	getCourseOfferingSearchOrder() Gets a course offering search order.

Methods inherited from interface org.osid.course.CourseOfferingQuerySession

canSearchCourseOfferings, getCourseCatalog, getCourseCatalogId, getCourseOfferingQuery, getCourseOfferingsByQuery, 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

getCourseOfferingSearch

CourseOfferingSearch getCourseOfferingSearch()

Gets a course offering search.

Returns:

the course offering search

Compliance:

mandatory - This method must be implemented.

getCourseOfferingSearchOrder

CourseOfferingSearchOrder getCourseOfferingSearchOrder()

Gets a course offering search order. The CourseOfferingSearchOrder is supplied to a CourseOfferingSearch to specify the ordering of results.

Returns:

the course offering search order

Compliance:

mandatory - This method must be implemented.

getCourseOfferingsBySearch

CourseOfferingSearchResults getCourseOfferingsBySearch(CourseOfferingQuery courseOfferingQuery,
                                                     CourseOfferingSearch courseOfferingSearch)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

courseOfferingQuery - the course offering query

courseOfferingSearch - the course offering search

Returns:

the course offering search results

Throws:

NullArgumentException - courseOfferingQuery or courseOfferingSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - courseOfferingQuery or courseOfferingSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getCourseOfferingQueryFromInspector

CourseOfferingQuery getCourseOfferingQueryFromInspector(ItemQueryInspector courseOfferingQueryInspector)

Gets a course offering query from an inspector. The inspector is available from a CourseOfferingSearchResults.

Parameters:

courseOfferingQueryInspector - a course offering query inspector

Returns:

the course offering query

Throws:

NullArgumentException - courseOfferingQueryInspector is null

UnsupportedException - courseOfferingQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.