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

http://mobicents.googlecode.com/ · Java · 70 lines · 22 code · 11 blank · 37 comment · 0 complexity · e8ddae14ae59c11f45168a52332ede08 MD5 · raw file

  1. package javax.megaco.pkg.CPToneGenPkg;
  2. import javax.megaco.pkg.MegacoPkg;
  3. import javax.megaco.pkg.PkgSignalItem;
  4. import javax.megaco.pkg.DTMFGenPkg.DTMFGenPkg;
  5. /**
  6. * The MEGACO Congestion Tone signal class extends the PkgSignalItem class. This
  7. * is a final class. This class defines Congestion Tone signal of MEGACO Call
  8. * Progress Tone Generator package. The methods shall define that this signal
  9. * item belongs to the Call Progress Tone Generator package.
  10. */
  11. public final class CPToneGenCtSignal extends PkgSignalItem {
  12. /**
  13. * Identifies Congestion tone signal of the MEGACO Call Progress Tone
  14. * Generator Package. Its value shall be set equal to 0x0033.
  15. */
  16. public static final int CP_TONE_GEN_CT_SIGNAL = 0x0033;
  17. private CPToneGenPkg itemsPkgId = new CPToneGenPkg();
  18. /**
  19. * This method is used to get the signal identifier from an Signal Item
  20. * object. The implementations of this method in this class returns the id
  21. * of the Congestion Tone signal of Call Progress Tone Generator Package.
  22. */
  23. public CPToneGenCtSignal() {
  24. super();
  25. super.signalId = CP_TONE_GEN_CT_SIGNAL;
  26. super.itemId = CP_TONE_GEN_CT_SIGNAL;
  27. }
  28. /**
  29. * This method is used to get the item identifier from an Item object. The
  30. * implementations of this method in this class returns the id of the
  31. * Congestion Tone signal of Call Progress Tone Generator Package.
  32. *
  33. * @return It shall return {@link CP_TONE_GEN_CT_SIGNAL}.
  34. */
  35. public int getItemId() {
  36. return super.itemId;
  37. }
  38. /**
  39. * This method is used to get the signal identifier from an Signal Item
  40. * object. The implementations of this method in this class returns the id
  41. * of the Congestion Tone signal of Call Progress Tone Generator Package.
  42. *
  43. * @return It shall return {@link CP_TONE_GEN_CT_SIGNAL}.
  44. */
  45. public int getSignalId() {
  46. return super.signalId;
  47. }
  48. /**
  49. * This method gets the package id to which the item belongs. Since the
  50. * Congestion Tone signal is defined in the Call Progress Tone Generator
  51. * Package of MEGACO protocol, this method returns the CPToneGenPkg class
  52. * object.
  53. *
  54. * @return The package is CPToneGenPkg
  55. */
  56. public MegacoPkg getItemsPkgId() {
  57. return itemsPkgId;
  58. }
  59. }