Public Member Functions

si.ijs.acs.objectexplorer.engine.Invocation Class Reference

Inheritance diagram for si.ijs.acs.objectexplorer.engine.Invocation:
si.ijs.acs.objectexplorer.OETreeNode si.ijs.acs.objectexplorer.engine.SimpleIntrospectable si.ijs.acs.objectexplorer.engine.BACI.BACIInvocation si.ijs.acs.objectexplorer.engine.BACI.DelegateInvocation

List of all members.

Public Member Functions

 Invocation (short type, String name, RemoteCall data, RemoteResponseCallback cb, OETree tree)
synchronized void destroy ()
synchronized void requestDestroy ()
synchronized boolean isDestroyRequested ()
RemoteResponseCallback getCallback ()
RemoteCall getInvocationRequest ()
abstract boolean isControllable ()
synchronized boolean isDestroyed ()

Detailed Description

This type denotes a transient process that has been created as a side-effect of the remote call on the remote machine. Usually Invocations are created when asynchronous methods are called (ie. methods that take callback parameters, or methods that implement the publisher / subscriber pattern). Invocation is a transient tree node object. It is contained by the object that owned the operation which created the invocation. Invocations must be destroyed as a side-effect of the container destruction. If the method isControllable() returns false the GUI need not add the node to the tree and must not use this object as an Introspectable - i.e. must not query for operations, attributes, invoke operations etc.


Constructor & Destructor Documentation

si.ijs.acs.objectexplorer.engine.Invocation.Invocation ( short  type,
String  name,
RemoteCall  data,
RemoteResponseCallback  cb,
OETree  tree 
)

Constructs a new instance of invocation object.

Parameters:
type used internally by OE and engine to specify node types. Types are defined by the engine and left unchanged by OE.
name name of the invocation transient object, used by GUI display
data data determined by the engine that is stored in the invocation node, can be null at construction time if the value is provided later
cb RemoteResponseCallback object associated with this invocation. This object will deliver asynchronous responses to the GUI.
tree tree that will be the node container

Member Function Documentation

synchronized void si.ijs.acs.objectexplorer.engine.Invocation.destroy (  ) 

If the invocation is controllable, this method is called after the node representing the invocation is removed from the tree. Sets the destroyed flag to true.

Referenced by si.ijs.acs.objectexplorer.ListsHandlerBean.invocationDestroyed().

RemoteResponseCallback si.ijs.acs.objectexplorer.engine.Invocation.getCallback (  ) 

Returns a callback object associated with this invocation. Callback is the object which receives asynchronous responses for the server. GUI is responsible for instantiating callbacks and passing them to the invokeAsync() method of the Operation instance, which, in response, instantiates this invocation object.

Returns:
callback that delivers data for this invocation

Referenced by si.ijs.acs.objectexplorer.engine.BACI.DelegateInvocation.DelegateInvocation(), and si.ijs.acs.objectexplorer.engine.BACI.BACIInvocation.destroyDueToTimeout().

abstract boolean si.ijs.acs.objectexplorer.engine.Invocation.isControllable (  )  [pure virtual]

Returns true iff this invocation instance represents a remote process that is controllable through a remote object (such as a subscription or monitor object). Only if this method returns true, can invocation be used as introspectable, i.e. can have its methods queried, invoked etc. Otherwise the GUI should not interpret this invocation as a tree node and need not display it at all.

Returns:
boolean true if the remote process can be controlled through a remote object, represented by the SimpleIntrospectable interface which this invocation implements

Referenced by si.ijs.acs.objectexplorer.RemoteResponseWindow.remoteResponseWindow_Initialize().

synchronized boolean si.ijs.acs.objectexplorer.engine.Invocation.isDestroyed (  ) 
synchronized boolean si.ijs.acs.objectexplorer.engine.Invocation.isDestroyRequested (  ) 

Request destruction.

synchronized void si.ijs.acs.objectexplorer.engine.Invocation.requestDestroy (  ) 

Request destruction.


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