OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.Hierarchy
Implementsosid.OsidCatalog
Description

A Hierarchy represents an authenticatable identity. Like all OSID objects, a Hierarchy is identified by its Id and any persisted references should use the Id.

MethodgetHierarchyRecord
Description

Gets the hierarchy record corresponding to the given Hierarchy record Type. This method is used to retrieve an object implementing the requested record. The hierarchyRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(hierarchyRecordType) is true .

Parametersosid.type.TypehierarchyRecordTypethe type of the record to retrieve
Returnosid.hierarchy.records.HierarchyRecordthe hierarchy record
ErrorsNULL_ARGUMENT hierarchyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(hierarchyrecordType) is false
CompliancemandatoryThis method must be implemented.