Public Member Functions

OpenGroup::arm40::Provisional::transaction::IArmInterface Interface Reference

The root of the inheritance hierarchy for almost all ARM interfaces. More...

Inheritance diagram for OpenGroup::arm40::Provisional::transaction::IArmInterface:
OpenGroup::arm40::Provisional::metric::IArmMetric OpenGroup::arm40::Provisional::metric::IArmMetricDefinition OpenGroup::arm40::Provisional::metric::IArmMetricFactory OpenGroup::arm40::Provisional::metric::IArmMetricGroup OpenGroup::arm40::Provisional::metric::IArmMetricGroupDefinition OpenGroup::arm40::Provisional::tranreport::IArmTranReport OpenGroup::arm40::Provisional::tranreport::IArmTranReportFactory OpenGroup::arm40::Provisional::transaction::IArmApplication OpenGroup::arm40::Provisional::transaction::IArmApplicationDefinition OpenGroup::arm40::Provisional::transaction::IArmBlockCause OpenGroup::arm40::Provisional::transaction::IArmIdentityProperties OpenGroup::arm40::Provisional::transaction::IArmToken OpenGroup::arm40::Provisional::transaction::IArmTransaction OpenGroup::arm40::Provisional::transaction::IArmTransactionDefinition OpenGroup::arm40::Provisional::transaction::IArmTransactionFactory OpenGroup::arm40::Provisional::transaction::IArmUser

List of all members.

Public Member Functions

int GetErrorCode ()
 returns last error code set for this object.
int SetErrorCode (int errorCode)
 sets the error code of this object.
string GetErrorMessage (int errorCode)
 returns a string describing the error for errorCode.

Detailed Description

It provides a common way to handle errors. If a method invocation on any ARM object causes an error, the error code returned by the objects GetErrorCode will be negative. If no error occurs, the error code is zero. Several methods also return the error code as an int return value. If an error occurs in a factory method (e.g., a method in IArmTransactionFactory), the error code is set in both the factory object and the newly created object. The implementation of the object has sole discretion as to whether a method results in an error.

The error code may change any time a method of the object is executed. Executing a method overrides the previous error code value. The only methods that will never change the error code are GetErrorCode() and GetErrorMessage(). If multiple threads are processing the same object simultaneously, the results are unpredictable. An error code set as a result of an operation in method X could be replaced by an operation in method Y before thread X executes GetErrorCode().

The error code can also be set with SetErrorCode This is a way for the application to reset or change the error code. It would most typically be used in a callback registered with the ARM implementation's factory objects used to create ARM objects on behalf of the application. In this way the application can implement a central error handling policy in the callback. A value set with SetErrorCode() in a callback overwrites the previous value (i.e., the value that caused the callback to be made).

For any non-zero error code returned by an object, the application can request from the same object a string message describing the error using GetErrorMessage If the object does not support the function or does not recognize the error code, it returns null.

Member Function Documentation

int OpenGroup::arm40::Provisional::transaction::IArmInterface::GetErrorCode (  ) 
Returns:
last error code set for this object as a negative value. Zero, if no error code is set.
string OpenGroup::arm40::Provisional::transaction::IArmInterface::GetErrorMessage ( int  errorCode  ) 
Parameters:
errorCode an error code retrieved from this object.
Returns:
a string describing the error for errorCode, or null.
int OpenGroup::arm40::Provisional::transaction::IArmInterface::SetErrorCode ( int  errorCode  ) 
Parameters:
errorCode the error code to be set for this object.
Returns:
the error code provided in errorCode.
The documentation for this interface was generated from the following file:
  • opengroup/arm40/provisional/transaction/IArmInterface.cs
MyARM
Documentation generated on Thu May 24 2018 22:24:16. © 2018 by MyARM GmbH