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

http://mobicents.googlecode.com/ · Java · 67 lines · 21 code · 11 blank · 35 comment · 0 complexity · a29963bef3024882f0e72fb3827c0f90 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 Busy Tone event class extends the PkgEventItem class. This is a
  6. * final class. This class defines Busy Tone event of MEGACO Call Progress Tone
  7. * Detect package. The methods shall define that this event item belongs to the
  8. * Call Progress Tone Detect package.
  9. */
  10. public final class CPToneDetBtEvt extends PkgEventItem {
  11. /**
  12. * Identifies Busy tone event of the MEGACO Call Progress Tone Detect
  13. * Package. Its value shall be set equal to 0x0032.
  14. */
  15. public static final int CP_TONE_DET_BT_EVENT = 0x0032;
  16. private CPToneDetPkg itemsPackageId = new CPToneDetPkg();
  17. /**
  18. * Constructs a Jain MEGACO Object representing event Item of the MEGACO
  19. * Package for event Busy Tone and Package as Call Progress Tone Detect.
  20. */
  21. public CPToneDetBtEvt() {
  22. super();
  23. super.itemId = CP_TONE_DET_BT_EVENT;
  24. super.eventId = CP_TONE_DET_BT_EVENT;
  25. }
  26. /**
  27. * This method is used to get the event identifier from an Event Item
  28. * object. The implementations of this method in this class returns the id
  29. * of the Busy Tone event of Call Progress Tone Detect Package.
  30. *
  31. * @return It shall return {@link CP_TONE_DET_BT_EVENT}.
  32. */
  33. public int getEventId() {
  34. return super.eventId;
  35. }
  36. /**
  37. * This method is used to get the item identifier from an Item object. The
  38. * implementations of this method in this class returns the id of the Busy
  39. * Tone event of Call Progress Tone Detect Package.
  40. *
  41. * @return It shall return {@link CP_TONE_DET_BT_EVENT}.
  42. */
  43. public int getItemId() {
  44. return super.itemId;
  45. }
  46. /**
  47. * This method gets the package id to which the item belongs. Since the Busy
  48. * Tone event is defined in the Cal Progress Tone Detect Package of MEGACO
  49. * protocol, this method returns the CPToneDetPkg class object.
  50. *
  51. * @return
  52. */
  53. public MegacoPkg getItemsPackageId() {
  54. return itemsPackageId;
  55. }
  56. }