org.osid.course.registration

Interface RegistrationCourseCatalogSession

All Superinterfaces:

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

public interface RegistrationCourseCatalogSession
extends OsidSession

This session provides methods to retrieve Registration to CourseCatalog mappings. A Registration may appear in multiple CourseCatalog objects. Each catalog may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupRegistrationCourseCatalogMappings() Tests if this user can perform lookups of registration/course catalog mappings.
IdList	getCourseCatalogIdsByRegistration(Id registrationId) Gets the CourseCatalog Ids mapped to a Registration.
CourseCatalogList	getCourseCatalogsByRegistration(Id registrationId) Gets the CourseCatalog objects mapped to a Registration.
IdList	getRegistrationIdsByCourseCatalog(Id courseCatalogId) Gets the list of Registration Ids associated with a CourseCatalog.
IdList	getRegistrationIdsByCourseCatalogs(IdList courseCatalogIdList) Gets the list of Registration Ids corresponding to a list of CourseCatalog objects.
RegistrationList	getRegistrationsByCourseCatalog(Id courseCatalogId) Gets the list of Registrations associated with a CourseCatalog.
RegistrationList	getRegistrationsByCourseCatalogs(IdList courseCatalogIdList) Gets the list of Registrations corresponding to a list of CourseCatalog objects.
void	useComparativeRegistrationCourseCatalogView() The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error.
void	usePlenaryRegistrationCourseCatalogView() A complete view of the Registration and CourseCatalog returns is desired.

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

canLookupRegistrationCourseCatalogMappings

boolean canLookupRegistrationCourseCatalogMappings()

Tests if this user can perform lookups of registration/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeRegistrationCourseCatalogView

void useComparativeRegistrationCourseCatalogView()

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryRegistrationCourseCatalogView

void usePlenaryRegistrationCourseCatalogView()

A complete view of the Registration and CourseCatalog returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.

Compliance:

mandatory - This method is must be implemented.

getRegistrationIdsByCourseCatalog

IdList getRegistrationIdsByCourseCatalog(Id courseCatalogId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the list of Registration Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related registration Ids

Throws:

NotFoundException - courseCatalogId is not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRegistrationsByCourseCatalog

RegistrationList getRegistrationsByCourseCatalog(Id courseCatalogId)
                                                 throws NotFoundException,
                                                        OperationFailedException,
                                                        PermissionDeniedException

Gets the list of Registrations associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related registrations

Throws:

NotFoundException - courseCatalogId is not found

NullArgumentException - courseCatalogId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRegistrationIdsByCourseCatalogs

IdList getRegistrationIdsByCourseCatalogs(IdList courseCatalogIdList)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

Gets the list of Registration Ids corresponding to a list of CourseCatalog objects.

Parameters:

courseCatalogIdList - list of course catalog Ids

Returns:

list of registration Ids

Throws:

NullArgumentException - courseCatalogIdList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getRegistrationsByCourseCatalogs

RegistrationList getRegistrationsByCourseCatalogs(IdList courseCatalogIdList)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets the list of Registrations corresponding to a list of CourseCatalog objects.

Parameters:

courseCatalogIdList - list of course catalog Ids

Returns:

list of registrations

Throws:

NullArgumentException - courseCatalogIdList is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByRegistration

IdList getCourseCatalogIdsByRegistration(Id registrationId)
                                         throws NotFoundException,
                                                OperationFailedException,
                                                PermissionDeniedException

Gets the CourseCatalog Ids mapped to a Registration.

Parameters:

registrationId - Id of a Registration

Returns:

list of course catalogs

Throws:

NotFoundException - registrationId is not found

NullArgumentException - registrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByRegistration

CourseCatalogList getCourseCatalogsByRegistration(Id registrationId)
                                                  throws NotFoundException,
                                                         OperationFailedException,
                                                         PermissionDeniedException

Gets the CourseCatalog objects mapped to a Registration.

Parameters:

registrationId - Id of a Registration

Returns:

list of course catalogs

Throws:

NotFoundException - registrationId is not found

NullArgumentException - registrationId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.