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

http://mobicents.googlecode.com/ · Java · 191 lines · 68 code · 24 blank · 99 comment · 0 complexity · 9820d68439c42ae7763fccb97f70a684 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. * capability request descriptor. It specifies the tokens for which audit
  8. * capability is required.
  9. */
  10. public class AuditCapDescriptor 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. /**
  20. * Constructs a Audit Capability request descriptor. It specifies the tokens
  21. * for which the audit capability is required.
  22. */
  23. public AuditCapDescriptor() {
  24. super.descriptorId = DescriptorType.M_AUDIT_CAP_DESC;
  25. }
  26. /**
  27. * This method cannot be overridden by the derived class. This method
  28. * returns that the descriptor identifier is of type audit capability
  29. * request descriptor. This method overrides the corresponding method of the
  30. * base class Descriptor.
  31. *
  32. * @return Returns an integer value that identifies this object of the type
  33. * of audit capability request descriptor. It returns the value
  34. * M_AUDIT_CAP_DESC of a audit capability descriptor.
  35. */
  36. public int getDescriptorId() {
  37. return super.descriptorId;
  38. }
  39. /**
  40. * This method cannot be overridden by the derived class. This method
  41. * indicates if the mux token is present or not.
  42. *
  43. * @return Returns TRUE if the Mux token is present.
  44. */
  45. public final boolean isMuxTokenPresent() {
  46. return this.muxToken;
  47. }
  48. /**
  49. * This method cannot be overridden by the derived class. This method sets a
  50. * flag to indicate that the mux token is present.
  51. */
  52. public final void setMuxToken() {
  53. this.muxToken = true;
  54. }
  55. /**
  56. * This method cannot be overridden by the derived class. This method
  57. * indicates if the Modem token is present or not.
  58. *
  59. * @return Returns TRUE if the Modem token is present.
  60. */
  61. public final boolean isModemTokenPresent() {
  62. return this.modemTokenPresent;
  63. }
  64. /**
  65. * This method cannot be overridden by the derived class. This method sets a
  66. * flag to indicate that the Modem token is present.
  67. */
  68. public final void setModemToken() {
  69. this.modemTokenPresent = true;
  70. }
  71. /**
  72. * This method cannot be overridden by the derived class. This method
  73. * indicates if the Media token is present or not.
  74. *
  75. * @return Returns TRUE if the Media token is present.
  76. */
  77. public final boolean isMediaTokenPresent() {
  78. return this.mediaToken ;
  79. }
  80. /**
  81. * This method cannot be overridden by the derived class. This method sets a
  82. * flag to indicate that the Media token is present.
  83. */
  84. public final void setMediaToken() {
  85. this.mediaToken = true;
  86. }
  87. /**
  88. * This method cannot be overridden by the derived class. This method
  89. * indicates if the Signal token is present or not.
  90. *
  91. * @return Returns TRUE if the Signal token is present.
  92. */
  93. public final boolean isSignalTokenPresent() {
  94. return this.signalToken;
  95. }
  96. /**
  97. * This method cannot be overridden by the derived class. This method sets a
  98. * flag to indicate that the Signal token is present.
  99. */
  100. public final void setSignalToken() {
  101. this.signalToken = true;
  102. }
  103. /**
  104. * This method cannot be overridden by the derived class. This method
  105. * indicates if the Event Buffer token is present or not.
  106. *
  107. * @return Returns TRUE if the Event Buffer token is present.
  108. */
  109. public final boolean isEventBuffTokenPresent() {
  110. return this.eventBuffToken;
  111. }
  112. /**
  113. * This method cannot be overridden by the derived class. This method sets a
  114. * flag to indicate that the Event Buffer token is present.
  115. */
  116. public final void setEventBuffToken() {
  117. this.eventBuffToken = true;
  118. }
  119. /**
  120. * This method cannot be overridden by the derived class. This method
  121. * indicates if the Statistics token is present or not.
  122. *
  123. * @return Returns TRUE if the Statistics token is present.
  124. */
  125. public final boolean isStatsTokenPresent() {
  126. return this.statsToken;
  127. }
  128. /**
  129. * This method cannot be overridden by the derived class. This method sets a
  130. * flag to indicate that the Statistics token is present.
  131. */
  132. public final void setStatsToken() {
  133. this.statsToken = true;
  134. }
  135. /**
  136. * This method cannot be overridden by the derived class. This method
  137. * indicates if the Events token is present or not.
  138. *
  139. * @return Returns TRUE if the Events token is present.
  140. */
  141. public final boolean isEventsTokenPresent() {
  142. return this.eventsToken;
  143. }
  144. /**
  145. * This method cannot be overridden by the derived class. This method sets a
  146. * flag to indicate that the Events token is present.
  147. */
  148. public final void setEventsToken() {
  149. this.eventsToken = true;
  150. }
  151. /**
  152. * This method cannot be overridden by the derived class. This method
  153. * indicates if the Observed Event token is present or not.
  154. *
  155. * @return Returns TRUE if the Observed Event token is present.
  156. */
  157. public final boolean isObsEventTokenPresent() {
  158. return this.obsEventToken;
  159. }
  160. /**
  161. * This method cannot be overridden by the derived class. This method sets a
  162. * flag to indicate that the Observed Event token is present.
  163. */
  164. public final void setObsEventToken() {
  165. this.obsEventToken = true;
  166. }
  167. }