OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.OfficeHierarchyDesignSession
Implementsosid.OsidSession
Description

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

MethodgetOfficeHierarchyId
Description

Gets the hierarchy Id associated with this session.

Returnosid.id.Idthe hierarchy Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOfficeHierarchy
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.
MethodcanModifyOfficeHierarchy
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.
MethodaddRootOffice
Description

Adds a root office.

Parametersosid.id.IdofficeIdthe Id of an office
ErrorsALREADY_EXISTS officeId is already in hierarchy
NOT_FOUND officeId not found
NULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootOffice
Description

Removes a root office.

Parametersosid.id.IdofficeIdthe Id of an office
ErrorsNOT_FOUND officeId is not a root
NULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildOffice
Description

Adds a child to an office.

Parametersosid.id.IdofficeIdthe Id of an office
osid.id.IdchildIdthe Id of the new child
ErrorsALREADY_EXISTS officeId is already a parent of childId
NOT_FOUND officeId or childId not found
NULL_ARGUMENT officeId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildOffice
Description

Removes a child from an office.

Parametersosid.id.IdofficeIdthe Id of an office
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND officeId is not parent of childId
NULL_ARGUMENT officeId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildOffices
Description

Removes all children from an office.

Parametersosid.id.IdofficeIdthe Id of an office
ErrorsNOT_FOUND officeId is not found
NULL_ARGUMENT officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.