/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/ContinuityPkg/ContRspSignal.java

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