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

http://mobicents.googlecode.com/ · Java · 70 lines · 21 code · 11 blank · 38 comment · 0 complexity · 0a084c4ca6d2bf900658acba7e843fca MD5 · raw file

  1. package javax.megaco.pkg.CPToneGenPkg;
  2. import javax.megaco.pkg.MegacoPkg;
  3. import javax.megaco.pkg.PkgSignalItem;
  4. /**
  5. * The MEGACO Special Information Tone signal class extends the PkgSignalItem
  6. * class. This is a final class. This class defines Special Information Tone
  7. * signal of MEGACO Call Progress Tone Generator package. The methods shall
  8. * define that this signal item belongs to the Call Progress Tone Generator
  9. * package.
  10. */
  11. public final class CPToneGenSitSignal extends PkgSignalItem {
  12. /**
  13. * Identifies Special Information tone signal of the MEGACO Call Progress
  14. * Tone Generator Package. Its value shall be set equal to 0x0034.
  15. */
  16. public static final int CPTONE_GEN_SIT_SIGNAL = 0x0034;
  17. private CPToneGenPkg itemsPkgId = new CPToneGenPkg();
  18. /**
  19. * Constructs a Jain MEGACO Object representing signal Item of the MEGACO
  20. * Package for signal Ringing Tone and Package as Call Progress Tone
  21. * Generator.
  22. */
  23. public CPToneGenSitSignal() {
  24. super();
  25. super.signalId = CPTONE_GEN_SIT_SIGNAL;
  26. super.itemId = CPTONE_GEN_SIT_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. * Special Information Tone signal of Call Progress Tone Generator Package.
  32. *
  33. * @return It shall return {@link CPTONE_GEN_SIT_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 Ringing Tone signal of Call Progress Tone Generator Package.
  42. *
  43. * @return It shall return {@link CPTONE_GEN_SIT_SIGNAL}.
  44. */
  45. public int getSignalId() {
  46. return super.signalId;
  47. }
  48. /**
  49. * This method is used to get the signal identifier from an Signal Item
  50. * object. The implementations of this method in this class returns the id
  51. * of the Special Information Tone signal of Call Progress Tone Generator
  52. * Package.
  53. *
  54. * @return The package is CPToneGenPkg
  55. */
  56. public MegacoPkg getItemsPkgId() {
  57. return itemsPkgId;
  58. }
  59. }