org.osid.course.syllabus

Interface SyllabusSearchSession

All Superinterfaces:

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

public interface SyllabusSearchSession
extends SyllabusQuerySession

This session provides methods for searching Syllabus objects. The search query is constructed using the SyllabusQuery. The syllabus record Type also specifies the record for the syllabus query.

getSyllabiByQuery() is the basic search method and returns a list of CourseCatalog elements. A more advanced search may be performed with getSyllabiBySearch(). It accepts a SyllabusSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getSyllabiBySearch() returns a SyllabusSearchResults that can be used to access the resulting SyllabusList or be used to perform a search within the result set through SyllabusSearch.

Syllabi may have a query record indicated by their respective record types. The query record is accessed via the SyllabusQuery. The returns in this session may not be cast directly to these interfaces.

Method Summary

Methods

Modifier and Type	Method and Description
SyllabusSearchResults	getSyllabiBySearch(SyllabusQuery syllabusQuery, SyllabusSearch syllabusSearch) Gets the search results matching the given search.
SyllabusQuery	getSyllabusQueryFromInspector(SyllabusQueryInspector syllabusQueryInspector) Gets a syllabus query from an inspector.
SyllabusSearch	getSyllabusSearch() Gets a syllabus search.
SyllabusSearchOrder	getSyllabusSearchOrder() Gets a syllabus search order.

Methods inherited from interface org.osid.course.syllabus.SyllabusQuerySession

canSearchSyllabi, getCourseCatalog, getCourseCatalogId, getSyllabiByQuery, getSyllabusQuery, 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

getSyllabusSearch

SyllabusSearch getSyllabusSearch()

Gets a syllabus search.

Returns:

the syllabus search

Compliance:

mandatory - This method must be implemented.

getSyllabusSearchOrder

SyllabusSearchOrder getSyllabusSearchOrder()

Gets a syllabus search order. The SyllabusSearchOrder is supplied to a SyllabusSearch to specify the ordering of results.

Returns:

the syllabus search order interface

Compliance:

mandatory - This method must be implemented.

getSyllabiBySearch

SyllabusSearchResults getSyllabiBySearch(SyllabusQuery syllabusQuery,
                                       SyllabusSearch syllabusSearch)
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets the search results matching the given search.

Parameters:

syllabusQuery - the syllabus query

syllabusSearch - the syllabus search

Returns:

the syllabus search results

Throws:

NullArgumentException - syllabusQuery or syllabusSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - syllabusQuery or syllabusSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getSyllabusQueryFromInspector

SyllabusQuery getSyllabusQueryFromInspector(SyllabusQueryInspector syllabusQueryInspector)

Gets a syllabus query from an inspector. The inspector is available from a SyllabusSearchResults.

Parameters:

syllabusQueryInspector - a syllabus query inspector

Returns:

the syllabus query

Throws:

NullArgumentException - syllabusQueryInspector is null

UnsupportedException - syllabusQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.