org.opengroup.arm40.metric
Interface ArmTransactionWithMetrics

All Superinterfaces:
ArmInterface, ArmTransaction
All Known Implementing Classes:
ArmTransactionWithMetrics

public interface ArmTransactionWithMetrics
extends ArmTransaction

A subclass of ArmTransaction that is used if the application wishes to use metrics. All the ArmTransaction rules for using start(), stop(), etc., apply to this interface. It extends ArmTransaction by adding methods to manipulate metrics. The ArmMetric subclass objects are bound to an ArmTransactionWithMetrics object when it is created. This is done by specifying ArmMetricGroup in the newArmTransactionWithMetrics() method of ArmMetricFactory.

Objects implementing this interface are created using ArmMetricFactory.newArmTransactionWithMetrics(org.opengroup.arm40.transaction.ArmApplication, org.opengroup.arm40.metric.ArmTransactionWithMetricsDefinition, org.opengroup.arm40.metric.ArmMetricGroup).

Author:
ARM Working Group of The Open Group

Method Summary
 ArmMetricGroup getMetricGroup()
           
 ArmTransactionWithMetricsDefinition getTransactionWithMetricsDefinition()
           
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmTransaction
bindThread, blocked, getApplication, getContextURIValue, getContextValue, getCorrelator, getDefinition, getParentCorrelator, getStatus, getUser, isTraceRequested, reset, setArrivalTime, setContextURIValue, setContextValue, setTraceRequested, setUser, start, start, start, start, stop, stop, unbindThread, unblocked, update
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Method Detail

getTransactionWithMetricsDefinition

ArmTransactionWithMetricsDefinition getTransactionWithMetricsDefinition()
Returns:
the object that contains the metadata describing this transaction, including the metric definitions.

getMetricGroup

ArmMetricGroup getMetricGroup()
Returns:
the object that was bound when ArmTransactionWithMetrics is created. The returned value may be null.