lumis.portal.monitor
Interface IMeasureType

public interface IMeasureType

A type of measure that may be collected. A measure specified a kind of data that is collected.

This interface contains the constants for standard measure keys.

Since:

4.1.0

See Also:

lumis.portal.monitor

Field Summary

static String	MEASURE_TYPE_ACTIVITY_MS The key for the activity in milliseconds measure type.
static String	MEASURE_TYPE_DURATION_MS The key for the duration in milliseconds measure type.
static String	MEASURE_TYPE_SIZE_BYTE The key for the size in bytes measure type.
static String	MEASURE_TYPE_TRANSACTION_COMMIT The key for the transaction commit measure type.
static String	MEASURE_TYPE_TRANSACTION_ROLLBACK The key for the transaction rollback measure type.

Method Summary

String	getDescription() Returns the description for this measure type.
String	getId() Returns the identifier for this measure type.
String	getMeasureTypeKey() Returns the key for this measure type.
String	getName() Returns the name for this measure type.
String	getStringResourcePath() The string resource path for localizing this measure type's strings.
String	getUnit() Returns the unit display name for this measure type.
void	setDescription(String description) Sets the description for this measure type.
void	setMeasureTypeKey(String key) Sets the key for this measure type.
void	setName(String name) Sets the name for this measure type.
void	setStringResourcePath(String stringResourcePath) Sets the string resource path for this measure type.
void	setUnit(String unit) Sets the unit display name for this measure type.

Field Detail

MEASURE_TYPE_DURATION_MS

static final String MEASURE_TYPE_DURATION_MS

The key for the duration in milliseconds measure type.

Since:

4.1.0

See Also:

Constant Field Values

MEASURE_TYPE_ACTIVITY_MS

static final String MEASURE_TYPE_ACTIVITY_MS

The key for the activity in milliseconds measure type.

Since:

4.1.0

See Also:

Constant Field Values

MEASURE_TYPE_SIZE_BYTE

static final String MEASURE_TYPE_SIZE_BYTE

The key for the size in bytes measure type.

Since:

4.1.0

See Also:

Constant Field Values

MEASURE_TYPE_TRANSACTION_COMMIT

static final String MEASURE_TYPE_TRANSACTION_COMMIT

The key for the transaction commit measure type.

Since:

4.1.0

See Also:

Constant Field Values

MEASURE_TYPE_TRANSACTION_ROLLBACK

static final String MEASURE_TYPE_TRANSACTION_ROLLBACK

The key for the transaction rollback measure type.

Since:

4.1.0

See Also:

Constant Field Values

Method Detail

getId

String getId()

Returns the identifier for this measure type.

Returns:

the identifier for this measure type.

Since:

4.1.0

getDescription

String getDescription()

Returns the description for this measure type. The description is localizable using getStringResourcePath().

Returns:

the description for this measure type.

Since:

4.1.0

setDescription

void setDescription(String description)

Sets the description for this measure type.

Parameters:

description - the description to set.

Since:

4.1.0

See Also:

getDescription()

getName

String getName()

Returns the name for this measure type. The name is localizable using getStringResourcePath().

Returns:

the name for this measure type.

Since:

4.1.0

setName

void setName(String name)

Sets the name for this measure type.

Parameters:

name - the name to set.

Since:

4.1.0

See Also:

getName()

getUnit

String getUnit()

Returns the unit display name for this measure type. The unit is localizable using getStringResourcePath().

Returns:

the unit display name for this measure type.

Since:

4.1.0

setUnit

void setUnit(String unit)

Sets the unit display name for this measure type.

Parameters:

unit - the unit display name to set.

Since:

4.1.0

See Also:

getUnit()

getStringResourcePath

String getStringResourcePath()

The string resource path for localizing this measure type's strings.

Returns:

the string resource path.

Since:

4.1.0

setStringResourcePath

void setStringResourcePath(String stringResourcePath)

Sets the string resource path for this measure type.

Parameters:

stringResourcePath - the string resource path.

Since:

4.1.0

See Also:

getStringResourcePath()

getMeasureTypeKey

String getMeasureTypeKey()

Returns the key for this measure type. This key is a friendly unique identifier for this measure type.

Returns:

this measure type's key.

Since:

4.1.0

setMeasureTypeKey

void setMeasureTypeKey(String key)

Sets the key for this measure type.

Parameters:

key - the key.

Since:

4.1.0

See Also:

getMeasureTypeKey()