Sonic Management API

com.sonicsw.mf.mgmtapi.config.gen
Interface IAbstractComponentCollectionBean.IAbstractMetricListType

All Superinterfaces:
IMgmtBase, IMgmtListBase, IMgmtSubBeanBase
All Known Subinterfaces:
IComponentCollectionBean.IMetricListType
Enclosing interface:
IAbstractComponentCollectionBean

public static interface IAbstractComponentCollectionBean.IAbstractMetricListType
extends IMgmtListBase

Inner class representing MetricListType This inner class contains inner data items that have a zero based index. This class extends IMgmtListBase


Method Summary
 void addListItem(java.lang.String value)
          Add the new ListItem of type String into this list at the end of the list
 void deleteListItem(int index)
          Delete the item at the specified index from the list
 java.lang.String getListItem(int index)
          Get the String atribute from the list at the specified index
 IMgmtAttributeMetaData getListItemMetaData()
          Get the attribute metadata for listItem.
 void insertListItem(int index, java.lang.String value)
          Insert the new ListItem of type String into this list at the specified location
 
Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtListBase
add, delete, getCount, insert
 
Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtSubBeanBase
getBigDecimalAttribute, getBooleanAttribute, getByteArrayAttribute, getIntegerAttribute, getLongAttribute, getReferenceAttribute, getStringAttribute, 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
 

Method Detail

addListItem

void addListItem(java.lang.String value)
                 throws MgmtException
Add the new ListItem of type String into this list at the end of the list

Parameters:
value - The String value to add to the list
Throws:
MgmtException - Thrown if there is some problem adding this item to the list

deleteListItem

void deleteListItem(int index)
                    throws MgmtException
Delete the item at the specified index from the list

Parameters:
index - The index of the item to delete
Throws:
MgmtException - Thrown if there is some problem deleting this item from the list

getListItem

java.lang.String getListItem(int index)
                             throws MgmtException
Get the String atribute from the list at the specified index

Parameters:
index - The index of the ListItem in the list.
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

getListItemMetaData

IMgmtAttributeMetaData getListItemMetaData()
                                           throws MgmtException
Get the attribute metadata for listItem.

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

insertListItem

void insertListItem(int index,
                    java.lang.String value)
                    throws MgmtException
Insert the new ListItem of type String into this list at the specified location

Parameters:
index - The location in the list to add the new item
value - The String value to add to the list
Throws:
MgmtException - Thrown if there is some problem inserting this item into the list

Sonic Management API

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