org.osid.course.chronicle

Interface ProgramEntryLookupSession

All Superinterfaces:

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

public interface ProgramEntryLookupSession
extends OsidSession

This session defines methods for retrieving entries.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupProgramEntries() Tests if this user can perform ProgramEntry lookups.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
ProgramEntryList	getProgramEntries() Gets all ProgramEntries.
ProgramEntryList	getProgramEntriesByGenusType(Type programEntryGenusType) Gets a ProgramEntryList corresponding to the given program entry genus Type which does not include program entries of types derived from the specified Type.
ProgramEntryList	getProgramEntriesByIds(IdList programEntryId) Gets a ProgramEntryList corresponding to the given IdList.
ProgramEntryList	getProgramEntriesByParentGenusType(Type programEntryGenusType) Gets a ProgramEntryList corresponding to the given program entry genus Type and include any additional program entries with genus types derived from the specified Type.
ProgramEntryList	getProgramEntriesByRecordType(Type programEntryRecordType) Gets a ProgramEntryList containing the given program entry record Type.
ProgramEntryList	getProgramEntriesForProgram(Id programId) Gets a ProgramEntryList for the given program.
ProgramEntryList	getProgramEntriesForProgramOnDate(Id programId, DateTime from, DateTime to) Gets a ProgramEntryList for the given program effective during the entire given date range inclusive but not confined to the date range.
ProgramEntryList	getProgramEntriesForStudent(Id resourceId) Gets a ProgramEntryList for the given student .
ProgramEntryList	getProgramEntriesForStudentAndProgram(Id resourceId, Id programId) Gets a ProgramEntryList for the given student and program .
ProgramEntryList	getProgramEntriesForStudentAndProgramOnDate(Id resourceId, Id programId, DateTime from, DateTime to) Gets a ProgramEntryList for the given student and program effective during the entire given date range inclusive but not confined to the date range.
ProgramEntryList	getProgramEntriesForStudentOnDate(Id resourceId, DateTime from, DateTime to) Gets a ProgramEntryList for the given student effective during the entire given date range inclusive but not confined to the date range.
ProgramEntryList	getProgramEntriesOnDate(DateTime from, DateTime to) Gets a ProgramEntryList effective during the entire given date range inclusive but not confined to the date range.
ProgramEntry	getProgramEntry(Id programEntryId) Gets the ProgramEntry specified by its Id.
void	useAnyEffectiveProgramEntryView() All program entries of any effective dates are returned by methods in this session.
void	useComparativeProgramEntryView() 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	useEffectiveProgramEntryView() Only program 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	usePlenaryProgramEntryView() A complete view of the ProgramEntry 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.

canLookupProgramEntries

boolean canLookupProgramEntries()

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

useComparativeProgramEntryView

void useComparativeProgramEntryView()

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.

usePlenaryProgramEntryView

void usePlenaryProgramEntryView()

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

useEffectiveProgramEntryView

void useEffectiveProgramEntryView()

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

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveProgramEntryView

void useAnyEffectiveProgramEntryView()

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

Compliance:

mandatory - This method is must be implemented.

getProgramEntry

ProgramEntry getProgramEntry(Id programEntryId)
                             throws NotFoundException,
                                    OperationFailedException,
                                    PermissionDeniedException

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

Parameters:

programEntryId - the Id of the ProgramEntry to retrieve

Returns:

the returned ProgramEntry

Throws:

NotFoundException - no ProgramEntry found with the given Id

NullArgumentException - programEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesByIds

ProgramEntryList getProgramEntriesByIds(IdList programEntryId)
                                        throws NotFoundException,
                                               OperationFailedException,
                                               PermissionDeniedException

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

Parameters:

programEntryId - the list of Ids to retrieve

Returns:

the returned ProgramEntryList

Throws:

NotFoundException - an Id was not found

NullArgumentException - programEntryId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesByGenusType

ProgramEntryList getProgramEntriesByGenusType(Type programEntryGenusType)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

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

Parameters:

programEntryGenusType - a program entry genus type

Returns:

the returned ProgramEntryList

Throws:

NullArgumentException - programEntryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesByParentGenusType

ProgramEntryList getProgramEntriesByParentGenusType(Type programEntryGenusType)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

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

Parameters:

programEntryGenusType - a program entry genus type

Returns:

the returned ProgramEntryList

Throws:

NullArgumentException - programEntryGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesByRecordType

ProgramEntryList getProgramEntriesByRecordType(Type programEntryRecordType)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

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

Parameters:

programEntryRecordType - a program entry record type

Returns:

the returned ProgramEntryList list

Throws:

NullArgumentException - programEntryRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesOnDate

ProgramEntryList getProgramEntriesOnDate(DateTime from,
                                       DateTime to)
                                         throws OperationFailedException,
                                                PermissionDeniedException

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

Parameters:

from - starting date

to - ending date

Returns:

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

getProgramEntriesForStudent

ProgramEntryList getProgramEntriesForStudent(Id resourceId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

resourceId - a resource Id

Returns:

the returned ProgramEntryList list

Throws:

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesForStudentOnDate

ProgramEntryList getProgramEntriesForStudentOnDate(Id resourceId,
                                                 DateTime from,
                                                 DateTime to)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

resourceId - a resource Id

from - starting date

to - ending date

Returns:

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

getProgramEntriesForProgram

ProgramEntryList getProgramEntriesForProgram(Id programId)
                                             throws OperationFailedException,
                                                    PermissionDeniedException

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

Parameters:

programId - a program Id

Returns:

the returned ProgramEntryList list

Throws:

NullArgumentException - programId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesForProgramOnDate

ProgramEntryList getProgramEntriesForProgramOnDate(Id programId,
                                                 DateTime from,
                                                 DateTime to)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

programId - a program Id

from - starting date

to - ending date

Returns:

the returned ProgramEntryList list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - programId, from , or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesForStudentAndProgram

ProgramEntryList getProgramEntriesForStudentAndProgram(Id resourceId,
                                                     Id programId)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

resourceId - a resource Id

programId - a program Id

Returns:

the returned ProgramEntryList list

Throws:

NullArgumentException - resourceId or programId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntriesForStudentAndProgramOnDate

ProgramEntryList getProgramEntriesForStudentAndProgramOnDate(Id resourceId,
                                                           Id programId,
                                                           DateTime from,
                                                           DateTime to)
                                                             throws OperationFailedException,
                                                                    PermissionDeniedException

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

Parameters:

resourceId - a resource Id

programId - a program Id

from - starting date

to - ending date

Returns:

the returned ProgramEntryList list

Throws:

InvalidArgumentException - from is greater than to

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

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramEntries

ProgramEntryList getProgramEntries()
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Returns:

a list of ProgramEntries

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.