OSID - osid.hierarchy.HierarchyProfile Service Interface Definition

Interface	osid.hierarchy.HierarchyProfile
Implements	`osid.OsidProfile`
Description	The hierarchy profile describes the interoperability among hierarchy services.
Method	supportsVisibleFederation
Description	Tests if federation is visible. Visible federation allows for selecting among multiple hierarchies.
Return	`boolean`		`true` if visible federation is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchyTraversal
Description	Tests if hierarchy traversal is supported.
Return	`boolean`		`true` if hierarchy traversal is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchyDesign
Description	Tests if hierarchy design is supported.
Return	`boolean`		`true` if hierarchy design is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchySequencing
Description	Tests if hierarchy sequencing is supported.
Return	`boolean`		`true` if hierarchy sequencing is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchyStructureNotification
Description	Tests if hierarchy structure notification is supported.
Return	`boolean`		`true` if hierarchy structure notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchyLookup
Description	Tests if a hierarchy lookup is supported.
Return	`boolean`		`true` if hierarchy lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchyQuery
Description	Tests if a hierarchy query is supported.
Return	`boolean`		`true` if hierarchy query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchySearch
Description	Tests if a hierarchy search is supported.
Return	`boolean`		`true` if hierarchy search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchyAdmin
Description	Tests if a hierarchy administration is supported.
Return	`boolean`		`true` if hierarchy administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchyNotification
Description	Tests if hierarchy notification is supported. Messages may be sent when hierarchies are created, modified, or deleted.
Return	`boolean`		`true` if hierarchy notification is supported `,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchyRecordTypes
Description	Gets the supported `Hierarchy` types.
Return	`osid.type.TypeList`		a list containing the supported `Hierarchy` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchyRecordType
Description	Tests if the given `Hierarchy` record type is supported.
Parameters	`osid.type.Type`	`hierarchyRecordType`	a `Type` indicating a `Hierarchy` record type
Return	`boolean`		`true` if the given record Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`hierarchyRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getHierarchySearchRecordTypes
Description	Gets the supported `Hierarchy` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Hierarchy` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsHierarchySearchRecordType
Description	Tests if the given `Hierarchy` search record type is supported.
Parameters	`osid.type.Type`	`hierarchySearchRecordType`	a `Type` indicating a `Hierarchy` search record type
Return	`boolean`		`true` if the given Type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`hierarchySearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.