Interface SyllabusSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, SyllabusQuerySession

public interface SyllabusSearchSession
extends SyllabusQuerySession

This session provides methods for searching Syllabi. 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

Modifier and Type	Method	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 Closeable

close

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.

Methods inherited from interface SyllabusQuerySession

canSearchSyllabi, getCourseCatalog, getCourseCatalogId, getSyllabiByQuery, getSyllabusQuery, useFederatedCourseCatalogView, useIsolatedCourseCatalogView

Modifier and Type	Method	Description
boolean	canSearchSyllabi()	Tests if this user can perform susbcription searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
SyllabusList	getSyllabiByQuery(SyllabusQuery syllabusQuery)	Gets a list of syllabi matching the given syllabus query.
SyllabusQuery	getSyllabusQuery()	Gets a syllabus query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

Method Details

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.