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

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