public class ArmTranReportFactory extends ArmFactory implements ArmTranReportFactory
setErrorCallback(ArmErrorCallback)
). For additional
details about error handling philosophy see the description
of ArmTransactionFactory
.
Semantics of the factory methods are provided in the description
of the individual methods below.
ArmTranReportFactory
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
propertyKey
constant.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
propertyKey |
m_nativeLoaded
m_errorCode, m_factory
Constructor and Description |
---|
ArmTranReportFactory() |
Modifier and Type | Method and Description |
---|---|
ArmApplicationRemote |
newArmApplicationRemote(ArmApplicationDefinition definition,
java.lang.String group,
java.lang.String instance,
java.lang.String[] contextValues,
ArmSystemAddress systemAddress)
Creates an
ArmApplicationRemote . |
ArmSystemAddress |
newArmSystemAddress(short format,
byte[] addressBytes,
ArmID id)
Creates an ArmSystemAddress from the specified format
and the input byte array.
|
ArmSystemAddress |
newArmSystemAddress(short format,
byte[] addressBytes,
int offset,
ArmID id)
Creates an ArmSystemAddress from the specified format
and the input byte array.
|
ArmSystemAddress |
newArmSystemAddress(short format,
byte[] addressBytes,
int offset,
int length,
ArmID id)
Creates an ArmSystemAddress from the specified format
and the input byte array.
|
ArmTranReport |
newArmTranReport(ArmApplication app,
ArmTransactionDefinition definition)
Creates an object that represents an instance of a transaction.
|
boolean |
setErrorCallback(ArmErrorCallback errorCallback)
Registers an error callback for objects created through this factory.
|
getErrorCode, getErrorMessage, getFactory, setErrorCode, setFactory
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getErrorCode, getErrorMessage, setErrorCode
public static final java.lang.String propertyKey
public ArmApplicationRemote newArmApplicationRemote(ArmApplicationDefinition definition, java.lang.String group, java.lang.String instance, java.lang.String[] contextValues, ArmSystemAddress systemAddress)
ArmTranReportFactory
ArmApplicationRemote
.
If systemAddress
is null
,
the addressing information for the local system is used.newArmApplicationRemote
in interface ArmTranReportFactory
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.ArmApplicationRemote
instance.ArmApplication
public ArmSystemAddress newArmSystemAddress(short format, byte[] addressBytes, ArmID id)
ArmTranReportFactory
ArmSystemAddress
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.newArmSystemAddress
in interface ArmTranReportFactory
format
- the address format.addressBytes
- a byte array containig the address data.id
- An optional 16-byte ID associated with the identity of
the ArmSystemAddress
.ArmSystemAddress
public ArmSystemAddress newArmSystemAddress(short format, byte[] addressBytes, int offset, ArmID id)
ArmTranReportFactory
ArmSystemAddress
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.newArmSystemAddress
in interface ArmTranReportFactory
format
- the address format.addressBytes
- a byte array containig the address data.offset
- start of the address bytes within the array.id
- An optional 16-byte ID associated with the identity of
the ArmSystemAddress
.ArmSystemAddress
public ArmSystemAddress newArmSystemAddress(short format, byte[] addressBytes, int offset, int length, ArmID id)
ArmTranReportFactory
ArmSystemAddress
description
for more details about the parameters. The length of the address data
is length
, if not restricted otherwise
through the format
parameter.newArmSystemAddress
in interface ArmTranReportFactory
format
- the address format.addressBytes
- a byte array containig the address data.offset
- start of the address bytes within the array.length
- the number of bytes of valid address data.id
- An optional 16-byte ID associated with the identity of
the ArmSystemAddress
.ArmSystemAddress
public ArmTranReport newArmTranReport(ArmApplication app, ArmTransactionDefinition definition)
ArmTranReportFactory
ArmTransactionDefinition
object. It is scoped by an application instance,
represented by ArmApplication
(or its subclass,
ArmApplicationRemote
).newArmTranReport
in interface ArmTranReportFactory
app
- the application instance the transaction belongs to.definition
- the metadata describing the type of the transaction.ArmTranReport
instance.public boolean setErrorCallback(ArmErrorCallback errorCallback)
ArmTranReportFactory
ArmTransactionFactory
.setErrorCallback
in interface ArmTranReportFactory
setErrorCallback
in class ArmFactory
errorCallback
- an application object implementing the
ArmErrorCallback> interface.
true
if registration is accepted.