/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/ContinuityPkg/ContRspSignal.java

http://mobicents.googlecode.com/ · Java · 64 lines · 21 code · 10 blank · 33 comment · 0 complexity · 03f0fa326413f8d9736074e19fcd4824 MD5 · raw file

  1. package javax.megaco.pkg.ContinuityPkg;
  2. import javax.megaco.pkg.MegacoPkg;
  3. import javax.megaco.pkg.PkgSignalItem;
  4. /**
  5. * The MEGACO Respond signal class extends the PkgSignalItem class. This is a
  6. * final class. This class defines Respond signal of MEGACO Continuity package.
  7. * The methods shall define that this signal item belongs to the Continuity
  8. * package.
  9. */
  10. public final class ContRspSignal extends PkgSignalItem {
  11. /**
  12. * Identifies Continuity Test Respond signal of the MEGACO Continuity
  13. * Package. Its value shall be set equal to 0x0004.
  14. */
  15. public static final int CONT_RSP_SIGNAL = 0x0004;
  16. protected int signalId = CONT_RSP_SIGNAL;
  17. /**
  18. * Constructs a Jain MEGACO Object representing signal item of the MEGACO
  19. * Package for signal Respond and Package as Continuity.
  20. */
  21. public ContRspSignal() {
  22. super();
  23. super.itemId = CONT_RSP_SIGNAL;
  24. super.packageId = new ContinuityPkg();
  25. }
  26. /**
  27. * This method is used to get the item identifier from an Item object. The
  28. * implementations of this method in this class returns the id of the
  29. * Respond signal of Continuity Package.
  30. */
  31. public int getItemId() {
  32. return CONT_RSP_SIGNAL;
  33. }
  34. /**
  35. * This method is used to get the signal identifier from an Signal Item
  36. * object. The implementations of this method in this class returns the id
  37. * of the Respond signal of Continuity Package.
  38. *
  39. * @return It shall return {@link CONT_RSP_SIGNAL}.
  40. */
  41. public int getSignalId() {
  42. return signalId;
  43. }
  44. /**
  45. * This method gets the package id to which the item belongs. Since the
  46. * Respond signal is defined in the Continuity Package of MEGACO protocol,
  47. * this method returns the value ContinuityPkg class object.
  48. *
  49. * @return The package is {@link ContinuityPkg}
  50. */
  51. public MegacoPkg getItemsPkgId() {
  52. return super.packageId;
  53. }
  54. }