/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/NetworkPkg/NetworkQualertEvt.java

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