com.businessobjects.sdk.monitoring.probe
Class VirtualMetric

java.lang.Object
  com.businessobjects.sdk.monitoring.probe.VirtualMetric

All Implemented Interfaces:

IVirtualMetric

public class VirtualMetric
extends java.lang.Object
implements IVirtualMetric

This class is the implementation of the interface IVirtualMetric. It contains the Virtual Metric details.

Constructor Summary

VirtualMetric(java.lang.String metricName, java.lang.String metricDesc, java.lang.String unit)
This method is used to create a new Virual Metric with passed parameters.

Method Summary

PropertyBag	getBag() This method is used to retrieve the bag containing the virtual metrics information.
java.lang.String	getDesc() This method is used to retrieve the description of the metric.
java.lang.String	getName() This method is used to retrieve the name of the metric.
java.lang.String[]	getServerKinds() This method is used to retrieve the server kinds.
java.lang.String	getType() This method is used to retrieve the type of the metric.
java.lang.String	getUnit() This method is used to retrieve the unit of measurement of the Virtual Metric.
java.lang.Object	getValue() This method is used to retrieve the value of the metric.
IVMAssociations	getVMAssociations() This method is used to get all the Virtual Metrics associations stored in the Health Probe InfoObject.
void	setDesc(java.lang.String desc) This method is used to set the description of the metric.
void	setName(java.lang.String name) This method sets the name in the PropertyIDs.SI_NAME
void	setUnit(java.lang.String unit) This method is used to set the unit of measurement of the Virtual Metric (For example, milliseconds, users).
void	setValue(java.lang.Object value) This method is used to set the value of the metric.
void	setVMAssociations(java.lang.String[] cuids) This method is used to associate the cuid of the managed entity to the Virtual Metric.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VirtualMetric

public VirtualMetric(java.lang.String metricName,
                     java.lang.String metricDesc,
                     java.lang.String unit)

This method is used to create a new Virual Metric with passed parameters.

Parameters:

metricName - Name of the metric

metricDesc - Description of the metric

unit - unit of measurement

Method Detail

getName

public java.lang.String getName()

Description copied from interface: IVirtualMetric

This method is used to retrieve the name of the metric.

Specified by:

getName in interface IVirtualMetric

Returns:

Name of the metric

getValue

public java.lang.Object getValue()

Description copied from interface: IVirtualMetric

This method is used to retrieve the value of the metric.

Specified by:

getValue in interface IVirtualMetric

Returns:

Value of the metric

setValue

public void setValue(java.lang.Object value)

Description copied from interface: IVirtualMetric

This method is used to set the value of the metric.

Specified by:

setValue in interface IVirtualMetric

Parameters:

value - Value of the metric

setName

public void setName(java.lang.String name)

This method sets the name in the PropertyIDs.SI_NAME

Specified by:

setName in interface IVirtualMetric

Parameters:

name - Name of the metric

getDesc

public java.lang.String getDesc()

Description copied from interface: IVirtualMetric

This method is used to retrieve the description of the metric.

Specified by:

getDesc in interface IVirtualMetric

Returns:

Description of the metric

setDesc

public void setDesc(java.lang.String desc)

Description copied from interface: IVirtualMetric

This method is used to set the description of the metric.

Specified by:

setDesc in interface IVirtualMetric

Parameters:

desc - Description of the metric

getType

public java.lang.String getType()

Description copied from interface: IVirtualMetric

This method is used to retrieve the type of the metric.

Specified by:

getType in interface IVirtualMetric

Returns:

Type of the metric

getUnit

public java.lang.String getUnit()

Description copied from interface: IVirtualMetric

This method is used to retrieve the unit of measurement of the Virtual Metric.

Specified by:

getUnit in interface IVirtualMetric

Returns:

String Unit of measurement

setUnit

public void setUnit(java.lang.String unit)

Description copied from interface: IVirtualMetric

This method is used to set the unit of measurement of the Virtual Metric (For example, milliseconds, users).

Specified by:

setUnit in interface IVirtualMetric

Parameters:

unit - Unit of measurement

getBag

public PropertyBag getBag()

This method is used to retrieve the bag containing the virtual metrics information.

Specified by:

getBag in interface IVirtualMetric

Returns:

The Bag containing virtual metric information.

getVMAssociations

public IVMAssociations getVMAssociations()

Description copied from interface: IVirtualMetric

This method is used to get all the Virtual Metrics associations stored in the Health Probe InfoObject.

Specified by:

getVMAssociations in interface IVirtualMetric

Returns:

Association bag

setVMAssociations

public void setVMAssociations(java.lang.String[] cuids)

Description copied from interface: IVirtualMetric

This method is used to associate the cuid of the managed entity to the Virtual Metric.

Specified by:

setVMAssociations in interface IVirtualMetric

Parameters:

cuids - array of cuids

getServerKinds

public java.lang.String[] getServerKinds()

Description copied from interface: IVirtualMetric

This method is used to retrieve the server kinds.

Specified by:

getServerKinds in interface IVirtualMetric

Returns:

Server kinds to which the metric is associated.