/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/CPToneGenPkg/CPToneGenCtSignal.java

 1package javax.megaco.pkg.CPToneGenPkg;
 2
 3import javax.megaco.pkg.MegacoPkg;
 4import javax.megaco.pkg.PkgSignalItem;
 5import javax.megaco.pkg.DTMFGenPkg.DTMFGenPkg;
 6
 7/**
 8 * The MEGACO Congestion Tone signal class extends the PkgSignalItem class. This
 9 * is a final class. This class defines Congestion Tone signal of MEGACO Call
10 * Progress Tone Generator package. The methods shall define that this signal
11 * item belongs to the Call Progress Tone Generator package.
12 */
13public final class CPToneGenCtSignal extends PkgSignalItem {
14
15	/**
16	 * Identifies Congestion tone signal of the MEGACO Call Progress Tone
17	 * Generator Package. Its value shall be set equal to 0x0033.
18	 */
19	public static final int CP_TONE_GEN_CT_SIGNAL = 0x0033;
20
21	private CPToneGenPkg itemsPkgId = new CPToneGenPkg();
22
23	/**
24	 * This method is used to get the signal identifier from an Signal Item
25	 * object. The implementations of this method in this class returns the id
26	 * of the Congestion Tone signal of Call Progress Tone Generator Package.
27	 */
28	public CPToneGenCtSignal() {
29		super();
30		super.signalId = CP_TONE_GEN_CT_SIGNAL;
31		super.itemId = CP_TONE_GEN_CT_SIGNAL;
32	}
33
34	/**
35	 * This method is used to get the item identifier from an Item object. The
36	 * implementations of this method in this class returns the id of the
37	 * Congestion Tone signal of Call Progress Tone Generator Package.
38	 * 
39	 * @return It shall return {@link CP_TONE_GEN_CT_SIGNAL}.
40	 */
41	public int getItemId() {
42
43		return super.itemId;
44	}
45
46	/**
47	 * This method is used to get the signal identifier from an Signal Item
48	 * object. The implementations of this method in this class returns the id
49	 * of the Congestion Tone signal of Call Progress Tone Generator Package.
50	 * 
51	 * @return It shall return {@link CP_TONE_GEN_CT_SIGNAL}.
52	 */
53	public int getSignalId() {
54		return super.signalId;
55	}
56
57	/**
58	 * This method gets the package id to which the item belongs. Since the
59	 * Congestion Tone signal is defined in the Call Progress Tone Generator
60	 * Package of MEGACO protocol, this method returns the CPToneGenPkg class
61	 * object.
62	 * 
63	 * @return The package is CPToneGenPkg
64	 */
65	public MegacoPkg getItemsPkgId() {
66
67		return itemsPkgId;
68	}
69
70}