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

This session provides methods for retrieving Item objects.

This session defines two sets of views which offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete and ordered result set or is an error condition
  • isolated assessment bank view: All assessment item methods in this session operate, retrieve and pertain to assessment items defined explicitly in the current bank. Using an isolated view is useful for managing items with the ItemAdminSession.
  • federated assessment bank view: All assessment item methods in this session operate, retrieve and pertain to all assessment items defined in this assessment bank and any other assessment banks implicitly available in this assessment bank through assessment bank inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there a particular element is inaccessible. For example, a hierarchy output can be plugged into a lookup method to retrieve all objects known to a hierarchy, but it may not be necessary to break execution if a node from the hierarchy no longer exists. However, some administrative applications may need to know whether it had retrieved an entire set of objects and may sacrifice some interoperability for the sake of precision.

Items may have an additional records indicated by their respective record types.

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

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

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

A complete view of the Item 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 items in assessment banks which are children of this assessment bank in the assessment 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 assessment bank only.

CompliancemandatoryThis method is must be implemented.
MethodgetItem
Description

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

Parametersosid.id.IditemIdthe Id of the Item to retrieve
Returnosid.assessment.Itemthe returned Item
ErrorsNOT_FOUNDno Item found with the given Id
NULL_ARGUMENT itemId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetItemsByIds
Description

Gets an ItemList corresponding to the given IdList. In plenary mode, the returned list contains all of the items 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 Items may be omitted from the list and may present the elements in any order including returning a unique set.

Parametersosid.id.IdListitemIdsthe list of Ids to retrieve
Returnosid.assessment.ItemListthe returned Item list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT itemIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetItemsByGenusType
Description

Gets an ItemList corresponding to the given assessment item genus Type which does not include assessment items of genus types derived from the specified Type. In plenary mode, the returned list contains all known assessment items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parametersosid.type.TypeitemGenusTypean assessment item genus type
Returnosid.assessment.ItemListthe returned Item list
ErrorsNULL_ARGUMENT itemGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetItemsByParentGenusType
Description

Gets an ItemList corresponding to the given assessment item genus Type and include any additional assessment items with genus types derived from the specified Type. In plenary mode, the returned list contains all known assessment items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parametersosid.type.TypeitemGenusTypean assessment item genus type
Returnosid.assessment.ItemListthe returned Item list
ErrorsNULL_ARGUMENT itemGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetItemsByRecordType
Description

Gets an ItemList containing the given assessment item record Type. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parametersosid.type.TypeitemRecordTypean item record type
Returnosid.assessment.ItemListthe returned Item list
ErrorsNULL_ARGUMENT itemRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetItemsByQuestion
Description

Gets an ItemList containing the given question. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parametersosid.id.IdquestionIda question Id
Returnosid.assessment.ItemListthe returned Item list
ErrorsNULL_ARGUMENT questionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetItemsByAnswer
Description

Gets an ItemList containing the given answer. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parametersosid.id.IdanswerIdan answer Id
Returnosid.assessment.ItemListthe returned Item list
ErrorsNULL_ARGUMENT answerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetItemsByLearningObjective
Description

Gets an ItemList containing the given learning objective. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parametersosid.id.IdobjectiveIda learning objective Id
Returnosid.assessment.ItemListthe returned Item list
ErrorsNULL_ARGUMENT objectiveId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetItemsByLearningObjectives
Description

Gets an ItemList containing the given learning objectives. In plenary mode, the returned list contains all known items or an error results. Otherwise, the returned list may contain only those assessment items that are accessible through this session.

Parametersosid.id.IdListobjectiveIdsa list of learning objective Ids
Returnosid.assessment.ItemListthe returned Item list
ErrorsNULL_ARGUMENT objectiveIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetItems
Description

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

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