org.osid.hierarchy

Interface HierarchyProfile

All Superinterfaces:

OsidProfile, Sourceable

All Known Subinterfaces:

HierarchyManager, HierarchyProxyManager

public interface HierarchyProfile
extends OsidProfile

The hierarchy profile describes the interoperability among hierarchy services.

Method Summary

Methods

Modifier and Type	Method and Description
TypeList	getHierarchyRecordTypes() Gets the supported Hierarchy types.
TypeList	getHierarchySearchRecordTypes() Gets the supported Hierarchy search record types.
boolean	supportsHierarchyAdmin() Tests if a hierarchy administration is supported.
boolean	supportsHierarchyDesign() Tests if hierarchy design is supported.
boolean	supportsHierarchyLookup() Tests if a hierarchy lookup is supported.
boolean	supportsHierarchyNotification() Tests if hierarchy notification is supported.
boolean	supportsHierarchyQuery() Tests if a hierarchy query is supported.
boolean	supportsHierarchyRecordType(Type hierarchyRecordType) Tests if the given Hierarchy record type is supported.
boolean	supportsHierarchySearch() Tests if a hierarchy search is supported.
boolean	supportsHierarchySearchRecordType(Type hierarchySearchRecordType) Tests if the given Hierarchy search record type is supported.
boolean	supportsHierarchySequencing() Tests if hierarchy sequencing is supported.
boolean	supportsHierarchyStructureNotification() Tests if hierarchy structure notification is supported.
boolean	supportsHierarchyTraversal() Tests if hierarchy traversal is supported.
boolean	supportsVisibleFederation() Tests if federation is visible.

Methods inherited from interface org.osid.OsidProfile

getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType

Methods inherited from interface org.osid.Sourceable

getBranding, getBrandingIds, getLicense, getProvider, getProviderId

Method Detail

supportsVisibleFederation

boolean supportsVisibleFederation()

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

Returns:

true if visible federation is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHierarchyTraversal

boolean supportsHierarchyTraversal()

Tests if hierarchy traversal is supported.

Returns:

true if hierarchy traversal is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHierarchyDesign

boolean supportsHierarchyDesign()

Tests if hierarchy design is supported.

Returns:

true if hierarchy design is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHierarchySequencing

boolean supportsHierarchySequencing()

Tests if hierarchy sequencing is supported.

Returns:

true if hierarchy sequencing is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHierarchyStructureNotification

boolean supportsHierarchyStructureNotification()

Tests if hierarchy structure notification is supported.

Returns:

true if hierarchy structure notification is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHierarchyLookup

boolean supportsHierarchyLookup()

Tests if a hierarchy lookup is supported.

Returns:

true if hierarchy lookup is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHierarchyQuery

boolean supportsHierarchyQuery()

Tests if a hierarchy query is supported.

Returns:

true if hierarchy query is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHierarchySearch

boolean supportsHierarchySearch()

Tests if a hierarchy search is supported.

Returns:

true if hierarchy search is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHierarchyAdmin

boolean supportsHierarchyAdmin()

Tests if a hierarchy administration is supported.

Returns:

true if hierarchy administration is supported, false otherwise

Compliance:

mandatory - This method must be implemented.

supportsHierarchyNotification

boolean supportsHierarchyNotification()

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

Returns:

true if hierarchy notification is supported , false otherwise

Compliance:

mandatory - This method must be implemented.

getHierarchyRecordTypes

TypeList getHierarchyRecordTypes()

Gets the supported Hierarchy types.

Returns:

a list containing the supported Hierarchy record types

Compliance:

mandatory - This method must be implemented.

supportsHierarchyRecordType

boolean supportsHierarchyRecordType(Type hierarchyRecordType)

Tests if the given Hierarchy record type is supported.

Parameters:

hierarchyRecordType - a Type indicating a Hierarchy record type

Returns:

true if the given record Type is supported, false otherwise

Throws:

NullArgumentException - hierarchyRecordType is null

Compliance:

mandatory - This method must be implemented.

getHierarchySearchRecordTypes

TypeList getHierarchySearchRecordTypes()

Gets the supported Hierarchy search record types.

Returns:

a list containing the supported Hierarchy search record types

Compliance:

mandatory - This method must be implemented.

supportsHierarchySearchRecordType

boolean supportsHierarchySearchRecordType(Type hierarchySearchRecordType)

Tests if the given Hierarchy search record type is supported.

Parameters:

hierarchySearchRecordType - a Type indicating a Hierarchy search record type

Returns:

true if the given Type is supported, false otherwise

Throws:

NullArgumentException - hierarchySearchRecordType is null

Compliance:

mandatory - This method must be implemented.