Public Member Functions | Package Functions

si.ijs.acs.objectexplorer.engine.RemoteCall Interface Reference

Inheritance diagram for si.ijs.acs.objectexplorer.engine.RemoteCall:
si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall

List of all members.

Public Member Functions

java.lang.Object[] getAuxReturnValues ()
SimpleIntrospectable getIntrospectable ()
Operation getOperation ()
Object[] getParameters ()
int getSN ()
Object getSyncReturnValue ()
Throwable getThrowable ()
boolean isAttributeAccess ()
boolean isTimeout ()
boolean isErrorResponse ()

Package Functions

Attribute getAttribute ()

Detailed Description

RemoteCall interface defines the data structure that packs the data about a single invocation of an Operation instance. If the invocation was synchronous and therefore produced no Invocation instances, a single remote call instance will fully describe and parametrize the remote call. If the remote call was asynchronous and therefore produced an Invocation instance, the remote call itself will be parametrized by an instance of this object, while the asynchronous responses (monitors, alarms, events etc.) will be described by instances of RemoteResponse class. An instance of this interface contains all information to fully log the call. Instances of this interface can describe either ordinary Operation invocations or also Attribute access - ie. calls to mutators and accessors. The type of the data structure is determined by the return value of the isAttributeAccess() method.


Member Function Documentation

Attribute si.ijs.acs.objectexplorer.engine.RemoteCall.getAttribute (  )  [package]

If isAttributeAccess() returns true, this method will return the reference to the attribute object on which either accessor or mutator was invoked. Otherwise the method will return null.

Returns:
attribute instance on which the operation was invoked

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.ReporterBean.toString().

java.lang.Object [] si.ijs.acs.objectexplorer.engine.RemoteCall.getAuxReturnValues (  ) 

In addition to the declared return value that each operation can provide, an operation may also transfer data as parameters to the operation which really count as return values. Examples are CORBA OUT parameters. Syntactically these are parameters, but in fact they are only placeholders where the called remote function may place the results. This method returns an array of objects equal in length to the arrays describing parameters returned by the Operation instances: for each parameter, there is an entry in the array. For type IN parameters, the fields are null. For other types of parameters (auxilliary return values) the array contains the additional return values produced by the remote call.

Returns:
java.lang.Object[]

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.ReporterBean.toString().

SimpleIntrospectable si.ijs.acs.objectexplorer.engine.RemoteCall.getIntrospectable (  ) 

Returns the simple introspectable instance on which the call was made.

Returns:
introspectable instance (declared simple because remote calls may be made on transient objects)

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.engine.BACI.BACIInvocation.getName(), and si.ijs.acs.objectexplorer.ReporterBean.toString().

Operation si.ijs.acs.objectexplorer.engine.RemoteCall.getOperation (  ) 

Returns the operation that parametrizes the reflective information about the remote call.

Returns:
operation instance

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.engine.BACI.BACIIntrospector.extractInvocationObject(), and si.ijs.acs.objectexplorer.ReporterBean.toString().

Object [] si.ijs.acs.objectexplorer.engine.RemoteCall.getParameters (  ) 

This method returns an array of objects representing the parameters passed to the remote method. Note: the method returns explicit parameters, ie. parameters that were entered by the user before they were processed by the engine.

Returns:
an array of objects that GUI sent to the engine as parameters to the remote call

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

int si.ijs.acs.objectexplorer.engine.RemoteCall.getSN (  ) 

Returns the sequence number of the remote call. Enigne is responsible for generation of unique sequences of numbers that tag each call. The SNs can be used for logging to link remote calls and the remote response objects.

Returns:
sequence number

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.engine.BACI.BACIIntrospector.extractInvocationObject(), si.ijs.acs.objectexplorer.ReporterBean.invocationDestroyed(), si.ijs.acs.objectexplorer.RemoteResponseWindow.RemoteResponseWindow(), si.ijs.acs.objectexplorer.ReporterBean.reportRemoteResponse(), and si.ijs.acs.objectexplorer.ReporterBean.toString().

Object si.ijs.acs.objectexplorer.engine.RemoteCall.getSyncReturnValue (  ) 

Returns the return value that the remote call produced. This is null if the remote call either returned null, or the call was interrupted by either a timeout or an exception being thrown.

Returns:
return value of the remote call

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.engine.BACI.BACIIntrospector.extractInvocationObject(), and si.ijs.acs.objectexplorer.ReporterBean.toString().

Throwable si.ijs.acs.objectexplorer.engine.RemoteCall.getThrowable (  ) 

If the remote call or the invocation process generated an exception, this method will return it. Otherwise this method will return null.

Returns:
exception thrown during the invocation process

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.ReporterBean.toString().

boolean si.ijs.acs.objectexplorer.engine.RemoteCall.isAttributeAccess (  ) 

Returns true iff this remote call represents attribute access, ie. the invocation of either accessor or mutator on the remote attribute.

Returns:
true if either mutator or accessor methods are parametrized by this call

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.ReporterBean.toString().

boolean si.ijs.acs.objectexplorer.engine.RemoteCall.isErrorResponse (  ) 

Returns true if, during the invocation of this method, the engine determined that the remote object responded with error completion.

Returns:
true if the method invocation was completed with error

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.RemoteResponseWindow.invokeOperation(), and si.ijs.acs.objectexplorer.ReporterBean.reportRemoteCall().

boolean si.ijs.acs.objectexplorer.engine.RemoteCall.isTimeout (  ) 

Returns true if, during the invocation of this method, the engine determined that the remote object did not respond within the timeout period. Timeout is defined by the engine.

Returns:
true if the method invocation was interrupted by the engine because of the detected timeout condition

Implemented in si.ijs.acs.objectexplorer.engine.BACI.BACIRemoteCall.

Referenced by si.ijs.acs.objectexplorer.ReporterBean.toString().


The documentation for this interface was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties