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

Interface	osid.course.chronicle.ProgramEntryCourseCatalogSession
Implements	`osid.OsidSession`
Description	This session provides methods to retrieve `ProgramEntry` to `CourseCatalog` mappings. A `ProgramEntry` may appear in multiple `CourseCatalog` objects. Each catalog may have its own authorizations governing who is allowed to look at it. 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
Method	canLookupCourseCatalogMappings
Description	Tests if this user can perform lookups of program entry/course catalog mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
Return	`boolean`		`false` if looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useComparativeCourseCatalogView
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	usePlenaryCourseCatalogView
Description	A complete view of the `ProgramEntry` and `CourseCatalog` 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	getProgramEntryIdsByCourseCatalog
Description	Gets the list of `ProgramEntry Ids` associated with a `CourseCatalog.`
Parameters	`osid.id.Id`	`courseCatalogId`	`Id` of the `CourseCatalog`
Return	`osid.id.IdList`		list of related program entry `Ids`
Errors	NOT_FOUND		`courseCatalogId` is not found
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesByCourseCatalog
Description	Gets the list of `ProgramEntries` associated with a `CourseCatalog.`
Parameters	`osid.id.Id`	`courseCatalogId`	`Id` of the `CourseCatalog`
Return	`osid.course.chronicle.ProgramEntryList`		list of related program entries
Errors	NOT_FOUND		`courseCatalogId` is not found
	NULL_ARGUMENT		`courseCatalogId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntryIdsByCourseCatalogs
Description	Gets the list of `ProgramEntry Ids` corresponding to a list of `CourseCatalog` objects.
Parameters	`osid.id.IdList`	`courseCatalogIds`	list of course catalog `Ids`
Return	`osid.id.IdList`		list of program entry `Ids`
Errors	NULL_ARGUMENT		`courseCatalogIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getProgramEntriesByCourseCatalogs
Description	Gets the list of `ProgramEntries` corresponding to a list of `CourseCatalog` objects.
Parameters	`osid.id.IdList`	`courseCatalogIds`	list of course catalog `Ids`
Return	`osid.course.chronicle.ProgramEntryList`		list of programe ntries
Errors	NULL_ARGUMENT		`courseCatalogIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCourseCatalogIdsByProgramEntry
Description	Gets the `CourseCatalog` `Ids` mapped to a `ProgramEntry.`
Parameters	`osid.id.Id`	`programEntryId`	`Id` of a `pProgramEntry`
Return	`osid.id.IdList`		list of course catalog `Ids`
Errors	NOT_FOUND		`programEntryId` is 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	getCourseCatalogsByProgramEntry
Description	Gets the `CourseCatalog` objects mapped to a `ProgramEntry.`
Parameters	`osid.id.Id`	`programEntryId`	`Id` of a `ProgramEntry`
Return	`osid.course.CourseCatalogList`		list of course catalogs
Errors	NOT_FOUND		`programEntryId` is not found
	NULL_ARGUMENT		`programEntryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.