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

Interface	osid.course.program.CredentialLookupSession
Implements	`osid.OsidSession`
Description	This session defines methods for retrieving credentials. A `Credential` is an award granted at he completion of a program. 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 credential methods in this session operate, retrieve and pertain to credential defined explicitly in the current course catalog. Using an isolated view is useful for managing `Credentials` with the `CredentialAdminSession.` federated course catalog view: All credentials lookup methods in this session operate, retrieve and pertain to all credentials defined in this course catalog and any other credentials implicitly available in this course catalog through course catalog inheritence. The methods `useFederatedCourseCatalogView()` and `useIsolatedCourseCatalogView()` behave as a radio group and one should be selected before invoking any lookup methods. Credentials may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the `Credential.`
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	canLookupCredentials
Description	Tests if this user can perform `Credential` 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	useComparativeCredentialView
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	usePlenaryCredentialView
Description	A complete view of the `credential` 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 credentials 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	getCredential
Description	Gets the `Credential` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Credential` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Credential` and retained for compatibility.
Parameters	`osid.id.Id`	`credentialId`	the `Id` of the `Credential` to retrieve
Return	`osid.course.program.Credential`		the returned `Credential`
Errors	NOT_FOUND		no `Credential` found with the given `Id`
	NULL_ARGUMENT		`credentialId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialsByIds
Description	Gets a `CredentialList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the credentials 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 `Credentials` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`credentialIds`	the list of `Ids` to retrieve
Return	`osid.course.program.CredentialList`		the returned `CredentialList` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`credentialIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialsByGenusType
Description	Gets a `CredentialList` corresponding to the given credential genus `Type` which does not include credentials of types derived from the specified `Type.` In plenary mode, the returned list contains all known credentials or an error results. Otherwise, the returned list may contain only those credentials that are accessible through this session.
Parameters	`osid.type.Type`	`credentialGenusType`	a credential genus type
Return	`osid.course.program.CredentialList`		the returned `CredentialList` list
Errors	NULL_ARGUMENT		`credentialGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialsByParentGenusType
Description	Gets a `CredentialList` corresponding to the given credential genus `Type` and include any additional credentials with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known credentials or an error results. Otherwise, the returned list may contain only those credentials that are accessible through this session.
Parameters	`osid.type.Type`	`credentialGenusType`	a credential genus type
Return	`osid.course.program.CredentialList`		the returned `CredentialList` list
Errors	NULL_ARGUMENT		`credentialGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCredentialsByRecordType
Description	Gets a `CredentialList` containing the given credential record `Type.` In plenary mode, the returned list contains all known credentials or an error results. Otherwise, the returned list may contain only those credentials that are accessible through this session.
Parameters	`osid.type.Type`	`credentialRecordType`	a credential record type
Return	`osid.course.program.CredentialList`		the returned `CredentialList` list
Errors	NULL_ARGUMENT		`credentialRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getCredentials
Description	Gets all `Credentials.` In plenary mode, the returned list contains all known credentials or an error results. Otherwise, the returned list may contain only those credentials that are accessible through this session.
Return	`osid.course.program.CredentialList`		a list of `Credentials`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.