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