OSID Logo
OSID Specifications
resource package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resource.BinHierarchyDesignSession
Implementsosid.OsidSession
Description

This session defines methods for managing a hierarchy of Bin objects. Each node in the hierarchy is a unique Bin.

MethodgetBinHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetBinHierarchy
Description

Gets the hierarchy associated with this session.

Returnosid.hierarchy.Hierarchythe hierarchy associated with this session
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanModifyBinHierarchy
Description

Tests if this user can change the hierarchy. A return of true does not guarantee successful authorization. A return of false indicates that it is known performing any update will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer these operations to an unauthorized user.

Returnboolean false if changing this hierarchy is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaddRootBin
Description

Adds a root bin.

Parametersosid.id.IdbinIdthe Id of a bin
ErrorsALREADY_EXISTS binId is already in hierarchy
NOT_FOUND binId not found
NULL_ARGUMENT binId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootBin
Description

Removes a root bin.

Parametersosid.id.IdbinIdthe Id of a bin
ErrorsNOT_FOUND binId not a root
NULL_ARGUMENT binId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildBin
Description

Adds a child to a bin.

Parametersosid.id.IdbinIdthe Id of a bin
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS binId is already a parent of childId
NOT_FOUND binId or childId not found
NULL_ARGUMENT binId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildBin
Description

Removes a child from a bin.

Parametersosid.id.IdbinIdthe Id of a bin
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND binId not a parent of childId
NULL_ARGUMENT binId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildBins
Description

Removes all children from a bin.

Parametersosid.id.IdbinIdthe Id of a bin
ErrorsNOT_FOUND binId not in hierarchy
NULL_ARGUMENT binId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.