Public Member Functions

OpenGroup::arm40::Provisional::transaction::IArmTransactionDefinition 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 OpenGroup::arm40::Provisional::transaction::IArmTransactionDefinition:
OpenGroup::arm40::Provisional::transaction::IArmInterface OpenGroup::arm40::Provisional::metric::IArmTransactionWithMetricsDefinition

List of all members.

Public Member Functions

IArmApplicationDefinition getApplicationDefinition ()
 returns the metadata describing the containing application.
IArmID getID ()
 returns a 16-byte ID associated with the identity of this transaction definition.
IArmIdentityPropertiesTransaction getIdentityProperties ()
 returns an object describing the identity property metadata associated with this transaction.
string getName ()
 returns the name of this transaction.

Detailed Description

The metadata can be used to describe types of instances represented by IArmTransaction or IArmTranReport). IArmTransactionDefinition 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 IArmIdentityProperties
  • (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 IArmTransactionFactory. The ID value is bound to a unique combination of the application identity (represented by IArmApplicationDefinition), 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 IArmTransactionFactory.newArmTransactionDefinition

Member Function Documentation

IArmApplicationDefinition OpenGroup::arm40::Provisional::transaction::IArmTransactionDefinition::getApplicationDefinition (  ) 
Returns:
the metadata describing the containing application.
IArmID OpenGroup::arm40::Provisional::transaction::IArmTransactionDefinition::getID (  ) 
Returns:
a 16-byte ID associated with the identity of this transaction definition, or null.
IArmIdentityPropertiesTransaction OpenGroup::arm40::Provisional::transaction::IArmTransactionDefinition::getIdentityProperties (  ) 
Returns:
an object describing the identity property metadata associated with this transaction, or null. See the discussion in IArmIdentityProperties
string OpenGroup::arm40::Provisional::transaction::IArmTransactionDefinition::getName (  ) 
Returns:
the name of this transaction.
The documentation for this interface was generated from the following file:
  • opengroup/arm40/provisional/transaction/IArmTransactionDefinition.cs
MyARM
Documentation generated on Thu May 24 2018 22:24:17. © 2018 by MyARM GmbH