org.arm4.arm40.transaction

Class ArmTransactionDefinition

java.lang.Object

org.arm4.arm40.transaction.ArmInterface

org.arm4.arm40.transaction.ArmTransactionDefinition

All Implemented Interfaces:

ArmInterface, ArmTransactionDefinition

Direct Known Subclasses:

ArmTransactionWithMetricsDefinition

public class ArmTransactionDefinition
extends ArmInterface
implements ArmTransactionDefinition

ArmTransactionDefinition contains the metadata that is the same for all instances of a transaction type (represented by ArmTransaction or ArmTranReport). ArmTransactionDefinition is created with the newArmTransactionDefinition() method of ArmTransactionFactory.

Version:

$Revision$ $Date$

Author:

dcarter

Field Summary

Fields

Modifier and Type	Field and Description
protected ArmID	m_alias
protected ArmApplicationDefinition	m_appDefinition
protected ArmID	m_id
protected ArmMetricGroupDefinition	m_metricGroupDefinition
protected java.lang.String	m_name
protected ArmIdentityPropertiesTransaction	m_properties

Fields inherited from class org.arm4.arm40.transaction.ArmInterface

m_errorCode, m_factory

Constructor Summary

Constructors

Constructor and Description
ArmTransactionDefinition(ArmApplicationDefinition appDefinition, java.lang.String name, ArmIdentityPropertiesTransaction identityProperties, ArmID id, ArmFactory factory) Create the ARM Transaction Definition.
ArmTransactionDefinition(ArmApplicationDefinition appDefinition, java.lang.String name, ArmIdentityPropertiesTransaction identityProperties, ArmMetricGroupDefinition metricGroupDefinition, ArmID id, ArmFactory factory) Create the ARM Transaction Definition.

Method Summary

Methods

Modifier and Type	Method and Description
ArmApplicationDefinition	getApplicationDefinition()
ArmID	getID()
ArmIdentityPropertiesTransaction	getIdentityProperties()
ArmID	getImplementationID() Get the internal transaction ID.
protected ArmMetricGroupDefinition	getMetricGroupDefinition() Get the metric group definition.
java.lang.String	getName()

Methods inherited from class org.arm4.arm40.transaction.ArmInterface

getErrorCode, getErrorMessage, getFactory, setErrorCode, setFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface

getErrorCode, getErrorMessage, setErrorCode

Field Detail

m_appDefinition

protected ArmApplicationDefinition m_appDefinition

m_name

protected java.lang.String m_name

m_properties

protected ArmIdentityPropertiesTransaction m_properties

m_metricGroupDefinition

protected ArmMetricGroupDefinition m_metricGroupDefinition

m_id

protected ArmID m_id

m_alias

protected ArmID m_alias

Constructor Detail

ArmTransactionDefinition

public ArmTransactionDefinition(ArmApplicationDefinition appDefinition,
                        java.lang.String name,
                        ArmIdentityPropertiesTransaction identityProperties,
                        ArmID id,
                        ArmFactory factory)

Create the ARM Transaction Definition.

Parameters:

appDefinition -

name -

identityProperties -

id -

factory -

ArmTransactionDefinition

public ArmTransactionDefinition(ArmApplicationDefinition appDefinition,
                        java.lang.String name,
                        ArmIdentityPropertiesTransaction identityProperties,
                        ArmMetricGroupDefinition metricGroupDefinition,
                        ArmID id,
                        ArmFactory factory)

Create the ARM Transaction Definition.

Parameters:

appDefinition -

name -

identityProperties -

metricGroupDefinition -

id -

factory -

Method Detail

getApplicationDefinition

public ArmApplicationDefinition getApplicationDefinition()

Specified by:

getApplicationDefinition in interface ArmTransactionDefinition

Returns:

the metadata describing the contaning application.

getID

public ArmID getID()

Specified by:

getID in interface ArmTransactionDefinition

Returns:

a 16-byte ID associated with the identity of this application definition, or null.

getIdentityProperties

public ArmIdentityPropertiesTransaction getIdentityProperties()

Specified by:

getIdentityProperties in interface ArmTransactionDefinition

Returns:

an object describing the identity property metadata associated with this transaction, or null. See the discussion in ArmIdentityProperties.

getName

public java.lang.String getName()

Specified by:

getName in interface ArmTransactionDefinition

Returns:

the name of this transaction.

getImplementationID

public ArmID getImplementationID()

Get the internal transaction ID.

Returns:

getMetricGroupDefinition

protected ArmMetricGroupDefinition getMetricGroupDefinition()

Get the metric group definition.

Returns: