Public Member Functions

OpenGroup::arm40::Provisional::tranreport::IArmTranReportFactory Interface Reference
[ARM 4.0 Factories]

Provides methods to create instances of the classes in the OpenGroup.arm40.Provisional.tranreport package. More...

Inheritance diagram for OpenGroup::arm40::Provisional::tranreport::IArmTranReportFactory:
OpenGroup::arm40::Provisional::transaction::IArmInterface

List of all members.

Public Member Functions

IArmApplicationRemote newArmApplicationRemote (IArmApplicationDefinition definition, string group, string instance, string[] contextValues, IArmSystemAddress systemAddress)
 Creates an IArmApplicationRemote.
IArmSystemAddress newArmSystemAddress (short format, byte[] addressbytes, IArmID id)
 Creates an IArmSystemAddress from the specified format and the input byte array.
IArmSystemAddress newArmSystemAddress (short format, byte[] addressbytes, int offset, IArmID id)
 Creates an IArmSystemAddress from the specified format and the input byte array.
IArmSystemAddress newArmSystemAddress (short format, byte[] addressbytes, int offset, int length, IArmID id)
 Creates an IArmSystemAddress from the specified format and the input byte array.
IArmTranReport newArmTranReport (IArmApplication app, IArmTransactionDefinition definition)
 Creates an object that represents an instance of a transaction.
bool SetErrorCallback (IArmErrorCallback errorCallback)
 Registers an error callback for objects created through this factory.

Detailed Description

An error callback method can be registered for objects created with this factory (see SetErrorCallback(IArmErrorCallback) For additional details about error handling philosophy see the description of OpenGroup.arm40.Provisional.transaction.IArmTransactionFactory

Semantics of the factory methods are provided in the description of the individual methods below.

IArmTranReportFactory is instantiated using a class loader. The actual name of the factory implementation class is obtained from the system property whose name is provided in the IArmTranReportFactoryConstants.propertyKey constant.

Member Function Documentation

IArmApplicationRemote OpenGroup::arm40::Provisional::tranreport::IArmTranReportFactory::newArmApplicationRemote ( IArmApplicationDefinition  definition,
string  group,
string  instance,
string[]  contextValues,
IArmSystemAddress  systemAddress 
)

If systemAddress is null, the addressing information for the local system is used. OpenGroup.arm40.Provisional.transaction.IArmApplication

Parameters:
definition metadata describing the type of the ARM application. Must not be null.
group Name of the group the application belongs to. May be null.
instance Name this application instance is given. May be null.
contextValues An array of strings providing the value parts of (name,value) context properties. May be null.
systemAddress address of the remote system the application is executing on.
Returns:
a new ArmApplicationRemote instance.
IArmSystemAddress OpenGroup::arm40::Provisional::tranreport::IArmTranReportFactory::newArmSystemAddress ( short  format,
byte[]  addressbytes,
IArmID  id 
)

See the IArmSystemAddress description for more details about the parameters. The length of the address data is the length of addressBytes, if not restricted otherwise through the format parameter.

Parameters:
format the address format.
addressbytes a byte array containig the address data.
id An optional 16-byte ID associated with the identity of the IArmSystemAddress.
Returns:
a new IArmSystemAddress
IArmSystemAddress OpenGroup::arm40::Provisional::tranreport::IArmTranReportFactory::newArmSystemAddress ( short  format,
byte[]  addressbytes,
int  offset,
int  length,
IArmID  id 
)

See the IArmSystemAddress description for more details about the parameters. The length of the address data is length, if not restricted otherwise through the format parameter.

Parameters:
format the address format.
addressbytes a byte array containig the address data.
id An optional 16-byte ID associated with the identity of the IArmSystemAddress.
offset start of the address bytes within the array.
length the number of bytes of valid address data.
Returns:
a new IArmSystemAddress
IArmSystemAddress OpenGroup::arm40::Provisional::tranreport::IArmTranReportFactory::newArmSystemAddress ( short  format,
byte[]  addressbytes,
int  offset,
IArmID  id 
)

See the IArmSystemAddress description for more details about the parameters. The length of the address data is the length of addressBytes, if not restricted otherwise through the format parameter.

Parameters:
format the address format.
addressbytes a byte array containig the address data.
id An optional 16-byte ID associated with the identity of the IArmSystemAddress.
offset start of the address bytes within the array.
Returns:
a new IArmSystemAddress
IArmTranReport OpenGroup::arm40::Provisional::tranreport::IArmTranReportFactory::newArmTranReport ( IArmApplication  app,
IArmTransactionDefinition  definition 
)

The metadata is supplied in an IArmTransactionDefinition object. It is scoped by an application instance, represented by IArmApplication (or its subclass, IArmApplicationRemote).

Parameters:
app the application instance the transaction belongs to.
definition the metadata describing the type of the transaction.
Returns:
a new IArmTranReport instance.
bool OpenGroup::arm40::Provisional::tranreport::IArmTranReportFactory::SetErrorCallback ( IArmErrorCallback  errorCallback  ) 

See the error handling philosophy comment in the description of OpenGroup.arm40.Provisional.transaction.IArmTransactionFactory

Parameters:
errorCallback an application object implementing the IArmErrorCallback interface.
Returns:
true if registration is accepted.
The documentation for this interface was generated from the following file:
  • opengroup/arm40/provisional/tranreport/IArmTranReportFactory.cs
MyARM
Documentation generated on Thu May 24 2018 22:24:16. © 2018 by MyARM GmbH