org.jacp.api.component
Interface ICallbackComponent<L,A,M>

Type Parameters:
L - defines the action listener type
A - defines the basic action type
M - defines the basic message type
All Superinterfaces:
java.lang.Cloneable, IComponent<L,A,M>, IHandleable<A,M>, ISubComponent<L,A,M>
All Known Subinterfaces:
IStateLessCallabackComponent<L,A,M>

public interface ICallbackComponent<L,A,M>
extends ISubComponent<L,A,M>, java.lang.Cloneable

This interface defines methods for background/callback non UI components. It acts like a typical component with a handle method but the return value must not be a graphical component. This component is stateful, this means you can use private members as it is guaranteed that you allays call the same instance at runntime. The return value is send back to message caller or to component specified with handleTarget.

Author:
Andy Moncsek

Method Summary
 java.lang.String getHandleTargetAndClear()
          Returns component id which is targeted by bg component return value; the return value will be handled like an average message and will be delivered to targeted component
 void setHandleTarget(java.lang.String componentTargetId)
          Set component target id which is targeted by background component return value; the return value will be handled like an average message and will be delivered to targeted component
 
Methods inherited from interface org.jacp.api.component.ISubComponent
getExecutionTarget, getNextIncomingMessage, getParentId, hasIncomingMessage, isBlocked, putIncomingMessage, setBlocked, setExecutionTarget, setParentId
 
Methods inherited from interface org.jacp.api.component.IComponent
getActionListener, getId, getName, isActive, isStarted, setActive, setId, setMessageQueue, setName, setStarted
 
Methods inherited from interface org.jacp.api.component.IHandleable
handle
 

Method Detail

getHandleTargetAndClear

java.lang.String getHandleTargetAndClear()
Returns component id which is targeted by bg component return value; the return value will be handled like an average message and will be delivered to targeted component

Returns:
the target id

setHandleTarget

void setHandleTarget(java.lang.String componentTargetId)
Set component target id which is targeted by background component return value; the return value will be handled like an average message and will be delivered to targeted component

Parameters:
componentTargetId -