Interface | osid.assessment.AssessmentOfferedLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving assessments offered. This lookup session defines several views:
The methods Assessments offered 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 | canLookupAssessmentsOffered | ||
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 | useComparativeAssessmentOfferedView | ||
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 | usePlenaryAssessmentOfferedView | ||
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 | getAssessmentOffered | ||
Description |
Gets the | ||
Parameters | osid.id.Id | assessmentOfferedId | Id of the AssessmentOffered |
Return | osid.assessment.AssessmentOffered | the assessment offered | |
Errors | NOT_FOUND | assessmentOfferedId not found | |
NULL_ARGUMENT | assessmentOfferedId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getAssessmentsOfferedByIds | ||
Description |
Gets an | ||
Parameters | osid.id.IdList | assessmentOfferedIds | the list of Ids to retrieve |
Return | osid.assessment.AssessmentOfferedList | the returned AssessmentOffered list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | assessmentOfferedIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | assessment failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentsOfferedByGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | assessmentOfferedGenusType | an assessment offered genus type |
Return | osid.assessment.AssessmentOfferedList | the returned AssessmentOffered list | |
Errors | NULL_ARGUMENT | assessmentOfferedGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentsOfferedByParentGenusType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | assessmentOfferedGenusType | an assessment offered genus type |
Return | osid.assessment.AssessmentOfferedList | the returned AssessmentOffered list | |
Errors | NULL_ARGUMENT | assessmentOfferedGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentsOfferedByRecordType | ||
Description |
Gets an | ||
Parameters | osid.type.Type | assessmentRecordType | an assessment offered record type |
Return | osid.assessment.AssessmentOfferedList | the returned AssessmentOffered list | |
Errors | NULL_ARGUMENT | assessmentOfferedRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentsOfferedByDate | ||
Description |
Gets an | ||
Parameters | osid.calendaring.DateTime | start | start of time range |
osid.calendaring.DateTime | end | end of time range | |
Return | osid.assessment.AssessmentOfferedList | the returned AssessmentOffered list | |
Errors | INVALID_ARGUMENT | end is less than start | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentsOfferedForAssessment | ||
Description |
Gets an | ||
Parameters | osid.id.Id | assessmentId | Id of an Assessment |
Return | osid.assessment.AssessmentOfferedList | the returned AssessmentOffered list | |
Errors | NULL_ARGUMENT | assessmentId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssessmentsOffered | ||
Description |
Gets all | ||
Return | osid.assessment.AssessmentOfferedList | a list of AssessmentOffered elements | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure occurred | ||
Compliance | mandatory | This method must be implemented. |