jain.protocol.ss7.tcap
Class ComponentReqEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.ComponentReqEvent
Direct Known Subclasses:
ErrorReqEvent, InvokeReqEvent, RejectReqEvent, ResultReqEvent, TimerResetReqEvent, UserCancelReqEvent

public abstract class ComponentReqEvent
extends java.util.EventObject
implements java.io.Serializable, java.lang.Cloneable

A ComponentReqEvent is the superclass of all Component request primitives, which represent TCAP Component requests sent from a JainTcapListener to a JainTcapProvider. This type of Event will be processed by the sendComponentReqEvent() method of the JainTcapProvider. This class implements the java.lang.Cloneable interface, therefore all Component Request primitves that extend this Event can be cloned using the clone() method inherited from java.lang.Object.

Version:
1.0
Author:
Colm Hayden & Phelim O'Doherty
See Also:
Serialized Form

Field Summary
protected  int dialogueId
          The Dialogue Id parameter of the request component
protected  boolean dialogueIdPresent
           
protected  int invokeId
          The Invoke Id parameter of the request component
protected  boolean invokeIdPresent
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
ComponentReqEvent(java.lang.Object source)
          Constructs a new ComponentReqEvent.
 
Method Summary
 int getDialogueId()
          Gets the Dialogue Id parameter of the request component, which is a reference identifier that is used to associate all components within a transaction.
 int getInvokeId()
          Gets the Invoke Id parameter of the request component.
abstract  int getPrimitiveType()
          This abstract method defines the 'getPrimitiveType' method that must be implemented by its subclasses in order to return the type of that subclassed Component Request primitive.
 void setDialogueId(int dialogueId)
          Sets the Dialogue Id parameter of the Component Request Event.
 void setInvokeId(int invokeId)
          Sets the Invoke Id parameter of the request component.
 void setSource(java.lang.Object source)
          Sets the source of this event.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

dialogueId

protected int dialogueId
The Dialogue Id parameter of the request component

dialogueIdPresent

protected boolean dialogueIdPresent

invokeId

protected int invokeId
The Invoke Id parameter of the request component

invokeIdPresent

protected boolean invokeIdPresent
Constructor Detail

ComponentReqEvent

public ComponentReqEvent(java.lang.Object source)
Constructs a new ComponentReqEvent.
Parameters:
source - the source of this Event.
Method Detail

setSource

public void setSource(java.lang.Object source)
Sets the source of this event. This method may be used as an alternative to setting the event source through the constructor and allows the capability to clone the Event and change the Event source at any time.
Parameters:
source - the source of this Event.

getDialogueId

public int getDialogueId()
                  throws ParameterNotSetException
Gets the Dialogue Id parameter of the request component, which is a reference identifier that is used to associate all components within a transaction.
Returns:
the Dialogue Id of the request event
Throws:
ParameterNotSetException - this exception is thrown if this Mandatory parameter has not yet been set

setDialogueId

public void setDialogueId(int dialogueId)
Sets the Dialogue Id parameter of the Component Request Event. Dialogue Id is a reference identifier which is used to associate all components within a transaction.
Parameters:
value - the Dialogue Id of the request

getInvokeId

public int getInvokeId()
                throws ParameterNotSetException
Gets the Invoke Id parameter of the request component. Invoke Id identifies an operation invocation and its result.
Returns:
the Invoke Id of the request
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setInvokeId

public void setInvokeId(int invokeId)
Sets the Invoke Id parameter of the request component. Invoke Id identifies an operation invocation and its result.
Parameters:
value - the Invoke Id of the request

getPrimitiveType

public abstract int getPrimitiveType()
This abstract method defines the 'getPrimitiveType' method that must be implemented by its subclasses in order to return the type of that subclassed Component Request primitive.


01 September 99
If you have any comments or queries, please mail them to JainTcap@Sun.Com

Copyright - 1999 Sun Microsystems