/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/BaseRootPkg/RootProvRespTimePrpt.java

http://mobicents.googlecode.com/ · Java · 95 lines · 32 code · 13 blank · 50 comment · 0 complexity · b4d8bdcfd95fa65f35d70146e01aeba9 MD5 · raw file

  1. package javax.megaco.pkg.BaseRootPkg;
  2. import javax.megaco.message.DescriptorType;
  3. import javax.megaco.pkg.MegacoPkg;
  4. import javax.megaco.pkg.ParamValueType;
  5. import javax.megaco.pkg.PkgPrptyItem;
  6. /**
  7. * The MEGACO ProvisionalResponseTimer property class extends the PkgPrptyItem
  8. * class. This is a final class. This class defines ProvisionalResponseTimer
  9. * property of MEGACO Root package. The methods shall define that this property
  10. * item belongs to the Root package.
  11. */
  12. public final class RootProvRespTimePrpt extends PkgPrptyItem {
  13. /**
  14. *Identifies Provisional response timer property of the MEGACO Base Root
  15. * Package. Its value shall be set equal to 0x0005.
  16. */
  17. public static final int ROOT_PROV_RESP_TIME_PRPT = 0x0005;
  18. protected int[] itemsDescriptorIds = null;
  19. /**
  20. * Constructs a Jain MEGACO Object representing property item of the MEGACO
  21. * Package for property ProvisionalResponseTimer and Package as Base Root.
  22. */
  23. public RootProvRespTimePrpt() {
  24. super();
  25. super.propertyId = ROOT_PROV_RESP_TIME_PRPT;
  26. super.itemId = ROOT_PROV_RESP_TIME_PRPT;
  27. super.packageId = new BaseRootPkg();
  28. super.itemValueType = ParamValueType.M_INTEGER;
  29. this.itemsDescriptorIds = new int[] { DescriptorType.M_TERMINATION_STATE_DESC };
  30. }
  31. /**
  32. * This method is used to get the item identifier from an Item object. The
  33. * implementations of this method in this class returns the id of the
  34. * Provisional Response Time property of ROOT Package.
  35. *
  36. * @return It shall return {@link ROOT_PROV_RESP_TIME_PRPT}
  37. */
  38. public int getItemId() {
  39. return super.itemId;
  40. }
  41. /**
  42. * The method can be used to get the type of the value as defined in the
  43. * MEGACO packages. These could be one of string or enumerated value or
  44. * integer or double value or boolean.
  45. *
  46. * @return It returns {@link ParamValueType.INTEGER}
  47. * indicating that the parameter is a double.
  48. */
  49. public int getItemValueType() {
  50. return super.itemValueType;
  51. }
  52. /**
  53. * This method is used to get the property identifier from an Property Item
  54. * object. The implementations of this method in this class returns the id
  55. * of the Provisional Response Time property of ROOT Package.
  56. *
  57. * @return It shall return {@link ROOT_PROV_RESP_TIME_PRPT}
  58. */
  59. public int getPropertyId() {
  60. return super.propertyId;
  61. }
  62. /**
  63. * This method gets the package id to which the item belongs. Since the
  64. * Provisional Response Time property is defined in the Base ROOT Package of
  65. * MEGACO protocol, this method returns the value {@link BASE_ROOT_PACKAGE}
  66. * constant. This constant is defined in the PkgConsts class.
  67. */
  68. public MegacoPkg getItemsPkgId() {
  69. return this.packageId;
  70. }
  71. /**
  72. * The method can be used to get the descriptor ids corresponding to the
  73. * parameters to which the parameter can be set.
  74. *
  75. * @return This parameter can be present in Event descriptor. It shall thus
  76. * return a value DescriptorType.M_TERMINATION_STATE_DESC as a part
  77. * of integer vector.
  78. */
  79. public int[] getDescriptorIds() {
  80. return this.itemsDescriptorIds;
  81. }
  82. }