/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/GenericPkg/GenSigComplEvent.java

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