org.osid.course.chronicle

Interface CredentialEntryLookupSession

All Superinterfaces:

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

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupCredentialEntries() Tests if this user can perform CredentialEntry lookups.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
CredentialEntryList	getCredentialEntries() Gets all CredentialEntries.
CredentialEntryList	getCredentialEntriesByGenusType(Type credentialEntryGenusType) Gets a CredentialEntryList corresponding to the given credential entry genus Type which does not include credential entries of types derived from the specified Type.
CredentialEntryList	getCredentialEntriesByIds(IdList credentialEntryId) Gets a CredentialEntryList corresponding to the given IdList.
CredentialEntryList	getCredentialEntriesByParentGenusType(Type credentialEntryGenusType) Gets a CredentialEntryList corresponding to the given credential entry genus Type and include any additional credential entries with genus types derived from the specified Type.
CredentialEntryList	getCredentialEntriesByRecordType(Type credentialEntryRecordType) Gets a CredentialEntryList containing the given credential entry record Type.
CredentialEntryList	getCredentialEntriesForCredential(Id credentialId) Gets a CredentialEntryList for the given credential.
CredentialEntryList	getCredentialEntriesForCredentialOnDate(Id credentialId, DateTime from, DateTime to) Gets a CredentialEntryList for the given credential effective during the entire given date range inclusive but not confined to the date range.
CredentialEntryList	getCredentialEntriesForStudent(Id resourceId) Gets a CredentialEntryList for the given student .
CredentialEntryList	getCredentialEntriesForStudentAndCredential(Id resourceId, Id credentialId) Gets a CredentialEntryList for the given student and credential .
CredentialEntryList	getCredentialEntriesForStudentAndCredentialOnDate(Id resourceId, Id credentialId, DateTime from, DateTime to) Gets a CredentialEntryList for the given student and credential effective during the entire given date range inclusive but not confined to the date range.
CredentialEntryList	getCredentialEntriesForStudentOnDate(Id resourceId, DateTime from, DateTime to) Gets a CredentialEntryList for the given student effective during the entire given date range inclusive but not confined to the date range.
CredentialEntryList	getCredentialEntriesOnDate(DateTime from, DateTime to) Gets a CredentialEntryList effective during the entire given date range inclusive but not confined to the date range.
CredentialEntry	getCredentialEntry(Id credentialEntryId) Gets the CredentialEntry specified by its Id.
void	useAnyEffectiveCredentialEntryView() All credential entries of any effective dates are returned by methods in this session.
void	useComparativeCredentialEntryView() 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	useEffectiveCredentialEntryView() Only credential 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	usePlenaryCredentialEntryView() A complete view of the CredentialEntry 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.

canLookupCredentialEntries

boolean canLookupCredentialEntries()

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

useComparativeCredentialEntryView

void useComparativeCredentialEntryView()

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.

usePlenaryCredentialEntryView

void usePlenaryCredentialEntryView()

A complete view of the CredentialEntry 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 credential entries 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.

useEffectiveCredentialEntryView

void useEffectiveCredentialEntryView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveCredentialEntryView

void useAnyEffectiveCredentialEntryView()

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

Compliance:

mandatory - This method is must be implemented.

getCredentialEntry

CredentialEntry getCredentialEntry(Id credentialEntryId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

credentialEntryId - the Id of the CredentialEntry to retrieve

Returns:

the returned CredentialEntry

Throws:

NotFoundException - no CredentialEntry found with the given Id

NullArgumentException - credentialEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesByIds

CredentialEntryList getCredentialEntriesByIds(IdList credentialEntryId)
                                              throws NotFoundException,
                                                     OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

credentialEntryId - the list of Ids to retrieve

Returns:

the returned CredentialEntryList

Throws:

NotFoundException - an Id was not found

NullArgumentException - credentialEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesByGenusType

CredentialEntryList getCredentialEntriesByGenusType(Type credentialEntryGenusType)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

credentialEntryGenusType - a credential entry genus type

Returns:

the returned CredentialEntryList

Throws:

NullArgumentException - credentialEntryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesByParentGenusType

CredentialEntryList getCredentialEntriesByParentGenusType(Type credentialEntryGenusType)
                                                          throws OperationFailedException,
                                                                 PermissionDeniedException

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

Parameters:

credentialEntryGenusType - a credential entry genus type

Returns:

the returned CredentialEntryList

Throws:

NullArgumentException - credentialEntryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesByRecordType

CredentialEntryList getCredentialEntriesByRecordType(Type credentialEntryRecordType)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

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

Parameters:

credentialEntryRecordType - a credential entry record type

Returns:

the returned CredentialEntryList list

Throws:

NullArgumentException - credentialEntryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesOnDate

CredentialEntryList getCredentialEntriesOnDate(DateTime from,
                                             DateTime to)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

from - starting date

to - ending date

Returns:

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

getCredentialEntriesForStudent

CredentialEntryList getCredentialEntriesForStudent(Id resourceId)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

resourceId - a resource Id

Returns:

the returned CredentialEntryList list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesForStudentOnDate

CredentialEntryList getCredentialEntriesForStudentOnDate(Id resourceId,
                                                       DateTime from,
                                                       DateTime to)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

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

Parameters:

resourceId - a resource Id

from - starting date

to - ending date

Returns:

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

getCredentialEntriesForCredential

CredentialEntryList getCredentialEntriesForCredential(Id credentialId)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

credentialId - a credential Id

Returns:

the returned CredentialEntryList list

Throws:

NullArgumentException - credentialId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesForCredentialOnDate

CredentialEntryList getCredentialEntriesForCredentialOnDate(Id credentialId,
                                                          DateTime from,
                                                          DateTime to)
                                                            throws OperationFailedException,
                                                                   PermissionDeniedException

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

Parameters:

credentialId - a credential Id

from - starting date

to - ending date

Returns:

the returned CredentialEntryList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - credentialId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesForStudentAndCredential

CredentialEntryList getCredentialEntriesForStudentAndCredential(Id resourceId,
                                                              Id credentialId)
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

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

Parameters:

resourceId - a resource Id

credentialId - a credential Id

Returns:

the returned CredentialEntryList list

Throws:

NullArgumentException - resourceId or credentialId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntriesForStudentAndCredentialOnDate

CredentialEntryList getCredentialEntriesForStudentAndCredentialOnDate(Id resourceId,
                                                                    Id credentialId,
                                                                    DateTime from,
                                                                    DateTime to)
                                                                      throws OperationFailedException,
                                                                             PermissionDeniedException

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

Parameters:

resourceId - a resource Id

credentialId - a credential Id

from - starting date

to - ending date

Returns:

the returned CredentialEntryList list

Throws:

InvalidArgumentException - from is greater than to

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

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getCredentialEntries

CredentialEntryList getCredentialEntries()
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Returns:

a list of CredentialEntries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.