org.osid.course.program

Interface CredentialSmartCourseCatalogSession

All Superinterfaces:

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

public interface CredentialSmartCourseCatalogSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. A CredentialQuery can be retrieved from this session and mapped to this CourseCatalog to create a virtual collection of Credentials. The credentials may be sequenced using the CredentialSearchOrder from this session.

This CourseCatalog has a default query that matches any course and a default search order that specifies no sequencing. The queries may be examined using a CredentialQueryInspector. The query may be modified by converting the inspector back to a CredentialQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyCredentialQuery(CredentialQuery credentialQuery) Applies a credential query to this course catalog.
void	applyCredentialSequencing(CredentialSearchOrder credentialSearchOrder) Applies a credential search order to this course catalog.
boolean	canManageSmartCourseCatalogs() Tests if this user can manage smart course catalogs.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
CredentialQuery	getCredentialQuery() Gets a credential query.
CredentialQuery	getCredentialQueryFromInspector(CredentialQueryInspector credentialQueryInspector) Gets a credential query from an inspector.
CredentialSearchOrder	getCredentialSearchOrder() Gets a credential search order.
CredentialQueryInspector	inspectCredentialQuery() Gets a credential query inspector for this course catalog.

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

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.

canManageSmartCourseCatalogs

boolean canManageSmartCourseCatalogs()

Tests if this user can manage smart course catalogs. A return of true does not guarantee successful assessment. A return of false indicates that it is known 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 operations to unauthorized users.

Returns:

false if smart course catalog management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getCredentialQuery

CredentialQuery getCredentialQuery()

Gets a credential query.

Returns:

the credential query

Compliance:

mandatory - This method must be implemented.

getCredentialSearchOrder

CredentialSearchOrder getCredentialSearchOrder()

Gets a credential search order.

Returns:

the credential search order

Compliance:

mandatory - This method must be implemented.

applyCredentialQuery

void applyCredentialQuery(CredentialQuery credentialQuery)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies a credential query to this course catalog.

Parameters:

credentialQuery - the credential query

Throws:

NullArgumentException - credentialQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - credentialQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectCredentialQuery

CredentialQueryInspector inspectCredentialQuery()
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Gets a credential query inspector for this course catalog.

Returns:

the credential query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyCredentialSequencing

void applyCredentialSequencing(CredentialSearchOrder credentialSearchOrder)
                               throws OperationFailedException,
                                      PermissionDeniedException

Applies a credential search order to this course catalog.

Parameters:

credentialSearchOrder - the credential search order

Throws:

NullArgumentException - credentialSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - credentialSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getCredentialQueryFromInspector

CredentialQuery getCredentialQueryFromInspector(CredentialQueryInspector credentialQueryInspector)

Gets a credential query from an inspector.

Parameters:

credentialQueryInspector - a query inspector

Returns:

the credential query

Throws:

NullArgumentException - credentialQueryInspector is null

UnsupportedException - credentialQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.