org.osid.course.chronicle

Interface AwardEntryLookupSession

All Superinterfaces:

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

public interface AwardEntryLookupSession
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 award entry methods in this session operate, retrieve and pertain to awards defined explicitly in the current course catalog. Using an isolated view is useful for managing AwardEntries with the AwardEntry AdminSession.
• federated course catalog view: All award entry lookup methods in this session operate, retrieve and pertain to all awards defined in this course catalog and any other awards implicitly available in this course catalog through course catalog inheritence.
• effective award entry view: All award entry lookup methods return award entry where the current date falls in between the effective dates inclusive.
• any award entry view: Award 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.

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupAwardEntries() Tests if this user can perform AwardEntry lookups.
AwardEntryList	getAwardEntries() Gets all AwardEntries.
AwardEntryList	getAwardEntriesByGenusType(Type awardEntryGenusType) Gets an AwardEntryList corresponding to the given award entry genus Type which does not include awards of types derived from the specified Type.
AwardEntryList	getAwardEntriesByIds(IdList awardEntryId) Gets an AwardEntryList corresponding to the given IdList.
AwardEntryList	getAwardEntriesByParentGenusType(Type awardEntryGenusType) Gets an AwardEntryList corresponding to the given award entry genus Type and include any additional awards with genus types derived from the specified Type.
AwardEntryList	getAwardEntriesByRecordType(Type awardEntryRecordType) Gets an AwardEntryList containing the given award entry record Type.
AwardEntryList	getAwardEntriesForAward(Id awardId) Gets an AwardEntryList for the given award.
AwardEntryList	getAwardEntriesForAwardOnDate(Id awardId, DateTime from, DateTime to) Gets an AwardEntryList for the given award effective during the entire given date range inclusive but not confined to the date range.
AwardEntryList	getAwardEntriesForStudent(Id resourceId) Gets an AwardEntryList for the given student .
AwardEntryList	getAwardEntriesForStudentAndAward(Id resourceId, Id awardId) Gets an AwardEntryList for the given student and award .
AwardEntryList	getAwardEntriesForStudentAndAwardOnDate(Id resourceId, Id awardId, DateTime from, DateTime to) Gets an AwardEntryList for the given student and award effective during the entire given date range inclusive but not confined to the date range.
AwardEntryList	getAwardEntriesForStudentOnDate(Id resourceId, DateTime from, DateTime to) Gets an AwardEntryList for the given student effective during the entire given date range inclusive but not confined to the date range.
AwardEntryList	getAwardEntriesOnDate(DateTime from, DateTime to) Gets an AwardEntryList effective during the entire given date range inclusive but not confined to the date range.
AwardEntry	getAwardEntry(Id awardEntryId) Gets the AwardEntry specified by its Id.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
void	useAnyEffectiveAwardEntryView() All award entries of any effective dates are returned by methods in this session.
void	useComparativeAwardEntryView() 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	useEffectiveAwardEntryView() Only award 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	usePlenaryAwardEntryView() A complete view of the AwardEntry 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.

canLookupAwardEntries

boolean canLookupAwardEntries()

Tests if this user can perform AwardEntry 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.

useComparativeAwardEntryView

void useComparativeAwardEntryView()

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.

usePlenaryAwardEntryView

void usePlenaryAwardEntryView()

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

useEffectiveAwardEntryView

void useEffectiveAwardEntryView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveAwardEntryView

void useAnyEffectiveAwardEntryView()

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

Compliance:

mandatory - This method is must be implemented.

getAwardEntry

AwardEntry getAwardEntry(Id awardEntryId)
                         throws NotFoundException,
                                OperationFailedException,
                                PermissionDeniedException

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

Parameters:

awardEntryId - the Id of the AwardEntry to retrieve

Returns:

the returned chronicle

Throws:

NotFoundException - no AwardEntry found with the given Id

NullArgumentException - awardEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesByIds

