Sonic Management API

com.sonicsw.mq.mgmtapi.config.gen
Interface IAbstractQueuesBean.IAbstractQueuesSetType

All Superinterfaces:
IMgmtBase, IMgmtMapBase, IMgmtSubBeanBase
All Known Subinterfaces:
IQueuesBean.IQueuesSetType
Enclosing interface:
IAbstractQueuesBean

public static interface IAbstractQueuesBean.IAbstractQueuesSetType
extends IMgmtMapBase

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


Method Summary
 void addQueue(java.lang.String name, IQueuesBean.IQueueAttributes value)
          Add the new Queue of type IQueuesBean.IQueueAttributes into this map keyed off the specified key name
 IQueuesBean.IQueueAttributes createQueue()
          Create an instance of an IQueuesBean.IQueueAttributes attribute.
 void deleteQueue(java.lang.String name)
          Delete the item with the specified name from this map
 IQueuesBean.IQueueAttributes getQueue(java.lang.String name)
          Get the IQueuesBean.IQueueAttributes atribute from the map with the specified key name
 IMgmtAttributeMetaData getQueueMetaData()
          Get the attribute metadata for queue.
 
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

addQueue

void addQueue(java.lang.String name,
              IQueuesBean.IQueueAttributes value)
              throws MgmtException
Add the new Queue of type IQueuesBean.IQueueAttributes into this map keyed off the specified key name

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

createQueue

IQueuesBean.IQueueAttributes createQueue()
                                         throws MgmtException
Create an instance of an IQueuesBean.IQueueAttributes 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 addQueue or insertQueue methods

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

deleteQueue

void deleteQueue(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

getQueue

IQueuesBean.IQueueAttributes getQueue(java.lang.String name)
                                      throws MgmtException
Get the IQueuesBean.IQueueAttributes atribute from the map with the specified key name

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

getQueueMetaData

IMgmtAttributeMetaData getQueueMetaData()
                                        throws MgmtException
Get the attribute metadata for queue.

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-2011 Progress Software Corporation. All Rights Reserved.
HTML formatted on 12-Aug-2011.