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

Inheritance diagram for arm4::ArmTransactionDefinition:

Public Member Functions
	ArmTransactionDefinition (const ArmApplicationDefinition &app, const std::string &name, const ArmIdentityPropertiesTransaction &identityProperties=ArmIdentityPropertiesTransaction::Null, const ArmID &id=ArmID::Null)
	Constructs an object that represents the metadata about a transaction.
const ArmApplicationDefinition &	getApplicationDefinition () const
	the metadata describing the contaning application.
const ArmIdentityPropertiesTransaction &	getIdentityProperties () const
	returns the identity property metadata object.

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 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 ArmID::Null, is the same value passed to the ArmTransactionDefinition() constructor. 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 ArmIdentityPropertiesTransaction::Null.

Constructor & Destructor Documentation

arm4::ArmTransactionDefinition::ArmTransactionDefinition	(	const ArmApplicationDefinition &	app,
		const std::string &	name,
		const ArmIdentityPropertiesTransaction &	identityProperties = `ArmIdentityPropertiesTransaction::Null`,
		const ArmID &	id = `ArmID::Null`
	)

Constructs an object that represents the metadata about a transaction.

Parameters:

	app	the metadata describing the type of the containing application.
	name	the name of the transaction type. A name should be chosen that is unique. Must not be a `NullString`.
	identityProperties	a set of properties contibuting to the identity of the transaction definition. May be `ArmIdentityPropertiesTransaction::Null`.
	id	An optional 16-byte ID associated with the identity of the transaction definition.

const ArmApplicationDefinition& arm4::ArmTransactionDefinition::getApplicationDefinition ( ) const

the metadata describing the contaning application.

const ArmIdentityPropertiesTransaction& arm4::ArmTransactionDefinition::getIdentityProperties ( ) const

returns the identity property metadata object.

Returns:: an object describing the identity property metadata associated with this transaction, or ArmIdentityPropertiesTransaction::Null. See the discussion in ArmIdentityProperties.

The documentation for this class was generated from the following file: