OSID Logo
OSID Specifications
profile package
Version 3.0.0
Release Candidate Preview
Interfaceosid.profile.ProfileHierarchyDesignSession
Implementsosid.OsidSession
Description

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

MethodgetProfileHierarchyId
Description

Gets the hierarchy Id associated with this session.

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

Adds a root profile.

Parametersosid.id.IdprofileIdthe Id of a profile
ErrorsALREADY_EXISTS profileId is already in hierarchy
NOT_FOUND profileId not found
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveRootProfile
Description

Removes a root profile.

Parametersosid.id.IdprofileIdthe Id of a profile
ErrorsNOT_FOUND profileId not a root
NULL_ARGUMENT profileId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodaddChildProfile
Description

Adds a child to a profile.

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

Removes a child from a profile.

Parametersosid.id.IdprofileIdthe Id of a profile
osid.id.IdchildIdthe Id of the new child
ErrorsNOT_FOUND profileId not a parent of childId
NULL_ARGUMENT profileId or childId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodremoveChildProfiles
Description

Removes all children from a profile.

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