Public Member Functions

OpenGroup::arm40::Provisional::transaction::IArmApplicationDefinition Interface Reference
[ARM 4.0 Applications, ARM 4.0 Definitions]

Describes the attributes of an application that do not change from one instance of the application to another. More...

Inheritance diagram for OpenGroup::arm40::Provisional::transaction::IArmApplicationDefinition:
OpenGroup::arm40::Provisional::transaction::IArmInterface

List of all members.

Public Member Functions

string getName ()
 the name of this application.
IArmIdentityProperties getIdentityProperties ()
 returns an object describing the identity property metadata.
IArmID getID ()
 returns a 16-byte ID associated with the identity of this application definition.
void destroy ()
 Signal to the ARM implementation that the definition and all related definitions within its scope are no longer needed.

Detailed Description

This provides an anchor point for associating IArmTransactionDefinition and IArmMetricDefinition objects with the application. It has the following attributes, all of which are immutable:

  • Name. The maximum length is 127 characters (CIM allows 256 but ARM 4.0 C Bindings allow 128 characters, including the null-termination character, so 127 is used). The name must not be null or zero-length. A name should be chosen that is unique, so generic names that might be used by a different development team, such as "Payroll Application", should not be used. Names should not contain trailing blank characters or consist of only blank 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 an application definition. The returned value, which could be null, is the same value passed to IArmTransactionFactory.newArmApplicationDefinition The ID value is bound to a unique combination of the application name, 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.

destroy does not, of course, destroy the IArmApplicationDefinition object. It does signal to the ARM implementation that the definition and all related definitions (e.g., IArmTransactionDefinition) within its scope are no longer needed. The normal behavior would be for the ARM implementation to release its references to all those objects. If the application also releases its references, the objects would be eligible for garbage collection. After destroy() is called, no method on any object that is scoped by the IArmApplicationDefinition should be called again. If a method is called, the results are unpredictable.

Objects implementing this interface are created using IArmTransactionFactory.newArmApplicationDefinition

Member Function Documentation

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