com.businessobjects.sdk.monitoring.probe
Interface IVirtualMetric

All Known Implementing Classes:

VirtualMetric

public interface IVirtualMetric

This interface is used to access the properties of a Virtual Metric.

Method Summary

PropertyBag	getBag() This method is used to retrieve the property 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 is used to set the name of the metric.
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.

Method Detail

getName

java.lang.String getName()

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

Returns:

Name of the metric

setName

void setName(java.lang.String name)

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

Parameters:

name - Name of the metric

getDesc

java.lang.String getDesc()

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

Returns:

Description of the metric

setDesc

void setDesc(java.lang.String desc)

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

Parameters:

desc - Description of the metric

getValue

java.lang.Object getValue()

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

Returns:

Value of the metric

setValue

void setValue(java.lang.Object value)

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

Parameters:

value - Value of the metric

getType

java.lang.String getType()

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

Returns:

Type of the metric

getVMAssociations

IVMAssociations getVMAssociations()

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

Returns:

Association bag

setVMAssociations

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

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

Parameters:

cuids - array of cuids

getBag

PropertyBag getBag()

This method is used to retrieve the property bag containing the Virtual Metrics information.

Returns:

PropertyBag

setUnit

void setUnit(java.lang.String unit)

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

Parameters:

unit - Unit of measurement

getUnit

java.lang.String getUnit()

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

Returns:

String Unit of measurement

getServerKinds

java.lang.String[] getServerKinds()

This method is used to retrieve the server kinds.

Returns:

Server kinds to which the metric is associated.