org.osid.course.chronicle

Interface AwardEntryCourseCatalogSession

All Superinterfaces:

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

public interface AwardEntryCourseCatalogSession
extends OsidSession

This session provides methods to retrieve AwardEntry to CourseCatalog mappings. An AwardEntry 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	canLookupCourseCatalogMappings() Tests if this user can perform lookups of award entry/course catalog mappings.
AwardEntryList	getAwardEntriesByCourseCatalog(Id courseCatalogId) Gets the list of AwardEntries associated with a CourseCatalog.
AwardEntryList	getAwardEntriesByCourseCatalogs(IdList courseCatalogIds) Gets the list of AwardEntries corresponding to a list of CourseCatalog objects.
IdList	getAwardEntryIdsByCourseCatalog(Id courseCatalogId) Gets the list of AwardEntry Ids associated with a CourseCatalog.
IdList	getAwardEntryIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of AwardEntry Ids corresponding to a list of CourseCatalog objects.
IdList	getCourseCatalogIdsByAwardEntry(Id awardEntryId) Gets the CourseCatalog Ids mapped to an AwardEntry.
CourseCatalogList	getCourseCatalogsByAwardEntry(Id awardEntryId) Gets the CourseCatalog objects mapped to an AwardEntry.
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 AwardEntry 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 award entry/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 AwardEntry 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.

getAwardEntryIdsByCourseCatalog

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

Gets the list of AwardEntry Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

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

getAwardEntriesByCourseCatalog

AwardEntryList getAwardEntriesByCourseCatalog(Id courseCatalogId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets the list of AwardEntries associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

list of related award entries

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.

getAwardEntryIdsByCourseCatalogs

IdList getAwardEntryIdsByCourseCatalogs(IdList courseCatalogIds)
                                        throws OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of award entry Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesByCourseCatalogs

AwardEntryList getAwardEntriesByCourseCatalogs(IdList courseCatalogIds)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of awarde ntries

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByAwardEntry

IdList getCourseCatalogIdsByAwardEntry(Id awardEntryId)
                                       throws NotFoundException,
                                              OperationFailedException,
                                              PermissionDeniedException

Gets the CourseCatalog Ids mapped to an AwardEntry.

Parameters:

awardEntryId - Id of a pAwardEntry

Returns:

list of course catalog Ids

Throws:

NotFoundException - awardEntryId is not found

NullArgumentException - awardEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByAwardEntry

CourseCatalogList getCourseCatalogsByAwardEntry(Id awardEntryId)
                                                throws NotFoundException,
                                                       OperationFailedException,
                                                       PermissionDeniedException

Gets the CourseCatalog objects mapped to an AwardEntry.

Parameters:

awardEntryId - Id of an AwardEntry

Returns:

list of course catalogs

Throws:

NotFoundException - awardEntryId is not found

NullArgumentException - awardEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.