Interface ProgramEntryQuerySession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

All Known Subinterfaces:

ProgramEntrySearchSession

public interface ProgramEntryQuerySession
extends OsidSession

This session provides methods for searching among ProgramEntries. The search query is constructed using the ProgramEntryQuery.

This session defines views that offer differing behaviors for searching.

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

ProgramEntries may have a query record indicated by their respective record types. The query record is accessed via the ProgramEntryQuery.

Method Summary

Modifier and Type	Method	Description
boolean	canSearchProgramEntries()	Tests if this user can perform ProgramEntry searches.
CourseCatalog	getCourseCatalog()	Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId()	Gets the CourseCatalog Id associated with this session.
ProgramEntryList	getProgramEntriesByQuery(ProgramEntryQuery programEntryQuery)	Gets a list of ProgramEntries matching the given program entry query.
ProgramEntryQuery	getProgramEntryQuery()	Gets a program entry query.
void	useFederatedCourseCatalogView()	Federates the view for methods in this session.
void	useIsolatedCourseCatalogView()	Isolates the view for methods in this session.

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

getCourseCatalogId

Id getCourseCatalogId()

Gets the CourseCatalog Id associated with this session.

Returns:

the CourseCatalog Id associated with this session

Compliance:

mandatory - This method must be implemented.

getCourseCatalog

CourseCatalog getCourseCatalog()
                        throws OperationFailedException,
PermissionDeniedException

Gets the CourseCatalog associated with this session.

Returns:

the course catalog

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchProgramEntries

boolean canSearchProgramEntries()

Tests if this user can perform ProgramEntry searches. 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 opt not to offer search operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include program entries in course catalog which are children of this course catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

Isolates the view for methods in this session. An isolated view restricts lookups to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

getProgramEntryQuery

ProgramEntryQuery getProgramEntryQuery()

Gets a program entry query.

Returns:

the program entry query

Compliance:

mandatory - This method must be implemented.

getProgramEntriesByQuery

ProgramEntryList getProgramEntriesByQuery(ProgramEntryQuery programEntryQuery)
                                   throws OperationFailedException,
PermissionDeniedException

Gets a list of ProgramEntries matching the given program entry query.

Parameters:

programEntryQuery - the program entry query

Returns:

the returned ProgramEntryList

Throws:

NullArgumentException - programEntryQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - programEntryQuery is not of this service

Compliance:

mandatory - This method must be implemented.