/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/CPToneDetPkg/CPToneDetWtEvt.java

 1package javax.megaco.pkg.CPToneDetPkg;
 2
 3import javax.megaco.pkg.MegacoPkg;
 4import javax.megaco.pkg.PkgEventItem;
 5
 6/**
 7 * The MEGACO Warning Tone event class extends the PkgEventItem class. This is a
 8 * final class. This class defines Warning Tone event of MEGACO Call Progress
 9 * Tone Detect package. The methods shall define that this event item belongs to
10 * the Call Progress Tone Detect package.
11 */
12public final class CPToneDetWtEvt extends PkgEventItem {
13
14	/**
15	 * Identifies Warning tone event of the MEGACO Call Progress Tone Detect
16	 * Package. Its value shall be set equal to 0x0035.
17	 */
18	public static final int CP_TONE_DET_WT_EVENT = 0x0035;
19
20	private CPToneDetPkg itemsPackageId = new CPToneDetPkg();
21
22	/**
23	 * Constructs a Jain MEGACO Object representing event Item of the MEGACO
24	 * Package for event Warning Tone and Package as Call Progress Tone Detect.
25	 */
26	public CPToneDetWtEvt() {
27		super();
28		super.itemId = CP_TONE_DET_WT_EVENT;
29		super.eventId = CP_TONE_DET_WT_EVENT;
30	}
31
32	/**
33	 * This method is used to get the event identifier from an Event Item
34	 * object. The implementations of this method in this class returns the id
35	 * of the Warning Tone event of Call Progress Tone Detect Package.
36	 * 
37	 * @return It shall return {@link CP_TONE_DET_WT_EVENT}.
38	 */
39	public int getEventId() {
40
41		return super.eventId;
42	}
43
44	/**
45	 * This method is used to get the item identifier from an Item object. The
46	 * implementations of this method in this class returns the id of the
47	 * Warning Tone event of Call Progress Tone Detect Package.
48	 * 
49	 * @return It shall return {@link CP_TONE_DET_WT_EVENT}.
50	 */
51	public int getItemId() {
52
53		return super.itemId;
54	}
55
56	/**
57	 * This method gets the package id to which the item belongs. Since the
58	 * Warning Tone event is defined in the Call Progress Tone Detect Package of
59	 * MEGACO protocol, this method returns the CPToneDetPkg class object.
60	 * 
61	 * @return
62	 */
63	public MegacoPkg getItemsPackageId() {
64		return itemsPackageId;
65	}
66
67}