public interface HierarchyProxyManager extends OsidProxyManager, HierarchyProfile
The hierarchy manager provides access sessions to traverse and manage
hierrachies of Ids.
Methods in this manager accept a
Proxy
to pass information from server environments. The sessions
included in this manager are:
HierarchyTraversalSession:
a basic session
traversing a hierarchy HierarchyDesignSession:
a session to design a
hierarchy HierarchySequencingSession:
a session to sequence
nodes in a hierarchy HierarchyStructureNotificationSession:
a session
for notififcations within a hierarchy structure HierarchyLookupSession:
a session looking up
hiererachies HierarchyQuerySession:
a session querying
hiererachies HierarchySearchSession:
a session for searching
for hierarchies HierarchyAdminSession:
a session for creating and
deleting hierarchies HierarchyNotificationSession:
a session for
subscribing to changes in hierarchies Modifier and Type | Method and Description |
---|---|
HierarchyAdminSession |
getHierarchyAdminSession(Proxy proxy)
Gets the hierarchy administrative session.
|
HierarchyDesignSession |
getHierarchyDesignSession(Proxy proxy)
Gets the
OsidSession associated with the hierarchy
design service. |
HierarchyDesignSession |
getHierarchyDesignSessionForHierarchy(Id hierarchyId,
Proxy proxy)
Gets the
OsidSession associated with the topology
design service using for the given hierarchy. |
HierarchyLookupSession |
getHierarchyLookupSession(Proxy proxy)
Gets the
OsidSession associated with the hierarchy
lookup service. |
HierarchyNotificationSession |
getHierarchyNotificationSession(HierarchyReceiver hierarchyReceiver,
Proxy proxy)
Gets the hierarchy notification session.
|
HierarchyQuerySession |
getHierarchyQuerySession(Proxy proxy)
Gets the
OsidSession associated with the hierarchy
query service. |
HierarchySearchSession |
getHierarchySearchSession(Proxy proxy)
Gets the
OsidSession associated with the hierarchy
search service. |
HierarchySequencingSession |
getHierarchySequencingSession(Proxy proxy)
Gets the
OsidSession associated with the hierarchy
sequencing service. |
HierarchySequencingSession |
getHierarchySequencingSessionForHierarchy(Id hierarchyId,
Proxy proxy)
Gets the
OsidSession associated with the sequencing
design service using for the given hierarchy. |
HierarchyStructureNotificationSession |
getHierarchyStructureNotificationSession(HierarchyStructureReceiver hierarchyStructureReceiver,
Proxy proxy)
Gets the session for subscribing to notifications of changes within a
hierarchy structure.
|
HierarchyStructureNotificationSession |
getHierarchyStructureNotificationSessionForHierarchy(HierarchyStructureReceiver hierarchyStructureReceiver,
Id hierarchyId,
Proxy proxy)
Gets the session for subscribing to notifications of changes within a
hierarchy structure for the given hierarchy.
|
HierarchyTraversalSession |
getHierarchyTraversalSession(Proxy proxy)
Gets the
OsidSession associated with the hierarchy
traversal service. |
HierarchyTraversalSession |
getHierarchyTraversalSessionForHierarchy(Id hierarchyId,
Proxy proxy)
Gets the
OsidSession associated with the hierarchy
traversal service for the given hierarchy. |
changeBranch, initialize, rollbackService
close
getHierarchyRecordTypes, getHierarchySearchRecordTypes, supportsHierarchyAdmin, supportsHierarchyDesign, supportsHierarchyLookup, supportsHierarchyNotification, supportsHierarchyQuery, supportsHierarchyRecordType, supportsHierarchySearch, supportsHierarchySearchRecordType, supportsHierarchySequencing, supportsHierarchyStructureNotification, supportsHierarchyTraversal, supportsVisibleFederation
getBranch, getBranchId, getDescription, getDisplayName, getId, getLocales, getProxyRecordTypes, getReleaseDate, getVersion, supportsJournalBranching, supportsJournalRollback, supportsOSIDVersion, supportsProxyRecordType
getBranding, getBrandingIds, getLicense, getProvider, getProviderId
HierarchyTraversalSession getHierarchyTraversalSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hierarchy
traversal service.proxy
- a proxy HierarchyTraversalSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchyTraversal()
is false
optional
- This method must be implemented if
supportsHierarchyTraversal()
is true.
HierarchyTraversalSession getHierarchyTraversalSessionForHierarchy(Id hierarchyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the hierarchy
traversal service for the given hierarchy.hierarchyId
- the Id
of the hierarchyproxy
- a proxy HierarchyTraversalSession
NotFoundException
- hierarchyid
not
foundNullArgumentException
- hierarchyId
or
proxy
is null
OperationFailedException
- unable to complete
request
UnimplementedException
-
supportsHierarchyTraversal()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHierarchyTraversal()
and
supportsVisibleFederation()
are true.
HierarchyDesignSession getHierarchyDesignSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hierarchy
design service.proxy
- a proxy HierarchyDesignSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchyDesign()
is false
optional
- This method must be implemented if
supportsHierarchyDesign()
is true.
HierarchyDesignSession getHierarchyDesignSessionForHierarchy(Id hierarchyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the topology
design service using for the given hierarchy.hierarchyId
- the Id
of the hierarchyproxy
- a proxy HierarchyDesignSession
NotFoundException
- hierarchyId
is not
foundNullArgumentException
- hierarchyId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchyDesign()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHierarchyDesign()
and
supportsVisibleFederation()
are true.
HierarchySequencingSession getHierarchySequencingSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hierarchy
sequencing service.proxy
- a proxy HierarchySequencingSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchySequencing()
is false
optional
- This method must be implemented if
supportsHierarchySequencing()
is true.
HierarchySequencingSession getHierarchySequencingSessionForHierarchy(Id hierarchyId, Proxy proxy) throws NotFoundException, OperationFailedException
OsidSession
associated with the sequencing
design service using for the given hierarchy.hierarchyId
- the Id
of the graphproxy
- a proxy HierarchySequencingSession
NotFoundException
- hierarchyId
is not
foundNullArgumentException
- hierarchyId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchySequencing()
or
supportsVisibleFederation()
is false
optional
- This method must be implemented if
supportsHierarchySequencing()
and
supportsVisibleFederation()
are true.
HierarchyStructureNotificationSession getHierarchyStructureNotificationSession(HierarchyStructureReceiver hierarchyStructureReceiver, Proxy proxy) throws OperationFailedException
hierarchyStructureReceiver
- a receiverproxy
- a proxy HierarchyStructureNotificationSession
NullArgumentException
-
hierarchyStructureReceiver
or proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchyStructureNotification()
is
false
optional
- This method must be implemented if
supportsHierarchyStructureNotification()
is
true.
HierarchyStructureNotificationSession getHierarchyStructureNotificationSessionForHierarchy(HierarchyStructureReceiver hierarchyStructureReceiver, Id hierarchyId, Proxy proxy) throws NotFoundException, OperationFailedException
hierarchyStructureReceiver
- a receiverhierarchyId
- the Id
of the hierarchyproxy
- a proxy HierarchyStructureNotificationSession
NotFoundException
- hierarchyId
is not
foundNullArgumentException
-
hierarchyStructureReceiver, hierarchyId
or
proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchyStructureNotification()
is
false
optional
- This method must be implemented if
supportsHierarchyStructureNotification()
and
supportsVisibleFederation()
are
true.
HierarchyLookupSession getHierarchyLookupSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hierarchy
lookup service.proxy
- a proxy HierarchyLookupSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchyLookup()
is false
optional
- This method must be implemented if
supportsHierarchyLookup()
is true.
HierarchyQuerySession getHierarchyQuerySession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hierarchy
query service.proxy
- a proxy HierarchyQuerySession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchyQuery()
is false
optional
- This method must be implemented if
supportsHierarchyQuery()
is true.
HierarchySearchSession getHierarchySearchSession(Proxy proxy) throws OperationFailedException
OsidSession
associated with the hierarchy
search service.proxy
- a proxy HierarchySearchSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchySearch()
is false
optional
- This method must be implemented if
supportsHierarchySearch()
is true.
HierarchyAdminSession getHierarchyAdminSession(Proxy proxy) throws OperationFailedException
proxy
- a proxy HierarchyAdminSession
NullArgumentException
- proxy
is
null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchyAdmin()
is false
optional
- This method must be implemented if
supportsHierarchyAdmin()
is true.
HierarchyNotificationSession getHierarchyNotificationSession(HierarchyReceiver hierarchyReceiver, Proxy proxy) throws OperationFailedException
hierarchyReceiver
- notification callbackproxy
- a proxy HierarchyNotificationSession
NullArgumentException
- hierarchyReceiver
or proxy
is null
OperationFailedException
- unable to complete requestUnimplementedException
-
supportsHierarchyNotification()
is false
optional
- This method must be implemented if
supportsHierarchyNotification()
is true.