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

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

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

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

Specifies a Requested Action, as defined in RFC 2705.

See Also:
Serialized Form

Field Summary
static RequestedAction Accumulate
          Encapsulates the ACCUMULATE constant.
static int ACCUMULATE
          Signifies the "Accumulate" action.
static int EMBEDDED_NOTIFICATION_REQUEST
          Signifies the "Embedded Notification Request" action
static RequestedAction Ignore
          Encapsulates the IGNORE constant.
static int IGNORE
          Signifies the "Ignore" action.
static int KEEP_SIGNALS_ACTIVE
          Signifies the "Keep Signal(s) active" action.
static RequestedAction KeepSignalsActive
          Encapsulates the KEEP_SIGNALS_ACTIVE constant.
static int NOTIFY_IMMEDIATELY
          Signifies the "Notify immediately" action.
static RequestedAction NotifyImmediately
          Encapsulates the NOTIFY_IMMEDIATELY constant.
static RequestedAction Swap
          Encapsulates the SWAP constant.
static int SWAP
          Signifies the "Swap" action.
static int TREAT_ACCORDING_TO_DIGIT_MAP
          Signifies the "Treat according to digit map" action.
static RequestedAction TreatAccordingToDigitMap
          Encapsulates the TREAT_ACCORDING_TO_DIGIT_MAP constant.
 
Constructor Summary
RequestedAction(EmbeddedRequest embeddedRequest)
          Constructs a new Requested Action that contains an embedded request.
 
Method Summary
 EmbeddedRequest getEmbeddedRequest()
          Gets the embedded request.
 int getRequestedAction()
          Gets the constant that represents this requested action.
 java.lang.String toString()
          Returns a String of the form "N|A|D|S|I|K|E(<embeddedRequest>)" where <embeddedRequest> is an embedded request (see EmbeddedRequest for more information about the form the embedded request String takes.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

Accumulate

public static final RequestedAction Accumulate
Encapsulates the ACCUMULATE constant.

ACCUMULATE

public static final int ACCUMULATE
Signifies the "Accumulate" action.

EMBEDDED_NOTIFICATION_REQUEST

public static final int EMBEDDED_NOTIFICATION_REQUEST
Signifies the "Embedded Notification Request" action

Ignore

public static final RequestedAction Ignore
Encapsulates the IGNORE constant.

IGNORE

public static final int IGNORE
Signifies the "Ignore" action.

KEEP_SIGNALS_ACTIVE

public static final int KEEP_SIGNALS_ACTIVE
Signifies the "Keep Signal(s) active" action.

KeepSignalsActive

public static final RequestedAction KeepSignalsActive
Encapsulates the KEEP_SIGNALS_ACTIVE constant.

NOTIFY_IMMEDIATELY

public static final int NOTIFY_IMMEDIATELY
Signifies the "Notify immediately" action.

NotifyImmediately

public static final RequestedAction NotifyImmediately
Encapsulates the NOTIFY_IMMEDIATELY constant.

Swap

public static final RequestedAction Swap
Encapsulates the SWAP constant.

SWAP

public static final int SWAP
Signifies the "Swap" action.

TREAT_ACCORDING_TO_DIGIT_MAP

public static final int TREAT_ACCORDING_TO_DIGIT_MAP
Signifies the "Treat according to digit map" action.

TreatAccordingToDigitMap

public static final RequestedAction TreatAccordingToDigitMap
Encapsulates the TREAT_ACCORDING_TO_DIGIT_MAP constant.
Constructor Detail

RequestedAction

public RequestedAction(EmbeddedRequest embeddedRequest)
Constructs a new Requested Action that contains an embedded request.
Parameters:
embeddedRequest - The embedded request.
Method Detail

getEmbeddedRequest

public EmbeddedRequest getEmbeddedRequest()
Gets the embedded request.
Returns:
The embedded request, or null, if this requested action does not contain an embedded request.

getRequestedAction

public int getRequestedAction()
Gets the constant that represents this requested action.
Returns:
One of constants defined above that represent requested actions.

toString

public java.lang.String toString()
Returns a String of the form "N|A|D|S|I|K|E(<embeddedRequest>)" where <embeddedRequest> is an embedded request (see EmbeddedRequest for more information about the form the embedded request String takes.
Overrides:
toString in class java.lang.Object

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

Copyright © 2000 Sun Microsystems, Inc.