OSID - osid.grading.transform.GradeSystemTransformLookupSession Service Interface Definition

Interface	osid.grading.transform.GradeSystemTransformLookupSession
Implements	`osid.OsidSession`
Description	The session defines methods for retrieving `GradeSystemTransformations.` Two views are defined in this session: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete set or is an error condition federated gradebook view: lookups include grade system transformations from this gradebook and other gradebooks which are children of this gradebook in the gradebook hierarchy isolated gradebook view: lookups include only those grade system transformations defined in this gradebook active grade system transormations view: All grade system transormation lookup methods return active grade system transormations. any status grade system transormations view: Grade system transormations of any active or inactive status are returned from methods. Grades system transformations may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the object.
Method	getGradebookId
Description	Gets the `Gradebook` `Id` associated with this session.
Return	`osid.id.Id`		the `Gradebook Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getGradebook
Description	Gets the `Gradebook` associated with this session.
Return	`osid.grading.Gradebook`		the `Gradebook` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupGradeSystemTransforms
Description	Tests if this user can lookup grade articulations. 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 articulation lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedGradebookView
Description	Federates the view for methods in this session. A federated view will include notifications for grade system transformations in gradebooks which are children of this gradebook in the gradebook hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedGradebookView
Description	Isolates the view for methods in this session. An isolated view restricts grade system transformations to this gradebook only.
Compliance	`mandatory`		This method is must be implemented.
Method	useComparativeGradeSystemTransformView
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	usePlenaryGradeSystemTransformView
Description	A complete view of the `GradeSystemTransform` 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	useActiveGradeSystemTransformView
Description	Only active grade system transformations are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	useAnyStatusGradeSystemTransformView
Description	All active and inactive grade system transformations are returned by methods in this session.
Compliance	`mandatory`		This method is must be implemented.
Method	getGradeSystemTransform
Description	Gets the `GradeSystemTransform` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `GradeSystemTransform` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `GradeSystemTransform` and retained for compatibility.
Parameters	`osid.id.Id`	`gradeSystemTransformId`	`Id` of the `GradeSystemTransform`
Return	`osid.grading.transform.GradeSystemTransform`		the grade system transorm
Errors	NOT_FOUND		`gradeSystemTransformId` not found
	NULL_ARGUMENT		`gradeSystemTransformId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getGradeSystemTransformsByIds
Description	Gets a `GradeSystemTransformList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the transforms 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 `GradeSystemTransforms` may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`gradeSystemTransformIdList`	the list of `Ids` to retrieve
Return	`osid.grading.transform.GradeSystemTransformList`		the returned `GradeSystemTransform` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`gradeSystemTransformIdList` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemTransformsByGenusType
Description	Gets a `GradeSystemTransformList` corresponding to the given grade system transform genus `Type` which does not include transforms of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known transforms or an error results. Otherwise, the returned list may contain only those transforms that are accessible through this session.
Parameters	`osid.type.Type`	`gradeSystemTransformGenusType`	a grade system transform genus type
Return	`osid.grading.transform.GradeSystemTransformList`		the returned `GradeSystemTransform` list
Errors	NULL_ARGUMENT		`gradeSystemTransformGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemTransformsByParentGenusType
Description	Gets a `GradeSystemTransformList` corresponding to the given grade system transform genus `Type` and include any additional transforms with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known transforms or an error results. Otherwise, the returned list may contain only those transforms that are accessible through this session.
Parameters	`osid.type.Type`	`gradeSystemTransformGenusType`	a grade system transform genus type
Return	`osid.grading.transform.GradeSystemTransformList`		the returned `GradeSystemTransform` list
Errors	NULL_ARGUMENT		`gradeSystemTransformGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemTransformsByRecordType
Description	Gets a `GradeSystemTransformList` containing the given grade record `Type.` In plenary mode, the returned list contains all known transforms or an error results. Otherwise, the returned list may contain only those transforms that are accessible through this session.
Parameters	`osid.type.Type`	`gradeSystemTransformRecordType`	a grade system transform record type
Return	`osid.grading.transform.GradeSystemTransformList`		the returned `GradeSystemTransform` list
Errors	NULL_ARGUMENT		`gradeSystemTransformGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemTransformsBySource
Description	Gets the grade system transforms from the source grade system. In plenary mode, the returned list contains all known grade system transforms or an error results. Otherwise, the returned list may contain only those grade system transforms that are accessible through this session.
Parameters	`osid.id.Id`	`sourceGradeSystemId`	the source grade system
Return	`osid.grading.transform.GradeSystemTransformList`		the returned `GradeSystemTransform` list
Errors	NOT_FOUND		`sourceGradeSystemId` not found
	NULL_ARGUMENT		`sourceGradeSystemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemTransformBySystems
Description	Gets a grade system transform by its source and target grade systems. In plenary mode, the returned list contains all known grade system transforms or an error results. Otherwise, the returned list may contain only those grade system transforms that are accessible through this session.
Parameters	`osid.id.Id`	`sourceGradeSystemId`	the source grade system
Parameters	`osid.id.Id`	`targetGradeSystemId`	the target grade system
Return	`osid.grading.transform.GradeSystemTransform`		the returned `GradeSystemTransform`
Errors	NOT_FOUND		transform not found
	NULL_ARGUMENT		`sourceGradeSystemId` or `targetGradeSystemId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getGradeSystemTransforms
Description	Gets all `GradeSystemTransforms.` In plenary mode, the returned list contains all known grade system transforms or an error results. Otherwise, the returned list may contain only those grade system transforms that are accessible through this session.
Return	`osid.grading.transform.GradeSystemTransformList`		a `GradeSystemTransformList`
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.