Public Member Functions

org.opengroup.arm40.transaction.ArmTransactionDefinition Interface Reference
[ARM 4.0 Transactions, ARM 4.0 Definitions]

Contains the metadata that is the same for all instances of a transaction type. More...

Inheritance diagram for org.opengroup.arm40.transaction.ArmTransactionDefinition:
org.opengroup.arm40.transaction.ArmInterface org.opengroup.arm40.metric.ArmTransactionWithMetricsDefinition

List of all members.

Public Member Functions

ArmApplicationDefinition getApplicationDefinition ()
ArmID getID ()
ArmIdentityPropertiesTransaction getIdentityProperties ()
String getName ()

Detailed Description

Contains the metadata that is the same for all instances of a transaction type.

The metadata can be used to describe types of instances represented by ArmTransaction or ArmTranReport). ArmTransactionDefinition has the following attributes, all of which are immutable:

  • The definition of the application that contains the transaction. It must not be null.
  • The name of the transaction (maximum 127 characters).
  • (optional) Identity property names and values and context property names in arrays. See the discussion of identity and context property names in ArmIdentityProperties.
  • (optional) ID. An optional 16-byte ID may be associated with the identity of a transaction definition. The returned value, which could be null, is the same value passed to the newArmTransactionDefinition() method of ArmTransactionFactory. The ID value is bound to a unique combination of the application identity (represented by ArmApplicationDefinition), transaction name, any URI identity property, any identity property names and values, and any context property names. When provided, the ID may be used as a concise alias for the unique combination. It may be null.

Objects implementing this interface are created using ArmTransactionFactory#newArmTransactionDefinition.

Author:
ARM Working Group of The Open Group

Member Function Documentation

ArmApplicationDefinition org.opengroup.arm40.transaction.ArmTransactionDefinition.getApplicationDefinition (  ) 
Returns:
the metadata describing the contaning application.
ArmID org.opengroup.arm40.transaction.ArmTransactionDefinition.getID (  ) 
Returns:
a 16-byte ID associated with the identity of this application definition, or null.
ArmIdentityPropertiesTransaction org.opengroup.arm40.transaction.ArmTransactionDefinition.getIdentityProperties (  ) 
Returns:
an object describing the identity property metadata associated with this transaction, or null. See the discussion in ArmIdentityProperties.
String org.opengroup.arm40.transaction.ArmTransactionDefinition.getName (  ) 
Returns:
the name of this transaction.
The documentation for this interface was generated from the following file:
  • org/opengroup/arm40/transaction/ArmTransactionDefinition.java
MyARM
Documentation generated on Thu May 24 2018 22:24:15. © 2018 by MyARM GmbH