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

Inheritance diagram for arm4::QArmTransactionDefinition:

Public Member Functions
	QArmTransactionDefinition (const QArmApplicationDefinition &app, const QString &name, const QArmIdentityPropertiesTransaction &identityProperties=QArmIdentityPropertiesTransaction::Null, const QArmID &id=QArmID::Null)
	Constructs an object that represents the metadata about a transaction.
const QArmApplicationDefinition &	getApplicationDefinition () const
	the metadata describing the contaning application.
const QArmIdentityPropertiesTransaction &	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 QArmTransaction or QArmTranReport). QArmTransactionDefinition 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 QArmIdentityProperties.
(optional) ID. An optional 16-byte ID may be associated with the identity of a transaction definition. The returned value, which could be QArmID::Null, is the same value passed to the QArmTransactionDefinition() constructor. The ID value is bound to a unique combination of the application identity (represented by QArmApplicationDefinition), 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 QArmIdentityPropertiesTransaction::Null.

Constructor & Destructor Documentation

arm4::QArmTransactionDefinition::QArmTransactionDefinition	(	const QArmApplicationDefinition &	app,
		const QString &	name,
		const QArmIdentityPropertiesTransaction &	identityProperties = `QArmIdentityPropertiesTransaction::Null`,
		const QArmID &	id = `QArmID::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 `QArmIdentityPropertiesTransaction::Null`.
	id	An optional 16-byte ID associated with the identity of the transaction definition.

const QArmApplicationDefinition& arm4::QArmTransactionDefinition::getApplicationDefinition ( ) const

the metadata describing the contaning application.

const QArmIdentityPropertiesTransaction& arm4::QArmTransactionDefinition::getIdentityProperties ( ) const

returns the identity property metadata object.

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

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