/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/GenericPkg/GenSigComplEvent.java

http://mobicents.googlecode.com/ · Java · 67 lines · 21 code · 10 blank · 36 comment · 0 complexity · f08e3735234fcba8acae7c7c647863f9 MD5 · raw file

  1. package javax.megaco.pkg.GenericPkg;
  2. import javax.megaco.pkg.MegacoPkg;
  3. import javax.megaco.pkg.PkgEventItem;
  4. /**
  5. * The MEGACO Signal Completion Event class extends the PkgEventItem class. This
  6. * is a final class. This class defines Signal Completion Event of MEGACO
  7. * Generic package. The methods shall define that this event item belongs to the
  8. * Generic package.
  9. *
  10. */
  11. public class GenSigComplEvent extends PkgEventItem {
  12. /**
  13. * Identifies Signal completion event of the MEGACO Generic Package. Its
  14. * value shall be set equal to 0x0002.
  15. */
  16. public static final int GEN_SIG_COMPL_EVENT = 0x0002;
  17. /**
  18. * Constructs a Jain MEGACO Object representing Event Item of the MEGACO
  19. * Package for Signal Completion and Package as Generic.
  20. */
  21. public GenSigComplEvent() {
  22. super();
  23. super.packageId = new GenericPkg();
  24. super.itemId = GEN_SIG_COMPL_EVENT;
  25. super.eventId = GEN_SIG_COMPL_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 Signal Completion event of Generic Package.
  31. *
  32. * @return It shall return {@link GEN_SIG_COMPL_EVENT}.
  33. */
  34. public final int getEventId() {
  35. return super.eventId;
  36. }
  37. /**
  38. * This method is used to get the item identifier from an Item object. The
  39. * implementations of this method in this class returns the id of the Signal
  40. * Completion event of Generic Package.
  41. *
  42. * @return It shall return {@link GEN_SIG_COMPL_EVENT}.
  43. */
  44. public final int getItemId() {
  45. return super.itemId;
  46. }
  47. /**
  48. * This method gets the package to which the item belongs. Since the Signal
  49. * Completion event is defined in the Generic Package of MEGACO protocol,
  50. * this method returns the GenericPkg class object.
  51. *
  52. * @return The package is {@link GenericPkg}.
  53. */
  54. public MegacoPkg getItemsPkgId() {
  55. return super.packageId;
  56. }
  57. }