org.opengroup.arm40.metric
Interface ArmTranReportWithMetrics

All Superinterfaces:
ArmInterface, ArmTranReport
All Known Implementing Classes:
ArmTranReportWithMetrics

public interface ArmTranReportWithMetrics
extends ArmTranReport

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

Objects implementing this interface are created using ArmMetricFactory.newArmTranReportWithMetrics(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.tranreport.ArmTranReport
generateCorrelator, getApplication, getContextURIValue, getContextValue, getCorrelator, getDefinition, getParentCorrelator, getResponseTime, getStatus, getUser, report, report, report, report, setContextURIValue, setContextValue, setParentCorrelator, setUser
 
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 ArmTranReportWithMetrics is created. The returned value may be null.