OSID Logo
OSID Specifications
hierarchy package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hierarchy.HierarchyForm
Implementsosid.OsidCatalogForm
Description

This is the form for creating and updating Hierarchy objects. Like all OsidForm objects, various data elements may be set here for use in the create and update methods in the HierarchyAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

MethodgetHierarchyFormRecord
Description

Gets the HierarchyFormRecord corresponding to the given hierarchy record Type.

Parametersosid.type.TypehierarchyRecordTypethe hierarchy record type
Returnosid.hierarchy.records.HierarchyFormRecordthe hierarchy form record
ErrorsNULL_ARGUMENT hierarchyRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(hierarchyRecordType) is false
CompliancemandatoryThis method must be implemented.