org.osid.course.chronicle

Interface AssessmentEntryLookupSession

All Superinterfaces:

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

public interface AssessmentEntryLookupSession
extends OsidSession

This session defines methods for retrieving entriesand entry components.

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
• isolated course catalog view: All assessment entry methods in this session operate, retrieve and pertain to assessments defined explicitly in the current course catalog. Using an isolated view is useful for managing AssessmentEntries with the AssessmentEntry AdminSession.
• federated course catalog view: All assessment entry lookup methods in this session operate, retrieve and pertain to all assessments defined in this course catalog and any other assessments implicitly available in this course catalog through course catalog inheritence.
• effective assessment entry view: All assessment entry lookup methods return assessment entry where the current date falls in between the effective dates inclusive.
• any assessment entry view: Assessment entries of any effective date are returned from methods.

The methods useFederatedCourseCatalogView() and useIsolatedCourseCatalogView() behave as a radio group and one should be selected before invoking any lookup methods.

AssessmentEntries may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the AssessmentEntry.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupAssessmentEntries() Tests if this user can perform AssessmentEntry lookups.
AssessmentEntryList	getAssessmentEntries() Gets all AssessmentEntries.
AssessmentEntryList	getAssessmentEntriesByGenusType(Type assessmentEntryGenusType) Gets an AssessmentEntryList corresponding to the given assessment entry genus Type which does not include assessments of types derived from the specified Type.
AssessmentEntryList	getAssessmentEntriesByIds(IdList assessmentEntryId) Gets an AssessmentEntryList corresponding to the given IdList.
AssessmentEntryList	getAssessmentEntriesByParentGenusType(Type assessmentEntryGenusType) Gets an AssessmentEntryList corresponding to the given assessment entry genus Type and include any additional assessments with genus types derived from the specified Type.
AssessmentEntryList	getAssessmentEntriesByRecordType(Type assessmentEntryRecordType) Gets an AssessmentEntryList containing the given assessment entry record Type.
AssessmentEntryList	getAssessmentEntriesForAssessment(Id assessmentId) Gets an AssessmentEntryList for the given assessment.
AssessmentEntryList	getAssessmentEntriesForAssessmentOnDate(Id assessmentId, DateTime from, DateTime to) Gets an AssessmentEntryList for the given assessment effective during the entire given date range inclusive but not confined to the date range.
AssessmentEntryList	getAssessmentEntriesForStudent(Id resourceId) Gets an AssessmentEntryList for the given student .
AssessmentEntryList	getAssessmentEntriesForStudentAndAssessment(Id resourceId, Id assessmentId) Gets an AssessmentEntryList for the given student and assessment .
AssessmentEntryList	getAssessmentEntriesForStudentAndAssessmentOnDate(Id resourceId, Id assessmentId, DateTime from, DateTime to) Gets an AssessmentEntryList for the given student and assessment effective during the entire given date range inclusive but not confined to the date range.
AssessmentEntryList	getAssessmentEntriesForStudentOnDate(Id resourceId, DateTime from, DateTime to) Gets an AssessmentEntryList for the given student effective during the entire given date range inclusive but not confined to the date range.
AssessmentEntryList	getAssessmentEntriesOnDate(DateTime from, DateTime to) Gets an AssessmentEntryList effectiveduring the entire given date range inclusive but not confined to the date range.
AssessmentEntry	getAssessmentEntry(Id assessmentEntryId) Gets the AssessmentEntry specified by its Id.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
void	useAnyEffectiveAssessmentEntryView() All assessment entries of any effective dates are returned by methods in this session.
void	useComparativeAssessmentEntryView() 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	useEffectiveAssessmentEntryView() Only assessment entries whose effective dates are current are returned by methods in this session.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.
void	usePlenaryAssessmentEntryView() A complete view of the AssessmentEntry 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

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.

canLookupAssessmentEntries

boolean canLookupAssessmentEntries()

Tests if this user can perform AssessmentEntry lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeAssessmentEntryView

void useComparativeAssessmentEntryView()

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.

usePlenaryAssessmentEntryView

void usePlenaryAssessmentEntryView()

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

useFederatedCourseCatalogView

void useFederatedCourseCatalogView()

Federates the view for methods in this session. A federated view will include assessments in catalogs which are children of this catalog in the course catalog hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedCourseCatalogView

void useIsolatedCourseCatalogView()

Isolates the view for methods in this session. An isolated view restricts retrievals to this course catalog only.

Compliance:

mandatory - This method is must be implemented.

useEffectiveAssessmentEntryView

void useEffectiveAssessmentEntryView()

Only assessment entries whose effective dates are current are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveAssessmentEntryView

void useAnyEffectiveAssessmentEntryView()

All assessment entries of any effective dates are returned by methods in this session.

Compliance:

mandatory - This method is must be implemented.

getAssessmentEntry

