Interface | osid.assessment.ItemLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines two sets of views which offer differing behaviors when retrieving multiple objects.
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. | ||
Method | getBankId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Bank Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getBank | ||
Description |
Gets the | ||
Return | osid.assessment.Bank | the Bank associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupItems | ||
Description |
Tests if this user can perform | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeItemView | ||
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 | usePlenaryItemView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedBankView | ||
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. | ||
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 assessment bank only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getItem | ||
Description |
Gets the | ||
Parameters | osid.id.Id | itemId | the Id of the Item to retrieve |
Return | osid.assessment.Item | the returned Item | |
Errors | NOT_FOUND | no Item found with the given Id | |
NULL_ARGUMENT | itemId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | itemIds | the list of Ids to retrieve |
Return | osid.assessment.ItemList | the returned Item list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | itemIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | itemGenusType | an assessment item genus type |
Return | osid.assessment.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | itemGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | itemGenusType | an assessment item genus type |
Return | osid.assessment.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | itemGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | itemRecordType | an item record type |
Return | osid.assessment.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | itemRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByQuestion | ||
Description |
Gets an | ||
Parameters | osid.id.Id | questionId | a question Id |
Return | osid.assessment.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | questionId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByAnswer | ||
Description |
Gets an | ||
Parameters | osid.id.Id | answerId | an answer Id |
Return | osid.assessment.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | answerId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByLearningObjective | ||
Description |
Gets an | ||
Parameters | osid.id.Id | objectiveId | a learning objective Id |
Return | osid.assessment.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | objectiveId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItemsByLearningObjectives | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | objectiveIds | a list of learning objective Ids |
Return | osid.assessment.ItemList | the returned Item list | |
Errors | NULL_ARGUMENT | objectiveIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getItems | ||
Description |
Gets all | ||
Return | osid.assessment.ItemList | a list of Items | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. |