/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/DTMFDetPkg/DTMFDetCeEvt.java

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