AssessmentEntry getAssessmentEntry(Id assessmentEntryId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the AssessmentEntry specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned AssessmentEntry may have a different Id than requested, such as the case where a duplicate Id was assigned to an AssessmentEntry and retained for compatibility. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

assessmentEntryId - the Id of the AssessmentEntry to retrieve

Returns:

the returned chronicle

Throws:

NotFoundException - no AssessmentEntry found with the given Id

NullArgumentException - assessmentEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesByIds

AssessmentEntryList getAssessmentEntriesByIds(IdList assessmentEntryId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

Gets an AssessmentEntryList corresponding to the given IdList. In plenary mode, the returned list contains all of the assessments specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible AssessmentEntries may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

assessmentEntryId - the list of Ids to retrieve

Returns:

the returned AssessmentEntryList

Throws:

NotFoundException - an Id was not found

NullArgumentException - assessmentEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesByGenusType

AssessmentEntryList getAssessmentEntriesByGenusType(Type assessmentEntryGenusType)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets an AssessmentEntryList corresponding to the given assessment entry genus Type which does not include assessments of types derived from the specified Type. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

assessmentEntryGenusType - an assessment entry genus type

Returns:

the returned AssessmentEntryList

Throws:

NullArgumentException - assessmentEntryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesByParentGenusType

AssessmentEntryList getAssessmentEntriesByParentGenusType(Type assessmentEntryGenusType)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

Gets an AssessmentEntryList corresponding to the given assessment entry genus Type and include any additional assessments with genus types derived from the specified Type. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

assessmentEntryGenusType - an assessment entry genus type

Returns:

the returned AssessmentEntryList

Throws:

NullArgumentException - assessmentEntryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesByRecordType

AssessmentEntryList getAssessmentEntriesByRecordType(Type assessmentEntryRecordType)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Gets an AssessmentEntryList containing the given assessment entry record Type. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

assessmentEntryRecordType - an assessment entry record type

Returns:

the returned AssessmentEntryList list

Throws:

NullArgumentException - assessmentEntryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesOnDate

AssessmentEntryList getAssessmentEntriesOnDate(DateTime from,
                                             DateTime to)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets an AssessmentEntryList effectiveduring the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

from - starting date

to - ending date

Returns:

the returned AssessmentEntryList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesForStudent

AssessmentEntryList getAssessmentEntriesForStudent(Id resourceId)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Gets an AssessmentEntryList for the given student . In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

resourceId - a resource Id

Returns:

the returned AssessmentEntryList list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesForStudentOnDate

AssessmentEntryList getAssessmentEntriesForStudentOnDate(Id resourceId,
                                                       DateTime from,
                                                       DateTime to)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Gets an AssessmentEntryList for the given student effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

resourceId - a resource Id

from - starting date

to - ending date

Returns:

the returned AssessmentEntryList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesForAssessment

AssessmentEntryList getAssessmentEntriesForAssessment(Id assessmentId)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Gets an AssessmentEntryList for the given assessment. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

assessmentId - an assessment Id

Returns:

the returned AssessmentEntryList list

Throws:

NullArgumentException - assessmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesForAssessmentOnDate

AssessmentEntryList getAssessmentEntriesForAssessmentOnDate(Id assessmentId,
                                                          DateTime from,
                                                          DateTime to)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

Gets an AssessmentEntryList for the given assessment effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

assessmentId - an assessment Id

from - starting date

to - ending date

Returns:

the returned AssessmentEntryList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - assessmentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesForStudentAndAssessment

AssessmentEntryList getAssessmentEntriesForStudentAndAssessment(Id resourceId,
                                                              Id assessmentId)
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

Gets an AssessmentEntryList for the given student and assessment . In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

resourceId - a resource Id

assessmentId - an assessment Id

Returns:

the returned AssessmentEntryList list

Throws:

NullArgumentException - resourceId or assessmentId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntriesForStudentAndAssessmentOnDate

AssessmentEntryList getAssessmentEntriesForStudentAndAssessmentOnDate(Id resourceId,
                                                                    Id assessmentId,
                                                                    DateTime from,
                                                                    DateTime to)
                                                                      throws OperationFailedException,
                                                                             PermissionDeniedException

Gets an AssessmentEntryList for the given student and assessment effective during the entire given date range inclusive but not confined to the date range. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Parameters:

resourceId - a resource Id

assessmentId - an assessment Id

from - starting date

to - ending date

Returns:

the returned AssessmentEntryList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - resourceId, assessmentId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssessmentEntries

AssessmentEntryList getAssessmentEntries()
                                         throws OperationFailedException,
                                                PermissionDeniedException

Gets all AssessmentEntries. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session. In effective mode, assessment entries are returned that are currently effective. In any effective mode, effective assessment entries and those currently expired are returned.

Returns:

a list of AssessmentEntries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.