AwardEntryList getAwardEntriesByIds(IdList awardEntryId)
                                    throws NotFoundException,
                                           OperationFailedException,
                                           PermissionDeniedException

Gets an AwardEntryList corresponding to the given IdList. In plenary mode, the returned list contains all of the awards 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 AwardEntries may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned.

Parameters:

awardEntryId - the list of Ids to retrieve

Returns:

the returned AwardEntryList

Throws:

NotFoundException - an Id was not found

NullArgumentException - awardEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesByGenusType

AwardEntryList getAwardEntriesByGenusType(Type awardEntryGenusType)
                                          throws OperationFailedException,
                                                 PermissionDeniedException

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

Parameters:

awardEntryGenusType - an award entry genus type

Returns:

the returned AwardEntryList

Throws:

NullArgumentException - awardEntryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesByParentGenusType

AwardEntryList getAwardEntriesByParentGenusType(Type awardEntryGenusType)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

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

Parameters:

awardEntryGenusType - an award entry genus type

Returns:

the returned AwardEntryList

Throws:

NullArgumentException - awardEntryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesByRecordType

AwardEntryList getAwardEntriesByRecordType(Type awardEntryRecordType)
                                           throws OperationFailedException,
                                                  PermissionDeniedException

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

Parameters:

awardEntryRecordType - an award entry record type

Returns:

the returned AwardEntryList list

Throws:

NullArgumentException - awardEntryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesOnDate

AwardEntryList getAwardEntriesOnDate(DateTime from,
                                   DateTime to)
                                     throws OperationFailedException,
                                            PermissionDeniedException

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

Parameters:

from - starting date

to - ending date

Returns:

the returned AwardEntryList 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.

getAwardEntriesForStudent

AwardEntryList getAwardEntriesForStudent(Id resourceId)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

resourceId - a resource Id

Returns:

the returned AwardEntryList list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesForStudentOnDate

AwardEntryList getAwardEntriesForStudentOnDate(Id resourceId,
                                             DateTime from,
                                             DateTime to)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets an AwardEntryList 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 awards or an error results. Otherwise, the returned list may contain only those awards that are accessible through this session. In effective mode, award entries are returned that are currently effective. In any effective mode, effective award entries and those currently expired are returned.

Parameters:

resourceId - a resource Id

from - starting date

to - ending date

Returns:

the returned AwardEntryList 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.

getAwardEntriesForAward

AwardEntryList getAwardEntriesForAward(Id awardId)
                                       throws OperationFailedException,
                                              PermissionDeniedException

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

Parameters:

awardId - an award Id

Returns:

the returned AwardEntryList list

Throws:

NullArgumentException - awardId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesForAwardOnDate

AwardEntryList getAwardEntriesForAwardOnDate(Id awardId,
                                           DateTime from,
                                           DateTime to)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

awardId - an award Id

from - starting date

to - ending date

Returns:

the returned AwardEntryList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - awardId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesForStudentAndAward

AwardEntryList getAwardEntriesForStudentAndAward(Id resourceId,
                                               Id awardId)
                                                 throws OperationFailedException,
                                                        PermissionDeniedException

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

Parameters:

resourceId - a resource Id

awardId - an award Id

Returns:

the returned AwardEntryList list

Throws:

NullArgumentException - resourceId or awardId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntriesForStudentAndAwardOnDate

AwardEntryList getAwardEntriesForStudentAndAwardOnDate(Id resourceId,
                                                     Id awardId,
                                                     DateTime from,
                                                     DateTime to)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

resourceId - a resource Id

awardId - an award Id

from - starting date

to - ending date

Returns:

the returned AwardEntryList list

Throws:

InvalidArgumentException - from is greater than to

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

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAwardEntries

AwardEntryList getAwardEntries()
                               throws OperationFailedException,
                                      PermissionDeniedException

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

Returns:

a list of AwardEntries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.