org.osid.hierarchy

Interface Hierarchy

All Superinterfaces:

Browsable, Extensible, Federateable, Identifiable, OsidCatalog, OsidObject, Sourceable

public interface Hierarchy
extends OsidCatalog

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.

Method Summary

Methods

Modifier and Type	Method and Description
HierarchyRecord	getHierarchyRecord(Type hierarchyRecordType) Gets the hierarchy record corresponding to the given Hierarchy record Type.

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

getHierarchyRecord

HierarchyRecord getHierarchyRecord(Type hierarchyRecordType)
                                   throws OperationFailedException

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 .

Parameters:

hierarchyRecordType - the type of the record to retrieve

Returns:

the hierarchy record

Throws:

NullArgumentException - hierarchyRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(hierarchyrecordType) is false

Compliance:

mandatory - This method must be implemented.