OSID Logo
OSID Specifications
learning package
Version 3.1.0
Interfaceosid.learning.ProficiencyObjectiveBankAssignmentSession
Implementsosid.OsidSession
Used Byosid.learning.LearningManager
osid.learning.LearningProxyManager
Description

This session provides methods to re-assign Proficiencies to ObjectiveBanks. A Proficiency may appear in multiple ObjectiveBank objects and removing the last reference to a Proficiency is the equivalent of deleting it. Each ObjectiveBank may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Proficiency to another ObjectiveBank is not a copy operation (eg: does not change its Id).

MethodcanAssignProficiencies
Description

Tests if this user can alter proficiency/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
Compliancemandatory This method must be implemented.
MethodcanAssignProficienciesToObjectiveBank
Description

Tests if this user can alter proficiency/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.IdobjectiveBankId the Id of the ObjectiveBank
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT objectiveBankId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableObjectiveBankIds
Description

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

Parametersosid.id.IdobjectiveBankId the Id of the ObjectiveBank
Returnosid.id.IdList list of assignable objectiveBank Ids
ErrorsNULL_ARGUMENT objectiveBankId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableObjectiveBankIdsForProficiency
Description

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

Parametersosid.id.IdobjectiveBankId the Id of the ObjectiveBank
osid.id.IdproficiencyId the Id of the Proficiency
Returnosid.id.IdList list of assignable objectiveBank Ids
ErrorsNULL_ARGUMENT objectiveBankId or proficiencyId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignProficiencyToObjectiveBank
Description

Adds an existing Proficiency to a ObjectiveBank.

Parametersosid.id.IdproficiencyId the Id of the Proficiency
osid.id.IdobjectiveBankId the Id of the ObjectiveBank
ErrorsALREADY_EXISTS proficiencyId is already mapped to objectiveBankId
NOT_FOUND proficiencyId or objectiveBankId not found
NULL_ARGUMENT proficiencyId or objectiveBankId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignProficiencyFromObjectiveBank
Description

Removes a Proficiency from a ObjectiveBank.

Parametersosid.id.IdproficiencyId the Id of the Proficiency
osid.id.IdobjectiveBankId the Id of the ObjectiveBank
ErrorsNOT_FOUND proficiencyId or objectiveBankId not found or proficiencyId not mapped to objectiveBankId
NULL_ARGUMENT proficiencyId or objectiveBankId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignProficiencyToObjectiveBank
Description

Moves a Proficiency from one ObjectiveBank to another. Mappings to other ObjectiveBanks are unaffected.

Parametersosid.id.IdproficiencyId the Id of the Proficiency
osid.id.IdfromObjectiveBankId the Id of the current ObjectiveBank
osid.id.IdtoObjectiveBankId the Id of the destination ObjectiveBank
ErrorsALREADY_EXISTS proficiencyId already assigned to toObjectiveBankId
NOT_FOUND proficiencyId, fromObjectiveBankId, or toObjectiveBankId not found or proficiencyId not mapped to fromObjectiveBankId
NULL_ARGUMENT proficiencyId, fromObjectiveBankId, or toObjectiveBankId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.