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

This session provides methods to re-assign Activities to ObjectiveBanks. An Activity may map to multiple ObjectiveBanks and removing the last reference to a Activity is the equivalent of deleting it. Each ObjectiveBank may have its own authorizations governing who is allowed to operate on it.

Moving or adding a reference of an Activity to another ObjectiveBank is not a copy operation (eg: does not change its Id ).

MethodcanAssignActivities
Description

Tests if this user can alter activity/objective bank mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignActivitiesToObjectiveBank
Description

Tests if this user can alter activity/objective bank mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping 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 assignment operations to unauthorized users.

Parametersosid.id.IdobjectiveBankIdthe Id of the ObjectiveBank
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT objectiveBankId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableObjectiveBankIds
Description

Gets a list of objective banks including and under the given objective bank node in which any activity can be assigned.

Parametersosid.id.IdobjectiveBankIdthe Id of the ObjectiveBank
Returnosid.id.IdListlist of assignable objective bank Ids
ErrorsNULL_ARGUMENT objectiveBankId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableObjectiveBankIdsForActivity
Description

Gets a list of objective banks including and under the given objective bank node in which a specific activity can be assigned.

Parametersosid.id.IdobjectiveBankIdthe Id of the ObjectiveBank
osid.id.IdactivityIdthe Id of the Activity
Returnosid.id.IdListlist of assignable objective bank Ids
ErrorsNULL_ARGUMENT activityId or objectiveBankId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignActivityToObjectiveBank
Description

Adds an existing Activity to a ObjectiveBank.

Parametersosid.id.IdactivityIdthe Id of the Activity
osid.id.IdobjectiveBankIdthe Id of the ObjectiveBank
ErrorsALREADY_EXISTS activityId already mapped to objectiveBankId
NOT_FOUND activityId or objectiveBankId not found
NULL_ARGUMENT activityId or objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignActivityFromObjectiveBank
Description

Removes a Activity from a ObjectiveBank.

Parametersosid.id.IdactivityIdthe Id of the Activity
osid.id.IdobjectiveBankIdthe Id of the ObjectiveBank
ErrorsNOT_FOUND activityId or objectiveBankId not found or activityId not mapped to objectiveBankId
NULL_ARGUMENT activityId or objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignActivityToObjectiveBank
Description

Moves an Activity from one ObjectiveBank to another. Mappings to other ObjectiveBanks are unaffected.

Parametersosid.id.IdactivityIdthe Id of the Activity
osid.id.IdfromObjectiveBankIdthe Id of the current ObjectiveBank
osid.id.IdtoObjectiveBankIdthe Id of the destination ObjectiveBank
ErrorsNOT_FOUND activityId, fromObjectiveBankId, or toObjectiveBankId not found or activityId not mapped to fromObjectiveBankId
NULL_ARGUMENT activityId, fromObjectiveBankId, or toObjectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.