jain.protocol.ss7.tcap.component
Class ResultIndEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--jain.protocol.ss7.tcap.ComponentIndEvent
              |
              +--jain.protocol.ss7.tcap.component.ResultIndEvent

public final class ResultIndEvent
extends ComponentIndEvent

An event representing a TCAP Result indication 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
ResultIndEvent(java.lang.Object source, int dialogueId, boolean lastComponent, boolean lastResultEvent)
          Constructs a new Result indication 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 getDialogueId()
          Gets the Dialogue Id parameter of this Result Indication, which is a reference identifier that is used to associate all components within a transaction.
 int getInvokeId()
          Gets the Invoke Id parameter of this result indication.
 int getLinkId()
          Gets the link Id parameter of the RESULT indication component.
 Operation getOperation()
          Gets the Operation parameter of the RESULT indication Component.
 Parameters getParameters()
          Gets the Parameters' parameter of the RESULT indication Component.
 int getPrimitiveType()
          This method returns the type of this primitive.
 boolean isLastResultEvent()
          Indicates if the Last Result Component Event.
 boolean isLinkIdPresent()
          Indicates if the link Id parameter is present in this Event.
 boolean isOperationPresent()
          Indicates if the Operation field is present in this Event.
 boolean isParametersPresent()
          Indicates if the 'Parameters' field is present in this Event.
 void setLastResultEvent(boolean lastResultEvent)
          Sets the lastResult flag of the RESULT request component.
 void setLinkId(int linkId)
          Sets the link Id parameter of the RESULT indication component.
 void setOperation(Operation operation)
          Sets the Operation parameter of the RESULT indication Component
 void setParameters(Parameters params)
          Sets the Parameters' parameter of the RESULT indication Component.
 java.lang.String toString()
           
 
Methods inherited from class jain.protocol.ss7.tcap.ComponentIndEvent
isInvokeIdPresent, isLastComponent, setDialogueId, setInvokeId, setLastComponent, 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

ResultIndEvent

public ResultIndEvent(java.lang.Object source,
                      int dialogueId,
                      boolean lastComponent,
                      boolean lastResultEvent)
Constructs a new Result indication Event, with only the Event Source and the JAIN TCAP Mandatory parameters being supplied to the constructor.
Method Detail

getDialogueId

public int getDialogueId()
                  throws MandatoryParameterNotSetException
Gets the Dialogue Id parameter of this Result Indication, which is a reference identifier that is used to associate all components within a transaction.
Returns:
the Dialogue Id of this Result indication
Throws:
MandatoryParameterNotSetException - if this JAIN Mandatory parameter has not been set.
Overrides:
getDialogueId in class ComponentIndEvent

getInvokeId

public int getInvokeId()
                throws ParameterNotSetException
Gets the Invoke Id parameter of this result indication. Invoke Id identifies the an operation invocation and its result.
Returns:
the Invoke Id of the result indication event
Throws:
ParameterNotSetException - this exception is thrown if this is a JAIN Optional parameter has not been set
Overrides:
getInvokeId in class ComponentIndEvent

isLastResultEvent

public boolean isLastResultEvent()
Indicates if the Last Result Component Event.
Returns:
true if this is the Last Result Component.

setLastResultEvent

public void setLastResultEvent(boolean lastResultEvent)
Sets the lastResult flag of the RESULT request component.

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 RESULT indication 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 RESULT indication
Throws:
ParameterNotSetException - this exception is thrown if this parameter has not yet been set

setLinkId

public void setLinkId(int linkId)
Sets the link Id parameter of the RESULT indication component.
Parameters:
value - the link Id of the RESULT indication

isOperationPresent

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

getOperation

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

setOperation

public void setOperation(Operation operation)
Sets the Operation parameter of the RESULT indication Component
Parameters:
op - the Operation of the RESULT indication 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 RESULT indication Component. Parameters contains any parameters that accompany an operation or that are provided in reply to an operation.
Returns:
the Parameters of the RESULT indication 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 RESULT indication Component.
Parameters:
params - the Parameters of the RESULT indication Component.

getPrimitiveType

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

clearAllParameters

public void clearAllParameters()
Clears all previously set parameters .

toString

public java.lang.String toString()
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