Sonic Management API

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

All Superinterfaces:
IMgmtBase, IMgmtMapBase, IMgmtSubBeanBase
All Known Subinterfaces:
IComponentCollectionBean.IComponentsSet
Enclosing interface:
IAbstractComponentCollectionBean

public static interface IAbstractComponentCollectionBean.IAbstractComponentsSet
extends IMgmtMapBase

Inner class representing ComponentsSet This inner class contains inner data items that are keyed off a name. This class extends IMgmtMapBase


Method Summary
 void addEntry(java.lang.String name, IComponentCollectionBean.IComponent value)
          Add the new Entry of type IComponentCollectionBean.IComponent into this map keyed off the specified key name
 IComponentCollectionBean.IComponent createEntry()
          Create an instance of an IComponentCollectionBean.IComponent attribute.
 void deleteEntry(java.lang.String name)
          Delete the item with the specified name from this map
 IComponentCollectionBean.IComponent getEntry(java.lang.String name)
          Get the IComponentCollectionBean.IComponent atribute from the map with the specified key name
 IMgmtAttributeMetaData getEntryMetaData()
          Get the attribute metadata for entry.
 
Methods inherited from interface com.sonicsw.ma.mgmtapi.config.IMgmtMapBase
add, delete, getKeyNames
 
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

addEntry

void addEntry(java.lang.String name,
              IComponentCollectionBean.IComponent value)
              throws MgmtException
Add the new Entry of type IComponentCollectionBean.IComponent into this map keyed off the specified key name

Parameters:
name - The key name for this Entry in the map
value - The IComponentCollectionBean.IComponent value to add to the map
Throws:
MgmtException - Thrown if there is some problem adding this item to the map

createEntry

IComponentCollectionBean.IComponent createEntry()
                                                throws MgmtException
Create an instance of an IComponentCollectionBean.IComponent attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using either the addEntry or insertEntry methods

Returns:
The new IComponentCollectionBean.IComponent bean
Throws:
MgmtException - Thrown if there is some problem creating this object

deleteEntry

void deleteEntry(java.lang.String name)
                 throws MgmtException
Delete the item with the specified name from this map

Parameters:
name - The key name for the item in the map
Throws:
MgmtException - Thrown if there is some problem deleting this item from the map

getEntry

IComponentCollectionBean.IComponent getEntry(java.lang.String name)
                                             throws MgmtException
Get the IComponentCollectionBean.IComponent atribute from the map with the specified key name

Parameters:
name - The key name for this Entry within the Map
Returns:
The IComponentCollectionBean.IComponent value for this attribute
Throws:
MgmtException - Thrown when this attribute doesn't exist or if there is some problem obtaining this attribute

getEntryMetaData

IMgmtAttributeMetaData getEntryMetaData()
                                        throws MgmtException
Get the attribute metadata for entry.

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

Sonic Management API

Copyright © 2001-2012 Progress Software Corporation. All Rights Reserved.
HTML formatted on 13-Mar-2012.