com.ibm.adt.topology.object
Interface TopologyObject
- All Known Implementing Classes:
- TopologyObjectImpl
public interface TopologyObject
getProperties
PropertyList getProperties()
throws TopologyException
- Returns:
- the TopologyObject properties
- Throws:
TopologyException
getRelatedObjects
TopologyObject[] getRelatedObjects(RelationshipMetaInfo relationship)
throws TopologyException
- Parameters:
relationship
-
- Returns:
- an array of related TopologyObject(s) corresponding to specified relationship
- Throws:
TopologyException
getRelatedObjects
TopologyObject[] getRelatedObjects(RelationshipMetaInfo relationship,
TopologyService serviceContext)
throws TopologyException
- Parameters:
relationship
- serviceContext
-
- Returns:
- an array of related TopologyObject(s) corresponding to specified relationship
- Throws:
TopologyException
getRelatedObjects
TopologyObject[] getRelatedObjects(RelationshipMetaInfo[] relationships)
throws TopologyException
- Parameters:
relationships
-
- Returns:
- an array of related TopologyObject(s) corresponding to specified relationship
- Throws:
TopologyException
getRelatedObjects
TopologyObject[] getRelatedObjects(RelationshipMetaInfo[] relationships,
TopologyService serviceContext)
throws TopologyException
- Parameters:
relationships
- serviceContext
-
- Returns:
- an array of related TopologyObject(s) corresponding to specified relationship
- Throws:
TopologyException
getRelationshipsMetaInfo
RelationshipMetaInfo[] getRelationshipsMetaInfo()
throws TopologyException
- Returns:
- all of the possible relationships for the TopologyObject
- Throws:
TopologyException
getRelationshipsMetaInfo
RelationshipMetaInfo[] getRelationshipsMetaInfo(java.lang.String relationshipKey)
throws TopologyException
- Parameters:
relationshipKey
- in the form of "key=value::key=value::..." where key can be any of
the following: relationshipType, sourceType, label, targetType, isCrossProvider, sourceRole,
targetRole, navigable, uniqueId
- Returns:
- all of the possible relationships for the TopologyObject that correspond to specifed relationshipKey
- Throws:
TopologyException
getRoot
TopologyObject getRoot()
throws TopologyException
- Returns:
- The root TopologyObject in the composition tree (usually the provider TopologyObject)
- Throws:
TopologyException
getParent
TopologyObject getParent()
throws TopologyException
- Returns:
- The parent TopologyObject
- Throws:
TopologyException
getDisplayName
java.lang.String getDisplayName()
- Returns:
- The display name for this TopologyObject
getProvider
TopologyProvider getProvider()
- Returns:
- The provider instance that contains this TopologyObject
getType
java.lang.String getType()
- Returns:
- The TopologyObject type as a string
getUniqueId
java.lang.String getUniqueId()
- Returns:
- The TopologyObject id
getFQName
java.lang.String getFQName()
throws TopologyException
- Returns:
- The fully-qualified TopologyObject name
- Throws:
TopologyException
© Copyright 2006 IBM Corp. 2006 All Rights Reserved