/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/message/descriptor/AuditValDescriptor.java

http://mobicents.googlecode.com/ · Java · 230 lines · 82 code · 29 blank · 119 comment · 0 complexity · 654faf1b21df6eb948effc0c2f46b43d MD5 · raw file

  1. package javax.megaco.message.descriptor;
  2. import java.io.Serializable;
  3. import javax.megaco.message.Descriptor;
  4. import javax.megaco.message.DescriptorType;
  5. /**
  6. * The class extends JAIN MEGACO Descriptor. This class describes the audit
  7. * value request descriptor. It specifies the tokens for which audit value is
  8. * required.
  9. */
  10. public class AuditValDescriptor extends Descriptor implements Serializable {
  11. private boolean obsEventToken;
  12. private boolean eventsToken;
  13. private boolean statsToken;
  14. private boolean eventBuffToken;
  15. private boolean signalToken;
  16. private boolean mediaToken;
  17. private boolean modemTokenPresent;
  18. private boolean muxToken;
  19. private boolean digitMapToken;
  20. private boolean packagesToken;
  21. /**
  22. * Constructs a Audit Value request Descriptor. It specifies the tokens for
  23. * which the audit value is required.
  24. */
  25. public AuditValDescriptor() {
  26. super.descriptorId = DescriptorType.M_AUDIT_VAL_DESC;
  27. }
  28. /**
  29. * This method cannot be overridden by the derived class. This method
  30. * returns that the descriptor identifier is of type audit value request
  31. * descriptor. This method overrides the corresponding method of the base
  32. * class Descriptor.
  33. *
  34. * @return Returns an integer value that identifies this object of the type
  35. * of audit value request descriptor. It returns the value
  36. * M_AUDIT_VAL_DESC of a audit value descriptor.
  37. */
  38. public int getDescriptorId() {
  39. return super.descriptorId;
  40. }
  41. /**
  42. * This method cannot be overridden by the derived class. This method
  43. * indicates if the mux token is present or not.
  44. *
  45. * @return Returns TRUE if the Mux token is present.
  46. */
  47. public final boolean isMuxTokenPresent() {
  48. return this.muxToken;
  49. }
  50. /**
  51. * This method cannot be overridden by the derived class. This method sets a
  52. * flag to indicate that the mux token is present.
  53. */
  54. public final void setMuxToken() {
  55. this.muxToken = true;
  56. }
  57. /**
  58. * This method cannot be overridden by the derived class. This method
  59. * indicates if the Modem token is present or not.
  60. *
  61. * @return Returns TRUE if the Modem token is present.
  62. */
  63. public final boolean isModemTokenPresent() {
  64. return this.modemTokenPresent;
  65. }
  66. /**
  67. * This method cannot be overridden by the derived class. This method sets a
  68. * flag to indicate that the Modem token is present.
  69. */
  70. public final void setModemToken() {
  71. this.modemTokenPresent = true;
  72. }
  73. /**
  74. * This method cannot be overridden by the derived class. This method
  75. * indicates if the Media token is present or not.
  76. *
  77. * @return Returns TRUE if the Media token is present.
  78. */
  79. public final boolean isMediaTokenPresent() {
  80. return this.mediaToken;
  81. }
  82. /**
  83. * This method cannot be overridden by the derived class. This method sets a
  84. * flag to indicate that the Media token is present.
  85. */
  86. public final void setMediaToken() {
  87. this.mediaToken = true;
  88. }
  89. /**
  90. * This method cannot be overridden by the derived class. This method
  91. * indicates if the Signal token is present or not.
  92. *
  93. * @return Returns TRUE if the Signal token is present.
  94. */
  95. public final boolean isSignalTokenPresent() {
  96. return this.signalToken;
  97. }
  98. /**
  99. * This method cannot be overridden by the derived class. This method sets a
  100. * flag to indicate that the Signal token is present.
  101. */
  102. public final void setSignalToken() {
  103. this.signalToken = true;
  104. }
  105. /**
  106. * This method cannot be overridden by the derived class. This method
  107. * indicates if the Event Buffer token is present or not.
  108. *
  109. * @return Returns TRUE if the Event Buffer token is present.
  110. */
  111. public final boolean isEventBuffTokenPresent() {
  112. return this.eventBuffToken;
  113. }
  114. /**
  115. * This method cannot be overridden by the derived class. This method sets a
  116. * flag to indicate that the Event Buffer token is present.
  117. */
  118. public final void setEventBuffToken() {
  119. this.eventBuffToken = true;
  120. }
  121. /**
  122. * This method cannot be overridden by the derived class. This method
  123. * indicates if the digit map token is present or not.
  124. *
  125. * @returnReturns TRUE if the digit map token is present.
  126. */
  127. public final boolean isDigitMapTokenPresent() {
  128. return this.digitMapToken;
  129. }
  130. /**
  131. * This method cannot be overridden by the derived class. This method sets a
  132. * flag to indicate that the digit map token is present.
  133. */
  134. public final void setDigitMapToken() {
  135. this.digitMapToken = true;
  136. }
  137. /**
  138. * This method cannot be overridden by the derived class. This method
  139. * indicates if the Statistics token is present or not.
  140. *
  141. * @return Returns TRUE if the Statistics token is present.
  142. */
  143. public final boolean isStatsTokenPresent() {
  144. return this.statsToken;
  145. }
  146. /**
  147. * This method cannot be overridden by the derived class. This method sets a
  148. * flag to indicate that the Statistics token is present.
  149. */
  150. public final void setStatsToken() {
  151. this.statsToken = true;
  152. }
  153. /**
  154. * This method cannot be overridden by the derived class. This method
  155. * indicates if the Events token is present or not.
  156. *
  157. * @return Returns TRUE if the Events token is present.
  158. */
  159. public final boolean isEventsTokenPresent() {
  160. return this.eventsToken;
  161. }
  162. /**
  163. * This method cannot be overridden by the derived class. This method sets a
  164. * flag to indicate that the Events token is present.
  165. */
  166. public final void setEventsToken() {
  167. this.eventsToken = true;
  168. }
  169. /**
  170. * This method cannot be overridden by the derived class. This method
  171. * indicates if the Observed Event token is present or not.
  172. *
  173. * @return Returns TRUE if the Observed Event token is present.
  174. */
  175. public final boolean isObsEventTokenPresent() {
  176. return this.obsEventToken;
  177. }
  178. /**
  179. * This method cannot be overridden by the derived class. This method sets a
  180. * flag to indicate that the Observed Event token is present.
  181. */
  182. public final void setObsEventToken() {
  183. this.obsEventToken = true;
  184. }
  185. /**
  186. * This method cannot be overridden by the derived class. This method
  187. * indicates if the Packages token is present or not.
  188. *
  189. * @return Returns TRUE if the Packages token is present.
  190. */
  191. public final boolean isPackagesTokenPresent() {
  192. return this.packagesToken;
  193. }
  194. /**
  195. * This method cannot be overridden by the derived class. This method sets a
  196. * flag to indicate that the Packages token is present.
  197. */
  198. public final void setPackagesToken() {
  199. this.packagesToken = true;
  200. }
  201. }