JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

jain.protocol.ip.mgcp.message.parms
Class NotificationRequestParms

java.lang.Object
  |
  +--jain.protocol.ip.mgcp.message.parms.NotificationRequestParms
All Implemented Interfaces:
java.io.Serializable

public final class NotificationRequestParms
extends java.lang.Object
implements java.io.Serializable

Contains all the parameters that would be sent in a NotificationRequest Command Object, except for the endpoint identifier, the notified entity, and any encapsulated endpoint configuration parameters.

See Also:
Serialized Form

Constructor Summary
NotificationRequestParms(RequestIdentifier requestIdentifier)
          Constructs a new NotificationRequestParms object.

 
Method Summary
 EventName[] getDetectEvents()
          Gets the list of events that the gateway is to detect.

 DigitMap getDigitMap()
          Gets the Digit Map.

 QuarantineHandling getQuarantineHandling()
          Gets the Quarantine Handling.

 RequestedEvent[] getRequestedEvents()
          Gets the Requested Events.

 RequestIdentifier getRequestIdentifier()
          Gets the Request Identifier.

 EventName[] getSignalRequests()
          Gets the Signal Requests.

 void setDetectEvents(EventName[] detectEvents)
          Sets the list of MGCP events that the gateway is to detect.

 void setDigitMap(DigitMap digitMap)
          Sets the Digit Map.

 void setQuarantineHandling(QuarantineHandling quarantineHandling)
          Sets the Quarantine Handling.

 void setRequestedEvents(RequestedEvent[] requestedEvents)
          Sets the Requested Events.

 void setRequestIdentifier(RequestIdentifier requestIdentifier)
          Sets the Request Identifier.

 void setSignalRequests(EventName[] signalRequests)
          Sets the Signal Requests.

 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NotificationRequestParms

public NotificationRequestParms(RequestIdentifier requestIdentifier)
Constructs a new NotificationRequestParms object.

Parameters:
requestIdentifier - Used to correlate this command with the notifications it triggers.
Method Detail

getDetectEvents

public EventName[] getDetectEvents()
Gets the list of events that the gateway is to detect.

Returns:
Returns a reference to the list of events that the gateway is to detect.

getDigitMap

public DigitMap getDigitMap()
Gets the Digit Map.

Returns:
Returns a reference to the Digit Map.

getQuarantineHandling

public QuarantineHandling getQuarantineHandling()
Gets the Quarantine Handling.

Returns:
Returns a reference to the Quarantine Handling.

getRequestedEvents

public RequestedEvent[] getRequestedEvents()
Gets the Requested Events.

Returns:
Returns a reference to the Requested Events.

getRequestIdentifier

public RequestIdentifier getRequestIdentifier()
Gets the Request Identifier.

Returns:
Returns a reference to the Request Identifier.

getSignalRequests

public EventName[] getSignalRequests()
Gets the Signal Requests.

Returns:
Returns a reference to the Signal Requests.

setDetectEvents

public void setDetectEvents(EventName[] detectEvents)
Sets the list of MGCP events that the gateway is to detect.

Parameters:
detectEvents - Optional parameter. List of events that the gateway is requested to detect during the quarantine period. If set to null, the events that should be detected in the quarantine period are those that were listed in the list of events to detect most recently received by the gateway.

setDigitMap

public void setDigitMap(DigitMap digitMap)
Sets the Digit Map.

Parameters:
digitMap - Optional parameter. A String that contains a digit map according to which the gateway will accumulate digits. If set to null, the most recent previously defined digit map will be used.

setQuarantineHandling

public void setQuarantineHandling(QuarantineHandling quarantineHandling)
Sets the Quarantine Handling.

Parameters:
quarantineHandling - Optional parameter. Specifies handling of "quarantine" events; i.e., how events that were detected by the gateway before the arrival of this command and that have not yet been sent to the Call Agent, should be handled. Must be set to null, if none.

setRequestedEvents

public void setRequestedEvents(RequestedEvent[] requestedEvents)
Sets the Requested Events.

Parameters:
requestedEvents - Optional parameter. List of events that the gateway is requested to detect and report. Must be set to null, if none.

setRequestIdentifier

public void setRequestIdentifier(RequestIdentifier requestIdentifier)
Sets the Request Identifier.

Parameters:
requestIdentifier - Used to correlate this command with the notifications it triggers.

setSignalRequests

public void setSignalRequests(EventName[] signalRequests)
Sets the Signal Requests.

Parameters:
signalRequests - Optional parameter. List of signals that the gateway is asked to apply to the endpoint.

JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

Copyright © 2000 Sun Microsystems, Inc.