org.osid.course.program

Interface CredentialCourseCatalogSession

All Superinterfaces:

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

public interface CredentialCourseCatalogSession
extends OsidSession

This session provides methods to retrieve Credential to CourseCatalog mappings. A Credential may appear in multiple CourseCatalogs. 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	canLookupCourseCatalogMappings() Tests if this user can perform lookups of credential/course catalog mappings.
IdList	getCourseCatalogIdsByCredentials(Id credentialId) Gets the CourseCatalog Ids mapped to a Credential.
CourseCatalogList	getCourseCatalogsByCredential(Id credentialId) Gets the CourseCatalog objects mapped to a Credential.
IdList	getCredentialIdsByCourseCatalog(Id courseCatalogId) Gets the list of Credential Ids associated with a CourseCatalog.
IdList	getCredentialIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Credential Ids corresponding to a list of CourseCatalog objects.
CredentialList	getCredentialsByCourseCatalog(Id courseCatalogId) Gets the list of Credentials associated with a CourseCatalog.
CredentialList	getCredentialsByCourseCatalogs(IdList courseCatalogIds) Gets the list of Credentials corresponding to a list of CourseCatalog objects.
void	useComparativeCourseCatalogView() 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	usePlenaryCourseCatalogView() A complete view of the Credential 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

canLookupCourseCatalogMappings

boolean canLookupCourseCatalogMappings()

Tests if this user can perform lookups of credential/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.

useComparativeCourseCatalogView

void useComparativeCourseCatalogView()

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.

usePlenaryCourseCatalogView

void usePlenaryCourseCatalogView()

A complete view of the Credential 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.

getCredentialIdsByCourseCatalog

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

Gets the list of Credential Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related credential 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.

getCredentialsByCourseCatalog

CredentialList getCredentialsByCourseCatalog(Id courseCatalogId)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets the list of Credentials associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related credentials

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.

getCredentialIdsByCourseCatalogs

IdList getCredentialIdsByCourseCatalogs(IdList courseCatalogIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of credential Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialsByCourseCatalogs

CredentialList getCredentialsByCourseCatalogs(IdList courseCatalogIds)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of credentials

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByCredentials

IdList getCourseCatalogIdsByCredentials(Id credentialId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

Gets the CourseCatalog Ids mapped to a Credential.

Parameters:

credentialId - Id of a credential

Returns:

list of course catalog Ids

Throws:

NotFoundException - credentialId is not found

NullArgumentException - credentialId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByCredential

CourseCatalogList getCourseCatalogsByCredential(Id credentialId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the CourseCatalog objects mapped to a Credential.

Parameters:

credentialId - Id of a credential

Returns:

list of course catalogs

Throws:

NotFoundException - credentialId is not found

NullArgumentException - credentialId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.