PageRenderTime 4ms CodeModel.GetById 1ms app.highlight 1ms RepoModel.GetById 1ms app.codeStats 0ms

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

http://mobicents.googlecode.com/
Java | 71 lines | 22 code | 14 blank | 35 comment | 0 complexity | 21ad7f656d0143a0eb0b9ec321fa59af MD5 | raw file
 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
 9/**
10 * The MEGACO Busy Tone signal class extends the PkgSignalItem class. This is a
11 * final class. This class defines Busy Tone signal of MEGACO Call Progress Tone
12 * Generator package. The methods shall define that this signal item belongs to
13 * the Call Progress Tone Generator package.
14 */
15public final class CPToneGenBtSignal extends PkgSignalItem {
16
17	
18	/**
19	 * Identifies Call busy tone signal of the MEGACO Call Progress Tone
20	 * Generator Package. Its value shall be set equal to 0x0032.
21	 */
22	public static final int CPTONE_GEN_RT_SIGNAL = 0x0032;
23
24	private CPToneGenPkg itemsPkgId = new CPToneGenPkg();
25
26	/**
27	 * Constructs a Jain MEGACO Object representing signal Item of the MEGACO
28	 * Package for signal Busy Tone and Package as Call Progress Tone Generator.
29	 */
30	public CPToneGenBtSignal() {
31		super();
32		super.signalId = CPTONE_GEN_RT_SIGNAL;
33		super.itemId = CPTONE_GEN_RT_SIGNAL;
34	}
35
36	/**
37	 * This method is used to get the item identifier from an Item object. The
38	 * implementations of this method in this class returns the id of the Busy
39	 * Tone signal of Call Progress Tone Generator Package.
40	 * 
41	 * @return It shall return {@link CPTONE_GEN_RT_SIGNAL}.
42	 */
43	public int getItemId() {
44
45		return super.itemId;
46	}
47
48	/**
49	 * This method is used to get the signal identifier from an Signal Item
50	 * object. The implementations of this method in this class returns the id
51	 * of the Busy Tone signal of Call Progress Tone Generator Package.
52	 * 
53	 * @return It shall return {@link CPTONE_GEN_RT_SIGNAL}.
54	 */
55	public int getSignalId() {
56		return super.signalId;
57	}
58
59	/**
60	 * This method gets the package to which the item belongs. Since the Busy
61	 * Tone signal is defined in the Call Progress Tone Generator Package of
62	 * MEGACO protocol, this method returns the CPToneGenPkg class object.
63	 * 
64	 * @return The package is CPToneGenPkg
65	 */
66	public MegacoPkg getItemsPkgId() {
67
68		return itemsPkgId;
69	}
70
71}