Interface | osid.assessment.AssessmentLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving assessments. This lookup session defines several views:
The methods Assessments may have a record indicated by their
respective types. The record is accessed via the | ||
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 | canLookupAssessments | ||
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 | useComparativeAssessmentView | ||
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 | usePlenaryAssessmentView | ||
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 assessments in banks which are children of this bank in the 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 bank only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAssessment | ||
Description |
Gets the | ||
Parameters | osid.id.Id | assessmentId | Id of the Assessment |
Return | osid.assessment.Assessment | the assessment | |
Errors | NOT_FOUND | assessmentId not found | |
NULL_ARGUMENT | assessmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAssessmentsByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | assessmentIds | the list of Ids to retrieve |
Return | osid.assessment.AssessmentList | the returned Assessment list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | assessmentIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | assessment failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentsByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | assessmentGenusType | an assessment genus type |
Return | osid.assessment.AssessmentList | the returned Assessment list | |
Errors | NULL_ARGUMENT | assessmentGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentsByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | assessmentGenusType | an assessment genus type |
Return | osid.assessment.AssessmentList | the returned Assessment list | |
Errors | NULL_ARGUMENT | assessmentGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentsByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | assessmentRecordType | an assessment record type |
Return | osid.assessment.AssessmentList | the returned Assessment list | |
Errors | NULL_ARGUMENT | assessmentRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessments | ||
Description |
Gets all | ||
Return | osid.assessment.AssessmentList | a list of Assessments | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. |