OSID - osid.assessment.AssessmentTakenLookupSession Service Interface Definition

Interface	osid.assessment.AssessmentTakenLookupSession
Implements	`osid.OsidSession`
Used By	`osid.assessment.AssessmentManager`
Used By	`osid.assessment.AssessmentProxyManager`
Description	This session defines methods for retrieving assessments taken. 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 bank view: All assessment methods in this session operate, retrieve and pertain to assessments defined explicitly in the current bank. federated bank view: All assessment methods in this session operate, retrieve and pertain to all assessments defined in this bank and any other assessments implicitly available in this bank through bank inheritence. The methods `useFederatedBankView()` and `useIsolatedBankView()` behave as a radio group and one should be selected before invoking any lookup methods. Assessments taken may have a record indicated by their respective record types. The record is accessed via the `AssessmentTaken`. The returns may not be cast directly from the returns in the lookup methods.
Method	getBankId
Description	Gets the `Bank` `Id` associated with this session.
Return	`osid.id.Id`		the `Bank Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getBank
Description	Gets the `Bank` associated with this session.
Return	`osid.assessment.Bank`		the `Bank` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupAssessmentsTaken
Description	Tests if this user can perform `AssessmentTaken` 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	useComparativeAssessmentTakenView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as assessment, 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	usePlenaryAssessmentTakenView
Description	A complete view of the `AssessmentTaken` 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	useFederatedBankView
Description	Federates the view for methods in this session. A federated view will include assessments in banks which are children of this bank in the bank hierarchy.
Compliance	`mandatory`		This method is must be implemented.
Method	useIsolatedBankView
Description	Isolates the view for methods in this session. An isolated view restricts lookups to this bank only.
Compliance	`mandatory`		This method is must be implemented.
Method	getAssessmentTaken
Description	Gets the `AssessmentTaken` specified by its `Id`. In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `AssessmentTaken` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `AssessmentTaken` and retained for compatibility.
Parameters	`osid.id.Id`	`assessmentTakenId`	`Id` of the `AssessmentTaken`
Return	`osid.assessment.AssessmentTaken`		the assessment taken
Errors	NOT_FOUND		`assessmentTakenId` not found
	NULL_ARGUMENT		`assessmentTakenId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method is must be implemented.
Method	getAssessmentsTakenByIds
Description	Gets an `AssessmentTakenList` corresponding to the given `IdList`.In plenary mode, the returned list contains all of the assessments 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 `AssessmentTaken` objects may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`assessmentTakenIds`	the list of `Ids` to retrieve
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken list`
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`assessmentTakenIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		assessment failure
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByGenusType
Description	Gets an `AssessmentTakenList` corresponding to the given assessment taken genus `Type` which does not include assessments of types derived from the specified `Type`. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.type.Type`	`assessmentTakenGenusType`	an assessment taken genus type
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken list`
Errors	NULL_ARGUMENT		`assessmentTakenGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByParentGenusType
Description	Gets an `AssessmentTakenList` corresponding to the given assessment taken genus `Type` and include any additional assessments with genus types derived from the specified `Type`. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.type.Type`	`assessmentTakenGenusType`	an assessment taken genus type
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken list`
Errors	NULL_ARGUMENT		`assessmentTakenGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByRecordType
Description	Gets an `AssessmentTakenList` corresponding to the given assessment taken record `Type`. The set of assessments implementing the given record type is returned. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session. In both cases, the order of the set is not specified.
Parameters	`osid.type.Type`	`assessmentTakenRecordType`	an assessment taken record type
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	NULL_ARGUMENT		`assessmentTakenRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByDate
Description	Gets an `AssessmentTakenList` started in the given date range inclusive. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session. In both cases, the order of the set is not specified.
Parameters	`osid.calendaring.DateTime`	`from`	start date
Parameters	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` 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 occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenForTaker
Description	Gets an `AssessmentTakenList` for the given resource. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByDateForTaker
Description	Gets an `AssessmentTakenList` started in the given date range inclusive for the given resource. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` 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 occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenForAssessment
Description	Gets an `AssessmentTakenList` for the given assessment. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`assessmentId`	`Id` of an `Assessment`
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	NULL_ARGUMENT		`assessmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByDateForAssessment
Description	Gets an `AssessmentTakenList` started in the given date range inclusive for the given assessment. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`assessmentId`	`Id` of an `Assessment`
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`assessmentId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenForTakerAndAssessment
Description	Gets an `AssessmentTakenList` for the given resource and assessment. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Parameters	`osid.id.Id`	`assessmentId`	`Id` of an `Assessment`
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	NULL_ARGUMENT		`resourceId` or `assessmentId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByDateForTakerAndAssessment
Description	Gets an `AssessmentTakenList` started in the given date range inclusive for the given resource and assessment. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
	`osid.id.Id`	`assessmentId`	`Id` of an `Assessment`
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, assessmentId, from` or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenForAssessmentOffered
Description	Gets an `AssessmentTakenList` by the given assessment offered. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`assessmentOfferedId`	`Id` of an `AssessmentOffered`
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	NULL_ARGUMENT		`assessmentOfferedId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByDateForAssessmentOffered
Description	Gets an `AssessmentTakenList` started in the given date range inclusive for the given assessment offered. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`assessmentOfferedId`	`Id` of an `AssessmentOffered`
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`assessmentOfferedId, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenForTakerAndAssessmentOffered
Description	Gets an `AssessmentTakenList` for the given resource and assessment offered. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
Parameters	`osid.id.Id`	`assessmentOfferedId`	`Id` of an `AssessmentOffered`
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	NULL_ARGUMENT		`resourceId` or `assessmenOfferedtId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTakenByDateForTakerAndAssessmentOffered
Description	Gets an `AssessmentTakenList` started in the given date range inclusive for the given resource and assessment offered. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	`Id` of a `Resource`
	`osid.id.Id`	`assessmentOfferedId`	`Id` of an `AssessmentOffered`
	`osid.calendaring.DateTime`	`from`	start date
	`osid.calendaring.DateTime`	`to`	end date
Return	`osid.assessment.AssessmentTakenList`		the returned `AssessmentTaken` list
Errors	INVALID_ARGUMENT		`from` is greater than `to`
	NULL_ARGUMENT		`resourceId, assessmentOfferedId, from`, or `to` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.
Method	getAssessmentsTaken
Description	Gets all `AssessmentTaken` elements. In plenary mode, the returned list contains all known assessments taken or an error results. Otherwise, the returned list may contain only those assessments taken that are accessible through this session.
Return	`osid.assessment.AssessmentTakenList`		a list of `AssessmentTaken` elements
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure occurred
Compliance	`mandatory`		This method must be implemented.