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

This session provides methods to re-assign Items to Banks. An Item may map to multiple Banks and removing the last reference to an Item is the equivalent of deleting it. Each Bank may have its own authorizations governing who is allowed to operate on it.

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

MethodcanAssignItems
Description

Tests if this user can alter item/bank mappings. A return of true does not guarantee successful assessment. 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.
MethodcanAssignItemsToBank
Description

Tests if this user can alter item/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 lookup operations to unauthorized users.

Parametersosid.id.IdbankIdthe Id of the Bank
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT bankId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBankIds
Description

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

Parametersosid.id.IdbankIdthe Id of the Bank
Returnosid.id.IdListlist of assignable bank Ids
ErrorsNULL_ARGUMENT bankId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableBankIdsForItem
Description

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

Parametersosid.id.IdbankIdthe Id of the Bank
osid.id.IditemIdthe Id of the Item
Returnosid.id.IdListlist of assignable bank Ids
ErrorsNULL_ARGUMENT bankId or itemId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignItemToBank
Description

Adds an existing Item to a Bank.

Parametersosid.id.IditemIdthe Id of the Item
osid.id.IdbankIdthe Id of the Bank
ErrorsALREADY_EXISTS itemId is already assigned to bankId
NOT_FOUND itemId or bankId not found
NULL_ARGUMENT itemId or bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodunassignItemFromBank
Description

Removes an Item from a Bank.

Parametersosid.id.IditemIdthe Id of the Item
osid.id.IdbankIdthe Id of the Bank
ErrorsNOT_FOUND itemId or bankId not found or itemId not assigned to bankId
NULL_ARGUMENT itemId or bankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure occurred
CompliancemandatoryThis method must be implemented.
MethodreassignItemToBilling
Description

Moves an Item from one Bank to another. Mappings to other Banks are unaffected.

Parametersosid.id.IditemIdthe Id of the Item
osid.id.IdfromBankIdthe Id of the current Bank
osid.id.IdtoBankIdthe Id of the destination Bank
ErrorsNOT_FOUND itemId, fromBankId, or toBankId not found or itemId not mapped to fromBankId
NULL_ARGUMENT itemId, fromBankId, or toBankId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.