com.ibm.carma.model.util
Interface CARMACommonObject


public interface CARMACommonObject

A common interface for navigating the CARMA object hierarchy without type-casting between model objects.

Since:
7.1

Field Summary
static java.lang.String COPYRIGHT
           
 
Method Summary
 java.lang.Object getCARMAObject()
          The object represented by the common interface
 java.util.Collection<CARMACommonObject> getChildren()
          Return the children of the common object if the object is a container, null otherwise.
 java.lang.String getName()
          Returns the displayable name of the Common object
 RepositoryManager getRepositoryManager()
           
 boolean isContainer()
          Returns if the object is a container.
 boolean isContentsReady()
          Returns if the object has the child contents initialized.
 

Field Detail

COPYRIGHT

static final java.lang.String COPYRIGHT
See Also:
Constant Field Values
Method Detail

getName

java.lang.String getName()
Returns the displayable name of the Common object

Returns:
displayable name of the object

isContainer

boolean isContainer()
Returns if the object is a container. If this returns true then the getChildren() method should return a non-null value.

Returns:
true if the object is a container.

isContentsReady

boolean isContentsReady()
Returns if the object has the child contents initialized. If this returns true then the getChildren() method should return a non-null value.

Returns:
true if the object has children initialized to return
Since:
7.1

getChildren

java.util.Collection<CARMACommonObject> getChildren()
Return the children of the common object if the object is a container, null otherwise.

Returns:
children of the container

getRepositoryManager

RepositoryManager getRepositoryManager()
Returns:
the Repository Manager for the object

getCARMAObject

java.lang.Object getCARMAObject()
The object represented by the common interface

Returns:
the CARMA model object