Interface | osid.course.program.ProgramOfferingLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving program
offerings. A This lookup session defines several views:
The methods Courses may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
Method | getCourseCatalogId | ||
Description |
Gets the | ||
Return | osid.id.Id | the CourseCatalog Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getCourseCatalog | ||
Description |
Gets the | ||
Return | osid.course.CourseCatalog | the course catalog | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupProgramOfferings | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeProgramOfferingView | ||
Description |
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. | |
Method | usePlenaryProgramOfferingView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedCourseCatalogView | ||
Description |
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. | |
Method | useIsolatedCourseCatalogView | ||
Description |
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. | |
Method | useEffectiveProgramOfferingView | ||
Description |
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. | |
Method | useAnyEffectiveProgramOfferingView | ||
Description |
All methods return program offerings of any effective or expired status. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getProgramOffering | ||
Description |
Gets the 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 | osid.id.Id | programOfferingId | the Id of the ProgramOffering to retrieve |
Return | osid.course.program.ProgramOffering | the returned ProgramOffering | |
Errors | NOT_FOUND | no ProgramOffering found with the given Id | |
NULL_ARGUMENT | programOfferingId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsByIds | ||
Description |
Gets a 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 | osid.id.IdList | programOfferingIds | the list of Ids to retrieve |
Return | osid.course.program.ProgramOfferingList | the returned ProgramOffering list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | programOfferingIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsByGenusType | ||
Description |
Gets a 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 | osid.type.Type | programOfferingGenusType | a program offering genus type |
Return | osid.course.program.ProgramOfferingList | the returned ProgramOffering list | |
Errors | NULL_ARGUMENT | programOfferingGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsByParentGenusType | ||
Description |
Gets a 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 | osid.type.Type | programOfferingGenusType | a program offering genus type |
Return | osid.course.program.ProgramOfferingList | the returned ProgramOffering list | |
Errors | NULL_ARGUMENT | programOfferingGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsByRecordType | ||
Description |
Gets a 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 | osid.type.Type | programOfferingRecordType | a program offering record type |
Return | osid.course.program.ProgramOfferingList | the returned ProgramOffering list | |
Errors | NULL_ARGUMENT | programOfferingRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsOnDate | ||
Description |
Gets a 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 | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.program.ProgramOfferingList | the returned ProgramOffering list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsForProgram | ||
Description |
Gets all | ||
Parameters | osid.id.Id | programId | a program Id |
Return | osid.course.program.ProgramOfferingList | a list of ProgramOfferings | |
Errors | NULL_ARGUMENT | programId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsForProgramOnDate | ||
Description |
Gets a 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 | osid.id.Id | programId | a program Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.program.ProgramOfferingList | the returned ProgramOffering list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | programId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsForTerm | ||
Description |
Gets all 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 | osid.id.Id | termId | a term Id |
Return | osid.course.program.ProgramOfferingList | a list of ProgramOfferings | |
Errors | NULL_ARGUMENT | termId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsForTermOnDate | ||
Description |
Gets a 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 | osid.id.Id | termId | a term Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.program.ProgramOfferingList | the returned ProgramOffering list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | termId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsForProgramAndTerm | ||
Description |
Gets all 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 | osid.id.Id | programId | a programId Id |
osid.id.Id | termId | a term Id | |
Return | osid.course.program.ProgramOfferingList | a list of ProgramOfferings | |
Errors | NULL_ARGUMENT | programId or termId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferingsForProgramAndTermOnDate | ||
Description |
Gets a 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 | osid.id.Id | programId | a program Id |
osid.id.Id | termId | a term Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.course.program.ProgramOfferingList | the returned ProgramOffering list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | programId, termId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getProgramOfferings | ||
Description |
Gets all 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. | ||
Return | osid.course.program.ProgramOfferingList | a list of ProgramOfferings | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |