Sonic Management API

com.sonicsw.mf.mgmtapi.config.gen
Interface IAbstractHostManagerBean

All Superinterfaces:
com.sonicsw.mx.config.IAnnotationExtension, IMgmtBase, IMgmtBeanBase
All Known Subinterfaces:
IHostManagerBean

public interface IAbstractHostManagerBean
extends IMgmtBeanBase

Configuration Bean representing a 'HostManager'


Field Summary
 
Fields inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase
C_VERSION_PROPERTY, CLASS_PROPERTY, P_VERSION_PROPERTY, TEMPLATE_PROPERTY, TYPE_PROPERTY
 
Fields inherited from interface com.sonicsw.mx.config.IAnnotationExtension
END_CDATA, START_CDATA, TOOL_ANNOTATION
 
Method Summary
 java.lang.String getArchiveName()
          Get the attribute for ARCHIVE_NAME as a String value.
 IMgmtAttributeMetaData getArchiveNameMetaData()
          Get the attribute metadata for ARCHIVE_NAME.
 java.lang.String getClassname()
          Get the attribute for CLASSNAME as a String value.
 IMgmtAttributeMetaData getClassnameMetaData()
          Get the attribute metadata for CLASSNAME.
 java.lang.String getClasspath()
          Get the attribute for CLASSPATH as a String value.
 java.lang.String getClasspath(java.lang.String defValue)
          Get the attribute for CLASSPATH as a String value.
 IMgmtAttributeMetaData getClasspathMetaData()
          Get the attribute metadata for CLASSPATH.
 void setArchiveName(java.lang.String value)
          Set the attribute for ARCHIVE_NAME to the specified String value.
 void setClasspath(java.lang.String value)
          Set the attribute for CLASSPATH to the specified String value.
 
Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBeanBase
clone, createUniqueName, getBigDecimalAttribute, getBooleanAttribute, getByteArrayAttribute, getIntegerAttribute, getLongAttribute, getProperty, getReferenceAttribute, getStringAttribute, isNewBean, setBigDecimalAttribute, setBooleanAttribute, setByteArrayAttribute, setIntegerAttribute, setLongAttribute, setReferenceAttribute, setStringAttribute
 
Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtBase
getAttributeList, getAttributeMap, getAttributeMetaData, getConfigBean, getConfigBeanName, getConfigBeanNameTail, getConfigPath, getConfigPath, getMgmtBeanFactory, getParent, removeAttribute, setAttribute
 
Methods inherited from interface com.sonicsw.mx.config.IAnnotationExtension
getAnnotation, setAnnotation
 

Method Detail

getArchiveName

java.lang.String getArchiveName()
                                throws MgmtException
Get the attribute for ARCHIVE_NAME as a String value.

Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getArchiveNameMetaData

IMgmtAttributeMetaData getArchiveNameMetaData()
                                              throws MgmtException
Get the attribute metadata for ARCHIVE_NAME.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getClassname

java.lang.String getClassname()
                              throws MgmtException
Get the attribute for CLASSNAME as a String value.

Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getClassnameMetaData

IMgmtAttributeMetaData getClassnameMetaData()
                                            throws MgmtException
Get the attribute metadata for CLASSNAME.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

getClasspath

java.lang.String getClasspath()
                              throws MgmtException
Get the attribute for CLASSPATH as a String value. This is an optional attribute and a MgmtException will be thrown if the attribute does not exist.

Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getClasspath

java.lang.String getClasspath(java.lang.String defValue)
                              throws MgmtException
Get the attribute for CLASSPATH as a String value. If the attribute doesn't exist then return the specified default value.

Parameters:
defValue - The default value to return if this attribute doesn't exist
Returns:
The String value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getClasspathMetaData

IMgmtAttributeMetaData getClasspathMetaData()
                                            throws MgmtException
Get the attribute metadata for CLASSPATH.

Returns:
The IMgmtAttributeMetaData value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute's metadata

setArchiveName

void setArchiveName(java.lang.String value)
                    throws MgmtException
Set the attribute for ARCHIVE_NAME to the specified String value.

Parameters:
value - The String value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

setClasspath

void setClasspath(java.lang.String value)
                  throws MgmtException
Set the attribute for CLASSPATH to the specified String value.

Parameters:
value - The String value for this attribute
Throws:
MgmtException - Thrown if there is some problem setting this attribute

Sonic Management API

Copyright © 2001-2011 Progress Software Corporation. All Rights Reserved.
HTML formatted on 12-Aug-2011.