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

 1package javax.megaco.pkg.CPToneGenPkg;
 2
 3import javax.megaco.pkg.MegacoPkg;
 4import javax.megaco.pkg.PkgSignalItem;
 5
 6/**
 7 * The MEGACO Special Information Tone signal class extends the PkgSignalItem
 8 * class. This is a final class. This class defines Special Information Tone
 9 * signal of MEGACO Call Progress Tone Generator package. The methods shall
10 * define that this signal item belongs to the Call Progress Tone Generator
11 * package.
12 */
13public final class CPToneGenSitSignal extends PkgSignalItem {
14
15	/**
16	 * Identifies Special Information tone signal of the MEGACO Call Progress
17	 * Tone Generator Package. Its value shall be set equal to 0x0034.
18	 */
19	public static final int CPTONE_GEN_SIT_SIGNAL = 0x0034;
20
21	private CPToneGenPkg itemsPkgId = new CPToneGenPkg();
22
23	/**
24	 * Constructs a Jain MEGACO Object representing signal Item of the MEGACO
25	 * Package for signal Ringing Tone and Package as Call Progress Tone
26	 * Generator.
27	 */
28	public CPToneGenSitSignal() {
29		super();
30		super.signalId = CPTONE_GEN_SIT_SIGNAL;
31		super.itemId = CPTONE_GEN_SIT_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	 * Special Information Tone signal of Call Progress Tone Generator Package.
38	 * 
39	 * @return It shall return {@link CPTONE_GEN_SIT_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 Ringing Tone signal of Call Progress Tone Generator Package.
50	 * 
51	 * @return It shall return {@link CPTONE_GEN_SIT_SIGNAL}.
52	 */
53	public int getSignalId() {
54		return super.signalId;
55	}
56
57	/**
58	 * This method is used to get the signal identifier from an Signal Item
59	 * object. The implementations of this method in this class returns the id
60	 * of the Special Information Tone signal of Call Progress Tone Generator
61	 * Package.
62	 * 
63	 * @return The package is CPToneGenPkg
64	 */
65	public MegacoPkg getItemsPkgId() {
66
67		return itemsPkgId;
68	}
69
70}