OSID - osid.course.chronicle.ProgramEntryLookupSession Service Interface Definition

Interface	osid.course.chronicle.ProgramEntryLookupSession
Implements	`osid.OsidSession`
Description	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	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	canLookupProgramEntries
Description	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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeProgramEntryView
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	usePlenaryProgramEntryView
Description	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.
Method	useFederatedCourseCatalogView
Description	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.
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	useEffectiveProgramEntryView
Description	Only program entries whose effective dates are current are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyEffectiveProgramEntryView
Description	All program entries of any effective dates are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getProgramEntry
Description	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	`osid.id.Id`	`programEntryId`	the `Id` of the `ProgramEntry` to retrieve
Return	`osid.course.chronicle.ProgramEntry`		the returned `ProgramEntry`
Errors	NOT_FOUND		no `ProgramEntry` found with the given `Id`
	NULL_ARGUMENT		`programEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesByIds
Description	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	`osid.id.IdList`	`programEntryId`	the list of `Ids` to retrieve
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`programEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesByGenusType
Description	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	`osid.type.Type`	`programEntryGenusType`	a program entry genus type
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList`
Errors	NULL_ARGUMENT		`programEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesByParentGenusType
Description	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	`osid.type.Type`	`programEntryGenusType`	a program entry genus type
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList`
Errors	NULL_ARGUMENT		`programEntryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesByRecordType
Description	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	`osid.type.Type`	`programEntryRecordType`	a program entry record type
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList` list
Errors	NULL_ARGUMENT		`programEntryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesOnDate
Description	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	`osid.calendaring.DateTime`	`from`	starting date
Parameters	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList` 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	getProgramEntriesForStudent
Description	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	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesForStudentOnDate
Description	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	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, from` , or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesForProgram
Description	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	`osid.id.Id`	`programId`	a program `Id`
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList` list
Errors	NULL_ARGUMENT		`programId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesForProgramOnDate
Description	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	`osid.id.Id`	`programId`	a program `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList` 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	getProgramEntriesForStudentAndProgram
Description	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	`osid.id.Id`	`resourceId`	a resource `Id`
Parameters	`osid.id.Id`	`programId`	a program `Id`
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList` list
Errors	NULL_ARGUMENT		`resourceId` or `programId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesForStudentAndProgramOnDate
Description	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	`osid.id.Id`	`resourceId`	a resource `Id`
	`osid.id.Id`	`programId`	a program `Id`
	`osid.calendaring.DateTime`	`from`	starting date
	`osid.calendaring.DateTime`	`to`	ending date
Return	`osid.course.chronicle.ProgramEntryList`		the returned `ProgramEntryList` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, programId, from` , or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntries
Description	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.
Return	`osid.course.chronicle.ProgramEntryList`		a list of `ProgramEntries`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.