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

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