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

This session defines methods for retrieving assessment parts.

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 part methods in this session operate, retrieve and pertain to assessment parts defined explicitly in the current bank.
  • federated bank view: All assessment part lookup methods in this session operate, retrieve and pertain to all assessment part defined in this bank and any other assessment parts implicitly available in this bank through bank inheritence.
  • active assessment part view: All assessment part lookup methods return active assessment parts.
  • any status assessment part view: Assessment parts of any active or inactive status are returned from methods.
  • sequestered assessment part viiew: All assessment part methods suppress sequestered assessment parts.
  • unsequestered assessment part view: All assessment part methods return all assessment parts.

The methods useFederatedBankView() and useIsolatedBankView() behave as a radio group and one should be selected before invoking any lookup methods.

Assessment parts may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the AssessmentPart.

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.
MethodcanLookupAssessmentParts
Description

Tests if this user can perform AssessmentPart 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.

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

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryAssessmentPartView
Description

A complete view of the AssessmentPart 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 assessment parts in catalogs which are children of this catalog in the bank hierarchy.

CompliancemandatoryThis method is must be implemented.
MethoduseIsolatedBankView
Description

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

CompliancemandatoryThis method is must be implemented.
MethoduseActiveAssessmentPartView
Description

Only active assessment parts are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseAnyStatusAssessmentPartView
Description

All active and inactive assessment parts are returned by methods in this session.

CompliancemandatoryThis method is must be implemented.
MethoduseSequesteredAssessmentPartView
Description

The methods in this session omit sequestered assessment parts.

CompliancemandatoryThis method is must be implemented.
MethoduseUnsequesteredAssessmentPartView
Description

The methods in this session return all assessment parts, including sequestered assessment parts.

CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentPart
Description

Gets the AssessmentPart specified by its Id.

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

In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned.

In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.

Parametersosid.id.IdassessmentPartIdthe Id of the AssessmentPart to retrieve
Returnosid.assessment.authoring.AssessmentPartthe returned AssessmentPart
ErrorsNOT_FOUNDno AssessmentPart found with the given Id
NULL_ARGUMENT assessmentPartId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentPartsByIds
Description

Gets an AssessmentPartList corresponding to the given IdList.

In plenary mode, the returned list contains all of the assessment parts 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 AssessmentParts may be omitted from the list and may present the elements in any order including returning a unique set.

In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned.

In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.

Parametersosid.id.IdListassessmentPartIdsthe list of Ids to retrieve
Returnosid.assessment.authoring.AssessmentPartListthe returned AssessmentPart list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT assessmentPartIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentPartsByGenusType
Description

Gets an AssessmentPartList corresponding to the given assessment part genus Type which does not include assessment parts of types derived from the specified Type.

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

In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned.

In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.

Parametersosid.type.TypeassessmentPartGenusTypean assessment part genus type
Returnosid.assessment.authoring.AssessmentPartListthe returned AssessmentPart list
ErrorsNULL_ARGUMENT assessmentPartGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentPartsByParentGenusType
Description

Gets an AssessmentPartList corresponding to the given assessment part genus Type and include any additional assessment parts with genus types derived from the specified Type.

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

In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned.

In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.

Parametersosid.type.TypeassessmentGenusTypean assessment part genus type
Returnosid.assessment.authoring.AssessmentPartListthe returned AssessmentPart list
ErrorsNULL_ARGUMENT assessmentPartGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentPartsByRecordType
Description

Gets an AssessmentPart containing the given assessment part record Type.

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

In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned.

In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.

Parametersosid.type.TypeassessmentPartRecordTypean assessment part record type
Returnosid.assessment.authoring.AssessmentPartListthe returned AssessmentPart list
ErrorsNULL_ARGUMENT assessmentPartRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentPartsForAssessment
Description

Gets an AssessmentPart for the given assessment.

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

In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned.

In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.

Parametersosid.id.IdassessmentIdan assessment Id
Returnosid.assessment.authoring.AssessmentPartListthe returned AssessmentPart list
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentParts
Description

Gets all AssessmentParts.

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

In active mode, assessment parts are returned that are currently active. In any effective mode, active and inactive assessment parts are returned.

In sequestered mode, no sequestered assessment parts are returned. In unsequestered mode, all assessment parts are returned.

Returnosid.assessment.authoring.AssessmentPartLista list of AssessmentParts
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.