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

This session defines methods for retrieving assessments offered.

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 methods in this session operate, retrieve and pertain to assessments defined explicitly in the current bank. Using an isolated view is useful for managing Assessments with the AssessmentAdminSession.
  • federated bank view: All assessment methods in this session operate, retrieve and pertain to all assessments defined in this bank and any other assessments implicitly available in this bank through bank inheritence.

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

Assessments offered may have a record indicated by their respective types. The record is accessed via the AssessmentOffered. The returns may not be cast directly from the returns in the lookup methods.

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

Tests if this user can perform AssessmentOffered 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 to unauthorized users.

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

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

CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentOffered
Description

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

Parametersosid.id.IdassessmentOfferedId Id of the AssessmentOffered
Returnosid.assessment.AssessmentOfferedthe assessment offered
ErrorsNOT_FOUND assessmentOfferedId not found
NULL_ARGUMENT assessmentOfferedId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method is must be implemented.
MethodgetAssessmentsOfferedByIds
Description

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

Parametersosid.id.IdListassessmentOfferedIdsthe list of Ids to retrieve
Returnosid.assessment.AssessmentOfferedListthe returned AssessmentOffered list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT assessmentOfferedIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDassessment failure
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsOfferedByGenusType
Description

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

Parametersosid.type.TypeassessmentOfferedGenusTypean assessment offered genus type
Returnosid.assessment.AssessmentOfferedListthe returned AssessmentOffered list
ErrorsNULL_ARGUMENT assessmentOfferedGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsOfferedByParentGenusType
Description

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

Parametersosid.type.TypeassessmentOfferedGenusTypean assessment offered genus type
Returnosid.assessment.AssessmentOfferedListthe returned AssessmentOffered list
ErrorsNULL_ARGUMENT assessmentOfferedGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsOfferedByRecordType
Description

Gets an AssessmentOfferedList corresponding to the given assessment offered record Type. The set of assessments implementing the given record type is returned. In plenary mode, the returned list contains all known assessments offered or an error results. Otherwise, the returned list may contain only those assessments offered that are accessible through this session.

Parametersosid.type.TypeassessmentRecordTypean assessment offered record type
Returnosid.assessment.AssessmentOfferedListthe returned AssessmentOffered list
ErrorsNULL_ARGUMENT assessmentOfferedRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsOfferedByDate
Description

Gets an AssessmentOfferedList that have designated start times where the start times fall in the given range inclusive. In plenary mode, the returned list contains all known assessments offered or an error results. Otherwise, the returned list may contain only those assessments offered that are accessible through this session.

Parametersosid.calendaring.DateTimestartstart of time range
osid.calendaring.DateTimeendend of time range
Returnosid.assessment.AssessmentOfferedListthe returned AssessmentOffered list
ErrorsINVALID_ARGUMENT end is less than start
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsOfferedForAssessment
Description

Gets an AssessmentOfferedList by the given assessment. In plenary mode, the returned list contains all known assessments offered or an error results. Otherwise, the returned list may contain only those assessments offered that are accessible through this session.

Parametersosid.id.IdassessmentId Id of an Assessment
Returnosid.assessment.AssessmentOfferedListthe returned AssessmentOffered list
ErrorsNULL_ARGUMENT assessmentId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodgetAssessmentsOffered
Description

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

Returnosid.assessment.AssessmentOfferedLista list of AssessmentOffered elements
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.