com.ibm.datapower.wamt.amp
Class ConfigObject

java.lang.Object
  extended by com.ibm.datapower.wamt.amp.ConfigObject

public class ConfigObject
extends java.lang.Object

This class is used to represent the basis information of a object (service)


Field Summary
static java.lang.String COPYRIGHT_2012_2013
           
 
Constructor Summary
ConfigObject(java.lang.String name, java.lang.String className, java.lang.String classDisplayName, java.lang.String userComment)
          Construct a new ConfigObject object.
ConfigObject(java.lang.String name, java.lang.String className, java.lang.String classDisplayName, java.lang.String userComment, ConfigObject[] referencedObject, boolean refState)
          Construct a new ConfigObject object with referenced configobject.
 
Method Summary
 java.lang.String getClassDisplayName()
          Get the class display name of this configobject
 java.lang.String getClassName()
          Get the class name of this configobject
 java.lang.String getName()
          Get the name of this configobject
 java.lang.String getPrimaryKey()
          Get the pre-built String that could be used as a primary key for this object if you need to get it anywhere or put it in a hash collection.
 ConfigObject[] getReferencedObjects()
          Get the referenced object(s) by this configobject
 java.lang.String getUserComment()
          Get the user comment of this configobject
 boolean isReferencedExternally()
          Get a boolean value which indicates if this object is referenced by other object externally
 void setReferencedObject(ConfigObject[] configObject)
          Get the referenced object(s) by this configobject
 java.lang.String toString()
          Get a String representation of object for the purpose of debugging or tracing
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

COPYRIGHT_2012_2013

public static final java.lang.String COPYRIGHT_2012_2013
See Also:
Constant Field Values
Constructor Detail

ConfigObject

public ConfigObject(java.lang.String name,
                    java.lang.String className,
                    java.lang.String classDisplayName,
                    java.lang.String userComment)
Construct a new ConfigObject object.

Parameters:
name - the name of this configobject
className - the class name of this configobject
classDisplayName - the display name of this configobject
userComment - the user comments of this configobject

ConfigObject

public ConfigObject(java.lang.String name,
                    java.lang.String className,
                    java.lang.String classDisplayName,
                    java.lang.String userComment,
                    ConfigObject[] referencedObject,
                    boolean refState)
Construct a new ConfigObject object with referenced configobject.

Parameters:
name - the name of this configobject
className - the class name of this configobject
classDisplayName - the display name of this configobject
userComment - the user comments of this configobject
referencingObject - the referencing object of this configobject
Method Detail

getName

public java.lang.String getName()
Get the name of this configobject

Returns:
the String representation of this object's name

getClassName

public java.lang.String getClassName()
Get the class name of this configobject

Returns:
the String representation of this object's class name

getClassDisplayName

public java.lang.String getClassDisplayName()
Get the class display name of this configobject

Returns:
the String representation of this object's display name

getUserComment

public java.lang.String getUserComment()
Get the user comment of this configobject

Returns:
the String representation of this object's user comments

setReferencedObject

public void setReferencedObject(ConfigObject[] configObject)
Get the referenced object(s) by this configobject


getReferencedObjects

public ConfigObject[] getReferencedObjects()
Get the referenced object(s) by this configobject

Returns:
the referenced object(s) by this configobject

isReferencedExternally

public boolean isReferencedExternally()
Get a boolean value which indicates if this object is referenced by other object externally

Returns:
a boolean value (True means the object is referenced by other object externally)

getPrimaryKey

public java.lang.String getPrimaryKey()
Get the pre-built String that could be used as a primary key for this object if you need to get it anywhere or put it in a hash collection. Although this method isn't necessary for users of the clientAPI, it may be helpful for them to have so they don't need to implement it themselves. It is used internally within the clientAPI and is exposed here for your convenience.

Returns:
a String that could represent a unique instance of this object. It use the Name and ClassName as the primary key. (i.e. Name:Classname)

toString

public java.lang.String toString()
Get a String representation of object for the purpose of debugging or tracing

Overrides:
toString in class java.lang.Object
Returns:
a String representation


© Copyright IBM Corp. 2006, 2010 All Rights Reserved.