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

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