OSID Logo
OSID Specifications
assessment package
Version 3.0.0
Release Candidate Preview
Interfaceosid.assessment.AssessmentLookupSession
Implementsosid.OsidSession
Description

This session defines methods for retrieving assessments.

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. Using an isolated view is useful for managing Assessments with the AssessmentAdminSession.
  • 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 may have a record indicated by their respective types. The record is accessed via the Assessment. 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.
MethodcanLookupAssessments
Description

Tests if this user can perform Assessment 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.
MethoduseComparativeAssessmentView
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.
MethodusePlenaryAssessmentView
Description

A complete view of the Assessment 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.
MethodgetAssessment
Description

Gets the Assessment specified by its Id. In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned Assessment may have a different Id than requested, such as the case where a duplicate Id was assigned to a Assessment and retained for compatibility.

Parametersosid.id.IdassessmentId Id of the Assessment
Returnosid.assessment.Assessmentthe assessment
ErrorsNOT_FOUND assessmentId not found
NULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentsByIds
Description

Gets an AssessmentList 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 Assessments may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListassessmentIdsthe list of Ids to retrieve
Returnosid.assessment.AssessmentListthe returned Assessment list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT assessmentIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDassessment failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsByGenusType
Description

Gets an AssessmentList corresponding to the given assessment genus Type which does not include assessments of 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 that are accessible through this session.

Parametersosid.type.TypeassessmentGenusTypean assessment genus type
Returnosid.assessment.AssessmentListthe returned Assessment list
ErrorsNULL_ARGUMENT assessmentGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsByParentGenusType
Description

Gets an AssessmentList corresponding to the given assessment 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 that are accessible through this session.

Parametersosid.type.TypeassessmentGenusTypean assessment genus type
Returnosid.assessment.AssessmentListthe returned Assessment list
ErrorsNULL_ARGUMENT assessmentGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsByRecordType
Description

Gets an AssessmentList corresponding to the given assessment record Type. The set of assessments implementing the given record type is returned. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

Parametersosid.type.TypeassessmentRecordTypean assessment record type
Returnosid.assessment.AssessmentListthe returned Assessment list
ErrorsNULL_ARGUMENT assessmentRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessments
Description

Gets all Assessments. In plenary mode, the returned list contains all known assessments or an error results. Otherwise, the returned list may contain only those assessments that are accessible through this session.

Returnosid.assessment.AssessmentLista list of Assessments
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.