Interface CourseCatalogQuerySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

CourseCatalogSearchSession

public interface CourseCatalogQuerySession
extends OsidSession

This session provides methods for searching among CourseCatalogs. The search query is constructed using the CourseCatalogQuery.

This session defines views that offer differing behaviors for searching.

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

Course catalogs may have a query record indicated by their respective record types. The query record is accessed via the CourseCatalogQuery.

Method Summary

Modifier and Type	Method	Description
boolean	canSearchCourseCatalogs()	Tests if this user can perform CourseCatalog lookups.
CourseCatalogQuery	getCourseCatalogQuery()	Gets a course catalog query.
CourseCatalogList	getCourseCatalogsByQuery(CourseCatalogQuery courseCatalogQuery)	Gets a list of CourseCatalogs matching the given course catalog query.

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.

Method Details

canSearchCourseCatalogs

boolean canSearchCourseCatalogs()

Tests if this user can perform CourseCatalog lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCourseCatalogQuery

CourseCatalogQuery getCourseCatalogQuery()

Gets a course catalog query.

Returns:

the course catalog query

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByQuery

CourseCatalogList getCourseCatalogsByQuery(CourseCatalogQuery courseCatalogQuery)
                                    throws OperationFailedException,
PermissionDeniedException

Gets a list of CourseCatalogs matching the given course catalog query.

Parameters:

courseCatalogQuery - the course catalog query

Returns:

the returned CourseCatalogList

Throws:

NullArgumentException - courseCatalogQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - courseCatalogQuery is not of this service

Compliance:

mandatory - This method must be implemented.