org.opengroup.arm40.transaction
Interface ArmApplication

All Superinterfaces:
ArmInterface
All Known Subinterfaces:
ArmApplicationRemote
All Known Implementing Classes:
ArmApplication, ArmApplicationRemote

public interface ArmApplication
extends ArmInterface

Represents an instance of an executing application. It provides an anchor point for associating ArmTransaction objects with the application instance. It has the following attributes, all of which are immutable:

end() indicates that the application instance has halted. After end() executes, the application instance may not call any other method of the ArmApplication object, it may not use any reference to the ArmApplication object, nor may it call any method of any object created using a reference to the ArmApplication object (e.g., creating an instance of ArmTransaction using the newArmTransaction() method of ArmTransactionFactory). Any transactions that are currently in-process [start() executed but stop() not executed] will be discarded by implicitly executing the ArmTransaction reset() method. The ARM implementation should protect itself against a poorly behaved application that does not respect the specification.

Objects implementing this interface are created using ArmTransactionFactory.newArmApplication(org.opengroup.arm40.transaction.ArmApplicationDefinition, java.lang.String, java.lang.String, java.lang.String[]).

Author:
ARM Working Group of The Open Group

Method Summary
 int end()
          indicates that the application instance has halted.
 java.lang.String getContextValue(int index)
          retrieves a context property value.
 ArmApplicationDefinition getDefinition()
           
 java.lang.String getGroup()
           
 java.lang.String getInstance()
           
 
Methods inherited from interface org.opengroup.arm40.transaction.ArmInterface
getErrorCode, getErrorMessage, setErrorCode
 

Method Detail

end

int end()
indicates that the application instance has halted. See comments in the interface description above.

Returns:
0 on sucess; otherwise, a non-zero error code is returned (as specified in ArmInterface).

getContextValue

java.lang.String getContextValue(int index)
retrieves a context property value.

Parameters:
index - the index into the context properties array.
Returns:
The context value at the specified index, or null. See comments in the interface description above.

getDefinition

ArmApplicationDefinition getDefinition()
Returns:
the metadata describing this application.

getGroup

java.lang.String getGroup()
Returns:
the group name this application is associated with, or null. See comments in the interface description above.

getInstance

java.lang.String getInstance()
Returns:
the instance name attributed to this application, or null. See comments in the interface description above.