OSID Logo
OSID Specifications
learning package
Version 3.0.0
Release Candidate Preview
Interfaceosid.learning.ActivityObjectiveBankSession
Implementsosid.OsidSession
Description

This session provides methods to retrieve Activity to ObjectiveBank mappings. An Activity may appear in multiple ObjectiveBanks. Each ObjectiveBank may have its own authorizations governing who is allowed to look at it.

This lookup session defines two views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition
MethodcanLookupActivityObjectiveBankMappings
Description

Tests if this user can perform lookups of activity/objective bank mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeObjectiveBankView
Description

The returns from the lookup methods may omit or translate elements based on this session, such as authorization, 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.
MethodusePlenaryObjectiveBankView
Description

A complete view of the Activity and ObjectiveBank 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.
MethodgetActivityIdsByObjectiveBank
Description

Gets the list of Activity Ids associated with an ObjectiveBank.

Parametersosid.id.IdobjectiveBankId Id of the ObjectiveBank
Returnosid.id.IdListlist of related activity Ids
ErrorsNOT_FOUND objectiveBankId is not found
NULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivitiesByObjectiveBank
Description

Gets the list of Activities associated with an ObjectiveBank.

Parametersosid.id.IdobjectiveBankId Id of the ObjectiveBank
Returnosid.learning.ActivityListlist of related activities
ErrorsNOT_FOUND objectiveBankId is not found
NULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivityIdsByObjectiveBanks
Description

Gets the list of Activity Ids corresponding to a list of ObjectiveBanks.

Parametersosid.id.IdListobjectiveBankIdslist of objective bank Ids
Returnosid.id.IdListlist of activity Ids
ErrorsNULL_ARGUMENT objectiveBankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetActivitiesByObjectiveBanks
Description

Gets the list of Activities corresponding to a list of ObjectiveBanks.

Parametersosid.id.IdListobjectiveBankIdslist of objective bank Ids
Returnosid.learning.ActivityListlist of activities
ErrorsNULL_ARGUMENT objectiveBankIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBankIdsByActivity
Description

Gets the list of ObjectiveBank Ids mapped to a Activity.

Parametersosid.id.IdactivityId Id of a Activity
Returnosid.id.IdListlist of objective bank Ids
ErrorsNOT_FOUND activityId is not found
NULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetObjectiveBanksByActivity
Description

Gets the list of ObjectiveBanks mapped to a Activity.

Parametersosid.id.IdactivityId Id of a Activity
Returnosid.learning.ObjectiveBankListlist of objective bank Ids
ErrorsNOT_FOUND activityId is not found
NULL_ARGUMENT activityId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.