OSID - osid.course.program.ProgramOfferingLookupSession Service Interface Definition

Interface	osid.course.program.ProgramOfferingLookupSession
Implements	`osid.OsidSession`
Description	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	getCourseCatalogId
Description	Gets the `CourseCatalog` `Id` associated with this session.
Return	`osid.id.Id`		the `CourseCatalog Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalog
Description	Gets the `CourseCatalog` associated with this session.
Return	`osid.course.CourseCatalog`		the course catalog
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupProgramOfferings
Description	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.
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 `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.
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 `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	`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 `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	`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 `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	`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 `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	`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 `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	`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 `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	`osid.calendaring.DateTime`	`from`	start of date range
Parameters	`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 `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	`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 `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	`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 `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	`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 `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	`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 `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	`osid.id.Id`	`programId`	a programId `Id`
Parameters	`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 `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	`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 `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.
Return	`osid.course.program.ProgramOfferingList`		a list of `ProgramOfferings`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.