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

http://mobicents.googlecode.com/ · Java · 68 lines · 21 code · 11 blank · 36 comment · 0 complexity · fc3ee18d0a10729576e8e3bdaf8919fb 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 Warning Tone signal class extends the PkgSignalItem class. This is
  6. * a final class. This class defines Warning 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 CPToneGenWtSignal extends PkgSignalItem {
  11. /**
  12. * Identifies Warning tone signal of the MEGACO Call Progress Tone Generator
  13. * Package. Its value shall be set equal to 0x0035.
  14. */
  15. public static final int CPTONE_GEN_WT_SIGNAL = 0x0035;
  16. private CPToneGenPkg itemsPkgId = new CPToneGenPkg();
  17. /**
  18. * Constructs a Jain MEGACO Object representing signal Item of the MEGACO
  19. * Package for signal Warning Tone and Package as Call Progress Tone
  20. * Generator.
  21. */
  22. public CPToneGenWtSignal() {
  23. super();
  24. super.signalId = CPTONE_GEN_WT_SIGNAL;
  25. super.itemId = CPTONE_GEN_WT_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. * Warning Tone signal of Call Progress Tone Generator Package.
  31. *
  32. * @return It shall return {@link CPTONE_GEN_WT_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 Warning Tone signal of Call Progress Tone Generator Package.
  41. *
  42. * @return It shall return {@link CPTONE_GEN_WT_SIGNAL}.
  43. */
  44. public int getSignalId() {
  45. return super.signalId;
  46. }
  47. /**
  48. * This method gets the package to which the item belongs. Since the Warning
  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. }