org.osid.course.chronicle

Interface AssessmentEntryCourseCatalogSession

All Superinterfaces:

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

public interface AssessmentEntryCourseCatalogSession
extends OsidSession

This session provides methods to retrieve AssessmentEntry to CourseCatalog mappings. An AssessmentEntry 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 assessment entry/course catalog mappings.
AssessmentEntryList	getAssessmentEntriesByCourseCatalog(Id courseCatalogId) Gets the list of AssessmentEntries associated with a CourseCatalog.
AssessmentEntryList	getAssessmentEntriesByCourseCatalogs(IdList courseCatalogIds) Gets the list of AssessmentEntries corresponding to a list of CourseCatalog objects.
IdList	getAssessmentEntryIdsByCourseCatalog(Id courseCatalogId) Gets the list of AssessmentEntry Ids associated with a CourseCatalog.
IdList	getAssessmentEntryIdsByCourseCatalogs(IdList courseCatalogIds) Gets the list of AssessmentEntry Ids corresponding to a list of CourseCatalog objects.
IdList	getCourseCatalogIdsByAssessmentEntry(Id assessmentEntryId) Gets the CourseCatalog Ids mapped to an AssessmentEntry.
CourseCatalogList	getCourseCatalogsByAssessmentEntry(Id assessmentEntryId) Gets the CourseCatalog objects mapped to an AssessmentEntry.
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 AssessmentEntry 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 assessment 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 AssessmentEntry 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.

getAssessmentEntryIdsByCourseCatalog

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

Gets the list of AssessmentEntry Ids associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

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

getAssessmentEntriesByCourseCatalog

AssessmentEntryList getAssessmentEntriesByCourseCatalog(Id courseCatalogId)
                                                        throws NotFoundException,
                                                               OperationFailedException,
                                                               PermissionDeniedException

Gets the list of AssessmentEntries associated with a CourseCatalog.

Parameters:

courseCatalogId - Id of the CourseCatalog

Returns:

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

getAssessmentEntryIdsByCourseCatalogs

IdList getAssessmentEntryIdsByCourseCatalogs(IdList courseCatalogIds)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of assessment entry Ids

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesByCourseCatalogs

AssessmentEntryList getAssessmentEntriesByCourseCatalogs(IdList courseCatalogIds)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

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

Parameters:

courseCatalogIds - list of course catalog Ids

Returns:

list of assessmente ntries

Throws:

NullArgumentException - courseCatalogIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogIdsByAssessmentEntry

IdList getCourseCatalogIdsByAssessmentEntry(Id assessmentEntryId)
                                            throws NotFoundException,
                                                   OperationFailedException,
                                                   PermissionDeniedException

Gets the CourseCatalog Ids mapped to an AssessmentEntry.

Parameters:

assessmentEntryId - Id of a pAssessmentEntry

Returns:

list of course catalog Ids

Throws:

NotFoundException - assessmentEntryId is not found

NullArgumentException - assessmentEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCourseCatalogsByAssessmentEntry

CourseCatalogList getCourseCatalogsByAssessmentEntry(Id assessmentEntryId)
                                                     throws NotFoundException,
                                                            OperationFailedException,
                                                            PermissionDeniedException

Gets the CourseCatalog objects mapped to an AssessmentEntry.

Parameters:

assessmentEntryId - Id of an AssessmentEntry

Returns:

list of course catalogs

Throws:

NotFoundException - assessmentEntryId is not found

NullArgumentException - assessmentEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.