PageRenderTime 28ms CodeModel.GetById 10ms RepoModel.GetById 1ms app.codeStats 0ms

/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/CPToneGenPkg/CPToneGenRtSignal.java

http://mobicents.googlecode.com/
Java | 68 lines | 21 code | 11 blank | 36 comment | 0 complexity | 3e73d5e3e065370ffbe6c08777132704 MD5 | raw file
Possible License(s): LGPL-3.0, GPL-3.0, LGPL-2.1, GPL-2.0, CC-BY-SA-3.0, CC0-1.0, Apache-2.0, BSD-3-Clause
  1. package javax.megaco.pkg.CPToneGenPkg;
  2. import javax.megaco.pkg.MegacoPkg;
  3. import javax.megaco.pkg.PkgSignalItem;
  4. /**
  5. * The MEGACO Ringing Tone signal class extends the PkgSignalItem class. This is
  6. * a final class. This class defines Ringing Tone signal of MEGACO Call Progress
  7. * Tone Generator package. The methods shall define that this signal item
  8. * belongs to the Call Progress Tone Generator package.
  9. */
  10. public final class CPToneGenRtSignal extends PkgSignalItem {
  11. /**
  12. * Identifies Ringing tone signal of the MEGACO Call Progress Tone Generator
  13. * Package. Its value shall be set equal to 0x0031.
  14. */
  15. public static final int CP_TONE_GEN_BT_SIGNAL = 0x0031;
  16. private CPToneGenPkg itemsPkgId = new CPToneGenPkg();
  17. /**
  18. * Constructs a Jain MEGACO Object representing signal Item of the MEGACO
  19. * Package for signal Ringing Tone and Package as Call Progress Tone
  20. * Generator.
  21. */
  22. public CPToneGenRtSignal() {
  23. super();
  24. super.signalId = CP_TONE_GEN_BT_SIGNAL;
  25. super.itemId = CP_TONE_GEN_BT_SIGNAL;
  26. }
  27. /**
  28. * This method is used to get the item identifier from an Item object. The
  29. * implementations of this method in this class returns the id of the
  30. * Ringing Tone signal of Call Progress Tone Generator Package.
  31. *
  32. * @return It shall return {@link CP_TONE_GEN_BT_SIGNAL}.
  33. */
  34. public int getItemId() {
  35. return super.itemId;
  36. }
  37. /**
  38. * This method is used to get the signal identifier from an Signal Item
  39. * object. The implementations of this method in this class returns the id
  40. * of the Ringing Tone signal of Call Progress Tone Generator Package.
  41. *
  42. * @return It shall return {@link CP_TONE_GEN_BT_SIGNAL}.
  43. */
  44. public int getSignalId() {
  45. return super.signalId;
  46. }
  47. /**
  48. * This method gets the package id to which the item belongs. Since the Dial
  49. * Tone signal is defined in the Call Progress Tone Generator Package of
  50. * MEGACO protocol, this method returns the CPToneGenPkg class object.
  51. *
  52. * @return The package is CPToneGenPkg
  53. */
  54. public MegacoPkg getItemsPkgId() {
  55. return itemsPkgId;
  56. }
  57. }