OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchyProfile
Implementsosid.OsidProfile
Description

The hierarchy profile describes the interoperability among hierarchy services.

MethodsupportsVisibleFederation
Description

Tests if federation is visible. Visible federation allows for selecting among multiple hierarchies.

Returnboolean true if visible federation is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchyTraversal
Description

Tests if hierarchy traversal is supported.

Returnboolean true if hierarchy traversal is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchyDesign
Description

Tests if hierarchy design is supported.

Returnboolean true if hierarchy design is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchySequencing
Description

Tests if hierarchy sequencing is supported.

Returnboolean true if hierarchy sequencing is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchyStructureNotification
Description

Tests if hierarchy structure notification is supported.

Returnboolean true if hierarchy structure notification is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchyLookup
Description

Tests if a hierarchy lookup is supported.

Returnboolean true if hierarchy lookup is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchyQuery
Description

Tests if a hierarchy query is supported.

Returnboolean true if hierarchy query is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchySearch
Description

Tests if a hierarchy search is supported.

Returnboolean true if hierarchy search is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchyAdmin
Description

Tests if a hierarchy administration is supported.

Returnboolean true if hierarchy administration is supported, false otherwise
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchyNotification
Description

Tests if hierarchy notification is supported. Messages may be sent when hierarchies are created, modified, or deleted.

Returnboolean true if hierarchy notification is supported , false otherwise
CompliancemandatoryThis method must be implemented.
MethodgetHierarchyRecordTypes
Description

Gets the supported Hierarchy types.

Returnosid.type.TypeLista list containing the supported Hierarchy record types
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchyRecordType
Description

Tests if the given Hierarchy record type is supported.

Parametersosid.type.TypehierarchyRecordTypea Type indicating a Hierarchy record type
Returnboolean true if the given record Type is supported, false otherwise
ErrorsNULL_ARGUMENT hierarchyRecordType is null
CompliancemandatoryThis method must be implemented.
MethodgetHierarchySearchRecordTypes
Description

Gets the supported Hierarchy search record types.

Returnosid.type.TypeLista list containing the supported Hierarchy search record types
CompliancemandatoryThis method must be implemented.
MethodsupportsHierarchySearchRecordType
Description

Tests if the given Hierarchy search record type is supported.

Parametersosid.type.TypehierarchySearchRecordTypea Type indicating a Hierarchy search record type
Returnboolean true if the given Type is supported, false otherwise
ErrorsNULL_ARGUMENT hierarchySearchRecordType is null
CompliancemandatoryThis method must be implemented.