org.osid.course.program

Interface ProgramOfferingLookupSession

All Superinterfaces:

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

public interface ProgramOfferingLookupSession
extends OsidSession

This session defines methods for retrieving program offerings. A ProgramOffering is an offering of a Program in which a student can enroll.

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 offering methods in this session operate, retrieve and pertain to program offerings defined explicitly in the current course catalog. Using an isolated view is useful for managing ProgramOfferings with the ProgramOfferingAdminSession.
• federated course catalog view: All program offering lookup methods in this session operate, retrieve and pertain to all program offerings defined in this course catalog and any other courses implicitly available in this course catalog through course catalog inheritence.
• effective program offering view: All program offering lookup methods return program offerings where the current date falls within the effective dates inclusive.
• any effective program offering view: Program offerings of any effective or expired status are returned from methods.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupProgramOfferings() Tests if this user can perform ProgramOffering lookups.
CourseCatalog	getCourseCatalog() Gets the CourseCatalog associated with this session.
Id	getCourseCatalogId() Gets the CourseCatalog Id associated with this session.
ProgramOffering	getProgramOffering(Id programOfferingId) Gets the ProgramOffering specified by its Id.
ProgramOfferingList	getProgramOfferings() Gets all ProgramOfferings.
ProgramOfferingList	getProgramOfferingsByGenusType(Type programOfferingGenusType) Gets a ProgramOfferingList corresponding to the given program offering genus Type which does not include program offerings of types derived from the specified Type.
ProgramOfferingList	getProgramOfferingsByIds(IdList programOfferingIds) Gets a ProgramOfferingList corresponding to the given IdList.
ProgramOfferingList	getProgramOfferingsByParentGenusType(Type programOfferingGenusType) Gets a ProgramOfferingList corresponding to the given porgram offering genus Type and include any additional program offerings with genus types derived from the specified Type.
ProgramOfferingList	getProgramOfferingsByRecordType(Type programOfferingRecordType) Gets a ProgramOfferingList containing the given program offering record Type.
ProgramOfferingList	getProgramOfferingsForProgram(Id programId) Gets all ProgramOfferings associated with a given Program.
ProgramOfferingList	getProgramOfferingsForProgramAndTerm(Id programId, Id termId) Gets all ProgramOfferings associated with a given Term and Program.
ProgramOfferingList	getProgramOfferingsForProgramAndTermOnDate(Id programId, Id termId, DateTime from, DateTime to) Gets a ProgramOfferingList for the given program, term, and effective within the given date range inclusive.
ProgramOfferingList	getProgramOfferingsForProgramOnDate(Id programId, DateTime from, DateTime to) Gets a ProgramOfferingList for the given program and effective within the given date range inclusive.
ProgramOfferingList	getProgramOfferingsForTerm(Id termId) Gets all ProgramOfferings associated with a given Term.
ProgramOfferingList	getProgramOfferingsForTermOnDate(Id termId, DateTime from, DateTime to) Gets a ProgramOfferingList for the given term and effective within the given date range inclusive.
ProgramOfferingList	getProgramOfferingsOnDate(DateTime from, DateTime to) Gets a ProgramOfferingList effective within the given date range inclusive.
void	useAnyEffectiveProgramOfferingView() All methods return program offerings of any effective or expired status.
void	useComparativeProgramOfferingView() 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	useEffectiveProgramOfferingView() All program offering methods return program offerings where the current date falls within the effective dates inclusive.
void	useFederatedCourseCatalogView() Federates the view for methods in this session.
void	useIsolatedCourseCatalogView() Isolates the view for methods in this session.
void	usePlenaryProgramOfferingView() A complete view of the ProgramOffering 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.

canLookupProgramOfferings

boolean canLookupProgramOfferings()

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

useComparativeProgramOfferingView

void useComparativeProgramOfferingView()

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.

usePlenaryProgramOfferingView

void usePlenaryProgramOfferingView()

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

useEffectiveProgramOfferingView

void useEffectiveProgramOfferingView()

All program offering methods return program offerings where the current date falls within the effective dates inclusive.

Compliance:

mandatory - This method is must be implemented.

useAnyEffectiveProgramOfferingView

void useAnyEffectiveProgramOfferingView()

All methods return program offerings of any effective or expired status.

Compliance:

mandatory - This method is must be implemented.

getProgramOffering

