Sonic Management API

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

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

public interface IAbstractComponentCollectionBean
extends IMgmtBeanBase

Configuration Bean representing a 'ComponentCollection'


Nested Class Summary
static interface IAbstractComponentCollectionBean.IAbstractComponent
          Inner class representing Component This class extends IMgmtListBase
static interface IAbstractComponentCollectionBean.IAbstractComponentsSet
          Inner class representing ComponentsSet This inner class contains inner data items that are keyed off a name.
static interface IAbstractComponentCollectionBean.IAbstractMetricListType
          Inner class representing MetricListType This inner class contains inner data items that have a zero based index.
static interface IAbstractComponentCollectionBean.IAbstractMonitorsSet
          Inner class representing MonitorsSet This inner class contains inner data items that are keyed off a name.
static interface IAbstractComponentCollectionBean.IAbstractMonitorType
          Inner class representing MonitorType This class extends IMgmtListBase
static interface IAbstractComponentCollectionBean.IAbstractNotifList
          Inner class representing NotifList This inner class contains inner data items that have a zero based index.
static interface IAbstractComponentCollectionBean.IAbstractNotifListType
          Inner class representing NotifListType This inner class contains inner data items that have a zero based index.
 
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
 IComponentCollectionBean.INotifListType createForwardNotifications()
          Create an instance of an INotifListType attribute.
 IComponentCollectionBean.IMetricListType createMonitorMetrics()
          Create an instance of an IMetricListType attribute.
 IComponentCollectionBean.IMonitorsSet createNotificationMonitors()
          Create an instance of an IMonitorsSet attribute.
 IComponentCollectionBean.IComponentsSet getComponents()
          Get the attribute for COMPONENTS.
 IMgmtAttributeMetaData getComponentsMetaData()
          Get the attribute metadata for COMPONENTS.
 IComponentCollectionBean.INotifListType getForwardNotifications()
          Get the attribute for FORWARD_NOTIFICATIONS.
 IMgmtAttributeMetaData getForwardNotificationsMetaData()
          Get the attribute metadata for FORWARD_NOTIFICATIONS.
 int getMetricsRefreshIntervalSeconds()
          Get the attribute for METRICS_REFRESH_INTERVAL_SECONDS as a int value.
 IMgmtAttributeMetaData getMetricsRefreshIntervalSecondsMetaData()
          Get the attribute metadata for METRICS_REFRESH_INTERVAL_SECONDS.
 IComponentCollectionBean.IMetricListType getMonitorMetrics()
          Get the attribute for MONITOR_METRICS.
 IMgmtAttributeMetaData getMonitorMetricsMetaData()
          Get the attribute metadata for MONITOR_METRICS.
 IComponentCollectionBean.IMonitorsSet getNotificationMonitors()
          Get the attribute for NOTIFICATION_MONITORS.
 IMgmtAttributeMetaData getNotificationMonitorsMetaData()
          Get the attribute metadata for NOTIFICATION_MONITORS.
 void setForwardNotifications(IComponentCollectionBean.INotifListType value)
          Set the attribute for FORWARD_NOTIFICATIONS to the specified INotifListType value.
 void setMetricsRefreshIntervalSeconds(int value)
          Set the attribute for METRICS_REFRESH_INTERVAL_SECONDS to the specified int value.
 void setMonitorMetrics(IComponentCollectionBean.IMetricListType value)
          Set the attribute for MONITOR_METRICS to the specified IMetricListType value.
 void setNotificationMonitors(IComponentCollectionBean.IMonitorsSet value)
          Set the attribute for NOTIFICATION_MONITORS to the specified IMonitorsSet 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

createForwardNotifications

IComponentCollectionBean.INotifListType createForwardNotifications()
                                                                   throws MgmtException
Create an instance of an INotifListType attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setForwardNotifications method.

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

createMonitorMetrics

IComponentCollectionBean.IMetricListType createMonitorMetrics()
                                                              throws MgmtException
Create an instance of an IMetricListType attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setMonitorMetrics method.

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

createNotificationMonitors

IComponentCollectionBean.IMonitorsSet createNotificationMonitors()
                                                                 throws MgmtException
Create an instance of an IMonitorsSet attribute. This new instance is not currently part of the configuration. Once it has been configured it should be set into the configuration using the setNotificationMonitors method.

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

getComponents

IComponentCollectionBean.IComponentsSet getComponents()
                                                      throws MgmtException
Get the attribute for COMPONENTS.

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

getComponentsMetaData

IMgmtAttributeMetaData getComponentsMetaData()
                                             throws MgmtException
Get the attribute metadata for COMPONENTS.

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

getForwardNotifications

IComponentCollectionBean.INotifListType getForwardNotifications()
                                                                throws MgmtException
Get the attribute for FORWARD_NOTIFICATIONS.

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

getForwardNotificationsMetaData

IMgmtAttributeMetaData getForwardNotificationsMetaData()
                                                       throws MgmtException
Get the attribute metadata for FORWARD_NOTIFICATIONS.

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

getMetricsRefreshIntervalSeconds

int getMetricsRefreshIntervalSeconds()
                                     throws MgmtException
Get the attribute for METRICS_REFRESH_INTERVAL_SECONDS as a int value.

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

getMetricsRefreshIntervalSecondsMetaData

IMgmtAttributeMetaData getMetricsRefreshIntervalSecondsMetaData()
                                                                throws MgmtException
Get the attribute metadata for METRICS_REFRESH_INTERVAL_SECONDS.

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

getMonitorMetrics

IComponentCollectionBean.IMetricListType getMonitorMetrics()
                                                           throws MgmtException
Get the attribute for MONITOR_METRICS.

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

getMonitorMetricsMetaData

IMgmtAttributeMetaData getMonitorMetricsMetaData()
                                                 throws MgmtException
Get the attribute metadata for MONITOR_METRICS.

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

getNotificationMonitors

IComponentCollectionBean.IMonitorsSet getNotificationMonitors()
                                                              throws MgmtException
Get the attribute for NOTIFICATION_MONITORS.

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

getNotificationMonitorsMetaData

IMgmtAttributeMetaData getNotificationMonitorsMetaData()
                                                       throws MgmtException
Get the attribute metadata for NOTIFICATION_MONITORS.

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

setForwardNotifications

void setForwardNotifications(IComponentCollectionBean.INotifListType value)
                             throws MgmtException
Set the attribute for FORWARD_NOTIFICATIONS to the specified INotifListType value.

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

setMetricsRefreshIntervalSeconds

void setMetricsRefreshIntervalSeconds(int value)
                                      throws MgmtException
Set the attribute for METRICS_REFRESH_INTERVAL_SECONDS to the specified int value.

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

setMonitorMetrics

void setMonitorMetrics(IComponentCollectionBean.IMetricListType value)
                       throws MgmtException
Set the attribute for MONITOR_METRICS to the specified IMetricListType value.

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

setNotificationMonitors

void setNotificationMonitors(IComponentCollectionBean.IMonitorsSet value)
                             throws MgmtException
Set the attribute for NOTIFICATION_MONITORS to the specified IMonitorsSet value.

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

Sonic Management API

Copyright © 2001-2010 Progress Software Corporation. All Rights Reserved.
HTML formatted on 16-Sep-2010.