OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.AssessmentTakenLookupSession
Implementsosid.OsidSession
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.

MethodgetBankId
Description

Gets the Bank Id associated with this session.

Returnosid.id.Idthe Bank Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBank
Description

Gets the Bank associated with this session.

Returnosid.assessment.Bankthe Bank associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanLookupAssessmentsTaken
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeAssessmentTakenView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAssessmentTakenView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseFederatedBankView
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.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBankView
Description

Isolates the view for methods in this session. An isolated view restricts lookups to this bank only.

CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentTaken
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.

Parametersosid.id.IdassessmentTakenId Id of the AssessmentTaken
Returnosid.assessment.AssessmentTakenthe assessment taken
ErrorsNOT_FOUND assessmentTakenId not found
NULL_ARGUMENT assessmentTakenId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentsTakenByIds
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.

Parametersosid.id.IdListassessmentTakenIdsthe list of Ids to retrieve
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT assessmentTakenIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDassessment failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByGenusType
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.

Parametersosid.type.TypeassessmentTakenGenusTypean assessment taken genus type
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsNULL_ARGUMENT assessmentTakenGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByParentGenusType
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.

Parametersosid.type.TypeassessmentTakenGenusTypean assessment taken genus type
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsNULL_ARGUMENT assessmentTakenGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByRecordType
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.

Parametersosid.type.TypeassessmentTakenRecordTypean assessment taken record type
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsNULL_ARGUMENT assessmentTakenRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByDate
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.

Parametersosid.calendaring.DateTimefromstart date
osid.calendaring.DateTimetoend date
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenForTaker
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.

Parametersosid.id.IdresourceId Id of a Resource
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByDateForTaker
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.

Parametersosid.id.IdresourceId Id of a Resource
osid.calendaring.DateTimefromstart date
osid.calendaring.DateTimetoend date
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenForAssessment
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.

Parametersosid.id.IdassessmentId Id of an Assessment
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByDateForAssessment
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.

Parametersosid.id.IdassessmentId Id of an Assessment
osid.calendaring.DateTimefromstart date
osid.calendaring.DateTimetoend date
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT assessmentId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenForTakerAndAssessment
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.

Parametersosid.id.IdresourceId Id of a Resource
osid.id.IdassessmentId Id of an Assessment
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsNULL_ARGUMENT resourceId or assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByDateForTakerAndAssessment
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.

Parametersosid.id.IdresourceId Id of a Resource
osid.id.IdassessmentId Id of an Assessment
osid.calendaring.DateTimefromstart date
osid.calendaring.DateTimetoend date
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, assessmentId, from or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenForAssessmentOffered
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.

Parametersosid.id.IdassessmentOfferedId Id of an AssessmentOffered
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsNULL_ARGUMENT assessmentOfferedId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByDateForAssessmentOffered
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.

Parametersosid.id.IdassessmentOfferedId Id of an AssessmentOffered
osid.calendaring.DateTimefromstart date
osid.calendaring.DateTimetoend date
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT assessmentOfferedId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenForTakerAndAssessmentOffered
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.

Parametersosid.id.IdresourceId Id of a Resource
osid.id.IdassessmentOfferedId Id of an AssessmentOffered
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsNULL_ARGUMENT resourceId or assessmenOfferedtId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTakenByDateForTakerAndAssessmentOffered
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.

Parametersosid.id.IdresourceId Id of a Resource
osid.id.IdassessmentOfferedId Id of an AssessmentOffered
osid.calendaring.DateTimefromstart date
osid.calendaring.DateTimetoend date
Returnosid.assessment.AssessmentTakenListthe returned AssessmentTaken list
ErrorsINVALID_ARGUMENT from is greater than to
NULL_ARGUMENT resourceId, assessmentOfferedId, from, or to is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsTaken
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.

Returnosid.assessment.AssessmentTakenLista list of AssessmentTaken elements
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.