/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/CPToneDetPkg/CPToneDetPtEvt.java

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

  1. package javax.megaco.pkg.CPToneDetPkg;
  2. import javax.megaco.pkg.MegacoPkg;
  3. import javax.megaco.pkg.PkgEventItem;
  4. /**
  5. * The MEGACO Payphone Recognition Tone event class extends the PkgEventItem
  6. * class. This is a final class. This class defines Payphone Recognition Tone
  7. * event of MEGACO Call Progress Tone Detect package. The methods shall define
  8. * that this event item belongs to the Call Progress Tone Detect package.
  9. */
  10. public final class CPToneDetPtEvt extends PkgEventItem {
  11. /**
  12. * Identifies Play tone event of the MEGACO Call Progress Tone Detect
  13. * Package. Its value shall be set equal to 0x0036.
  14. */
  15. public static final int CP_TONE_DET_PT_EVENT = 0x0036;
  16. private CPToneDetPkg itemsPackageId = new CPToneDetPkg();
  17. /**
  18. * Constructs a Jain MEGACO Object representing event Item of the MEGACO
  19. * Package for event Payphone Recognition Tone and Package as Call Progress
  20. * Tone Detect.
  21. */
  22. public CPToneDetPtEvt() {
  23. super();
  24. super.itemId = CP_TONE_DET_PT_EVENT;
  25. super.eventId = CP_TONE_DET_PT_EVENT;
  26. }
  27. /**
  28. * This method is used to get the event identifier from an Event Item
  29. * object. The implementations of this method in this class returns the id
  30. * of the Payphone Recognition Tone event of Call Progress Tone Detect
  31. * Package.
  32. *
  33. * @return It shall return {@link CP_TONE_DET_PT_EVENT}.
  34. */
  35. public int getEventId() {
  36. return super.eventId;
  37. }
  38. /**
  39. * This method is used to get the item identifier from an Item object. The
  40. * implementations of this method in this class returns the id of the
  41. * Payphone Recognition Tone event of Call Progress Tone Detect Package.
  42. *
  43. * @return It shall return {@link CP_TONE_DET_PT_EVENT}.
  44. */
  45. public int getItemId() {
  46. return super.itemId;
  47. }
  48. /**
  49. * This method gets the package id to which the item belongs. Since the
  50. * Payphone Recognition Tone event is defined in the Call Progress Tone
  51. * Detect Package of MEGACO protocol, this method returns the CPToneDetPkg
  52. * class object.
  53. *
  54. * @return
  55. */
  56. public MegacoPkg getItemsPackageId() {
  57. return itemsPackageId;
  58. }
  59. }