OSID - osid.course.TermLookupSession Service Interface Definition

Interface	osid.course.TermLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Term` objects. The `Term` represents a time period in which courses are offered. This session defines views that offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition isolated course catalog view: All term methods in this session operate, retrieve and pertain to terms defined explicitly in the current course catalog. Using an isolated view is useful for managing `Terms` with the `TermAdminSession.` federated course catalog view: All term methods in this session operate, retrieve and pertain to all terms defined in this course catalog and any other terms implicitly available in this course catalog through course catalog inheritence. Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods.
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	canLookupTerms
Description	Tests if this user can perform `Term` 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 opt not to 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	useComparativeTermView
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	usePlenaryTermView
Description	A complete view of the `Term` 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 terms in course catalogs which are children of this course 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 lookups to this course catalog only.
Compliance	`mandatory`		This method is must be implemented.
Method	getTerm
Description	Gets the `Term` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Term` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Term` and retained for compatibility.
Parameters	`osid.id.Id`	`termId`	`Id` of the `Term`
Return	`osid.course.Term`		the term
Errors	NOT_FOUND		`termId` not found
	NULL_ARGUMENT		`termId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getTermsByIds
Description	Gets a `TermList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the terms 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 `Terms` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`termIds`	the list of `Ids` to retrieve
Return	`osid.course.TermList`		the returned `Term` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`termIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTermsByGenusType
Description	Gets a `TermList` corresponding to the given term genus `Type` which does not include terms of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known terms or an error results. Otherwise, the returned list may contain only those terms that are accessible through this session.
Parameters	`osid.type.Type`	`termGenusType`	a term genus type
Return	`osid.course.TermList`		the returned `Term` list
Errors	NULL_ARGUMENT		`termGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTermsByParentGenusType
Description	Gets a `TermList` corresponding to the given term genus `Type` and include any additional terms with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known terms or an error results. Otherwise, the returned list may contain only those terms that are accessible through this session.
Parameters	`osid.type.Type`	`termGenusType`	a term genus type
Return	`osid.course.TermList`		the returned `Term` list
Errors	NULL_ARGUMENT		`termGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTermsByRecordType
Description	Gets a `TermList` containing the given term record `Type.` In plenary mode, the returned list contains all known terms or an error results. Otherwise, the returned list may contain only those terms that are accessible through this session.
Parameters	`osid.type.Type`	`termRecordType`	a term record type
Return	`osid.course.TermList`		the returned `Term` list
Errors	NULL_ARGUMENT		`termRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTermsByClassesDate
Description	Gets a `TermList` where to the given `DateTime` falls within the classes date range inclusive. Terms containing the given date are matched. In plenary mode, the returned list contains all of the terms 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 `Terms` may be omitted from the list including returning a unique set.
Parameters	`osid.calendaring.DateTime`	`datetime`	a date
Return	`osid.course.TermList`		the returned `Term` list
Errors	NULL_ARGUMENT		`datetime` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getTerms
Description	Gets all `Terms.` In plenary mode, the returned list contains all known terms or an error results. Otherwise, the returned list may contain only those terms that are accessible through this session.
Return	`osid.course.TermList`		a list of `Terms`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.