ProgramOffering getProgramOffering(Id programOfferingId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Gets the ProgramOffering specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned ProgramOffering may have a different Id than requested, such as the case where a duplicate Id was assigned to a program and retained for compatibility. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

programOfferingId - the Id of the ProgramOffering to retrieve

Returns:

the returned ProgramOffering

Throws:

NotFoundException - no ProgramOffering found with the given Id

NullArgumentException - programOfferingId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsByIds

ProgramOfferingList getProgramOfferingsByIds(IdList programOfferingIds)
                                             throws NotFoundException,
                                                    OperationFailedException,
                                                    PermissionDeniedException

Gets a ProgramOfferingList corresponding to the given IdList. In plenary mode, the returned list contains all of the program offerings 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 ProgramOfferings may be omitted from the list and may present the elements in any order including returning a unique set. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

programOfferingIds - the list of Ids to retrieve

Returns:

the returned ProgramOffering list

Throws:

NotFoundException - an Id was not found

NullArgumentException - programOfferingIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsByGenusType

ProgramOfferingList getProgramOfferingsByGenusType(Type programOfferingGenusType)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

Gets a ProgramOfferingList corresponding to the given program offering genus Type which does not include program offerings of types derived from the specified Type. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

programOfferingGenusType - a program offering genus type

Returns:

the returned ProgramOffering list

Throws:

NullArgumentException - programOfferingGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsByParentGenusType

ProgramOfferingList getProgramOfferingsByParentGenusType(Type programOfferingGenusType)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Gets a ProgramOfferingList corresponding to the given porgram offering genus Type and include any additional program offerings with genus types derived from the specified Type. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

programOfferingGenusType - a program offering genus type

Returns:

the returned ProgramOffering list

Throws:

NullArgumentException - programOfferingGenusType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsByRecordType

ProgramOfferingList getProgramOfferingsByRecordType(Type programOfferingRecordType)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets a ProgramOfferingList containing the given program offering record Type. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

programOfferingRecordType - a program offering record type

Returns:

the returned ProgramOffering list

Throws:

NullArgumentException - programOfferingRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsOnDate

ProgramOfferingList getProgramOfferingsOnDate(DateTime from,
                                            DateTime to)
                                              throws OperationFailedException,
                                                     PermissionDeniedException

Gets a ProgramOfferingList effective within the given date range inclusive. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

from - start of date range

to - end of date range

Returns:

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

getProgramOfferingsForProgram

ProgramOfferingList getProgramOfferingsForProgram(Id programId)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Gets all ProgramOfferings associated with a given Program. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session.

Parameters:

programId - a program Id

Returns:

a list of ProgramOfferings

Throws:

NullArgumentException - programId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsForProgramOnDate

ProgramOfferingList getProgramOfferingsForProgramOnDate(Id programId,
                                                      DateTime from,
                                                      DateTime to)
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets a ProgramOfferingList for the given program and effective within the given date range inclusive. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

programId - a program Id

from - start of date range

to - end of date range

Returns:

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

getProgramOfferingsForTerm

ProgramOfferingList getProgramOfferingsForTerm(Id termId)
                                               throws OperationFailedException,
                                                      PermissionDeniedException

Gets all ProgramOfferings associated with a given Term. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

termId - a term Id

Returns:

a list of ProgramOfferings

Throws:

NullArgumentException - termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsForTermOnDate

ProgramOfferingList getProgramOfferingsForTermOnDate(Id termId,
                                                   DateTime from,
                                                   DateTime to)
                                                     throws OperationFailedException,
                                                            PermissionDeniedException

Gets a ProgramOfferingList for the given term and effective within the given date range inclusive. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

termId - a term Id

from - start of date range

to - end of date range

Returns:

the returned ProgramOffering list

Throws:

InvalidArgumentException - from is greater than to

NullArgumentException - termId, from, or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsForProgramAndTerm

ProgramOfferingList getProgramOfferingsForProgramAndTerm(Id programId,
                                                       Id termId)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

Gets all ProgramOfferings associated with a given Term and Program. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

programId - a programId Id

termId - a term Id

Returns:

a list of ProgramOfferings

Throws:

NullArgumentException - programId or termId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferingsForProgramAndTermOnDate

ProgramOfferingList getProgramOfferingsForProgramAndTermOnDate(Id programId,
                                                             Id termId,
                                                             DateTime from,
                                                             DateTime to)
                                                               throws OperationFailedException,
                                                                      PermissionDeniedException

Gets a ProgramOfferingList for the given program, term, and effective within the given date range inclusive. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Parameters:

programId - a program Id

termId - a term Id

from - start of date range

to - end of date range

Returns:

the returned ProgramOffering list

Throws:

InvalidArgumentException - from is greater than to

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

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getProgramOfferings

ProgramOfferingList getProgramOfferings()
                                        throws OperationFailedException,
                                               PermissionDeniedException

Gets all ProgramOfferings. In plenary mode, the returned list contains all known program offerings or an error results. Otherwise, the returned list may contain only those program offerings that are accessible through this session. In effective mode, program offerings are returned where the current date falls within the effective dates inclusive. In any effective mode, effective and expired program offerings are returned.

Returns:

a list of ProgramOfferings

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.