jain.protocol.ss7.tcap.component
Class InvokeReqEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.ComponentReqEvent
              |
              +--jain.protocol.ss7.tcap.component.InvokeReqEvent

public final class InvokeReqEvent
extends ComponentReqEvent

An event representing a TCAP Invoke request component primitive. The mandatory parameters of this primitive are supplied to the constructor. Optional parameters may then be set using the set methods.

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

Constructor Summary
InvokeReqEvent(java.lang.Object source, int dialogueId, Operation operation)
          Constructs a new Invoke Request Event, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.
 
Method Summary
 void clearAllParameters()
          Clears all previously set parameters .
 int getClassType()
          Returns the Component Class type.
 int getLinkId()
          Gets the link Id parameter of the INVOKE request component.
 Operation getOperation()
          Gets the Operation parameter of the INVOKE request Component.
 Parameters getParameters()
          Gets the Parameters' parameter of the INVOKE request Component.
 int getPrimitiveType()
          This method returns the type of this primitive.
 long getTimeOut()
          Gets the Timeout parameter of the INVOKE request component.
 boolean isClassTypePresent()
          Indicates if the Component Class type field is present in this Event.
 boolean isInvokeIdPresent()
          Indicates if the Invoke Id is present in this Event.
 boolean isLastInvokeEvent()
          Indicates if this is the last Invoke Event
 boolean isLinkIdPresent()
          Indicates if the link Id parameter is present in this Event.
 boolean isParametersPresent()
          Indicates if the 'Parameters' field is present in this Event.
 boolean isTimeOutPresent()
          Indicates if the Timeout field is present in this Event.
 void setClassType(int classType)
          Sets the Class Type parameter of the INVOKE request component.
 void setLastInvokeEvent(boolean lastInvokeEvent)
          Sets the lastInvoke flag of this Invoke Event
 void setLinkId(int value)
          Sets the link Id parameter of the INVOKE request component.
 void setOperation(Operation operation)
          Sets the Operation parameter of the INVOKE request Component
 void setParameters(Parameters params)
          Sets the Parameters' parameter of the INVOKE request Component.
 void setTimeOut(long value)
          Sets the Timeout parameter of the INVOKE request component.
 java.lang.String toString()
          Returns a string representation of an instance of this class.
 
Methods inherited from class jain.protocol.ss7.tcap.ComponentReqEvent
getDialogueId, getInvokeId, setDialogueId, setInvokeId, setSource
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

InvokeReqEvent

public InvokeReqEvent(java.lang.Object source,
                      int dialogueId,
                      Operation operation)
Constructs a new Invoke Request Event, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.
Method Detail

isInvokeIdPresent

public boolean isInvokeIdPresent()
Indicates if the Invoke Id is present in this Event.
Returns:
true if Invoke Id has been set.

isLastInvokeEvent

public boolean isLastInvokeEvent()
Indicates if this is the last Invoke Event
Returns:
true if this is the last Invoke Event, false otherwise.

setLastInvokeEvent

public void setLastInvokeEvent(boolean lastInvokeEvent)
Sets the lastInvoke flag of this Invoke Event

isLinkIdPresent

public boolean isLinkIdPresent()
Indicates if the link Id parameter is present in this Event.
Returns:
true if link Id has been set.

getLinkId

public int getLinkId()
              throws ParameterNotSetException
Gets the link Id parameter of the INVOKE request component. The link Id parameter links an operation invocation to a previous operation invocation by the remote TCAP application.
Returns:
the link Id of the INVOKE request
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setLinkId

public void setLinkId(int value)
Sets the link Id parameter of the INVOKE request component.
Parameters:
value - the link Id of the INVOKE request

isTimeOutPresent

public boolean isTimeOutPresent()
Indicates if the Timeout field is present in this Event.
Returns:
true if Timeout has been set.

getTimeOut

public long getTimeOut()
                throws ParameterNotSetException
Gets the Timeout parameter of the INVOKE request component. Timeout indicates the amount of time to wait for a response to an invocation.
Returns:
the timeout value in milliseconds
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setTimeOut

public void setTimeOut(long value)
Sets the Timeout parameter of the INVOKE request component.
Parameters:
value - the timeout value in milliseconds

getOperation

public Operation getOperation()
                       throws MandatoryParameterNotSetException
Gets the Operation parameter of the INVOKE request Component. .Operation identifies the action to be executed by the remote application.
Returns:
the Operation of the INVOKE request Component
Throws:
MandatoryParameterNotSetException - this exception is thrown if this JAIN Mandatory parameter has not yet been set

setOperation

public void setOperation(Operation operation)
Sets the Operation parameter of the INVOKE request Component
Parameters:
op - the Operation of the INVOKE request Component

isParametersPresent

public boolean isParametersPresent()
Indicates if the 'Parameters' field is present in this Event.
Returns:
true if 'Parameters' has been set.

getParameters

public Parameters getParameters()
                         throws ParameterNotSetException
Gets the Parameters' parameter of the INVOKE request Component. Parameters contains any parameters that accompany an operation or that are provided in reply to an operation.
Returns:
the Parameters of the INVOKE request Component
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setParameters

public void setParameters(Parameters params)
Sets the Parameters' parameter of the INVOKE request Component.
Parameters:
params - the Parameters of the INVOKE request Component.

isClassTypePresent

public boolean isClassTypePresent()
Indicates if the Component Class type field is present in this Event.
Returns:
true if Component Class type has been set.

getClassType

public int getClassType()
                 throws ParameterNotSetException
Returns the Component Class type.
Returns:
either CLASS_1, CLASS_2, CLASS_3 or CLASS_4
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setClassType

public void setClassType(int classType)
Sets the Class Type parameter of the INVOKE request component.
Parameters:
classType - the Class Type of the INVOKE request component. This may be one of CLASS_1, CLASS_2, CLASS_3 or CLASS_4

getPrimitiveType

public int getPrimitiveType()
This method returns the type of this primitive.
Overrides:
getPrimitiveType in class ComponentReqEvent

clearAllParameters

public void clearAllParameters()
Clears all previously set parameters .

toString

public java.lang.String toString()
Returns a string representation of an instance of this class.
Overrides:
toString in class java.util.EventObject


28 June 2000
If you have any comments or queries, please mail them to JainTcapApiFeedback@AePONA.Com

Copyright - 2000 Sun Microsystems