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

This session provides methods to re-assign Objectives to ObjectiveBanks. An Objective may map to multiple ObjectiveBanks and removing the last reference to an Objective 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 Objective to another ObjectiveBank is not a copy operation (eg: does not change its Id ).

MethodcanAssignObjectives
Description

Tests if this user can alter objective/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.
MethodcanAssignObjectivesToObjectiveBank
Description

Tests if this user can alter objective/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 objective 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.
MethodgetAssignableObjectiveBankIdsForObjective
Description

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

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

Adds an existing Objective to an ObjectiveBank.

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

Removes an Objective from an ObjectiveBank.

Parametersosid.id.IdobjectiveIdthe Id of the Objective
osid.id.IdobjectiveBankIdthe Id of the ObjectiveBank
ErrorsNOT_FOUND objectiveId or objectiveBankId not found or objectiveId not mapped to objectiveBankId
NULL_ARGUMENT objectiveId or objectiveBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignProficiencyToObjectiveBank
Description

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

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