PageRenderTime 7ms CodeModel.GetById 1ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 1ms

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

http://mobicents.googlecode.com/
Java | 67 lines | 21 code | 11 blank | 35 comment | 0 complexity | 8db449d74ed0b452e91298c7fae587a6 MD5 | raw file
 1package javax.megaco.pkg.ContinuityPkg;
 2
 3import javax.megaco.pkg.MegacoPkg;
 4import javax.megaco.pkg.PkgEventItem;
 5
 6/**
 7 * The MEGACO Completion event class extends the PkgEventItem class. This is a
 8 * final class. This class defines Completion event of MEGACO Continuity
 9 * package. The methods shall define that this event item belongs to the
10 * Continuity package.
11 */
12public final class ContComplEvt extends PkgEventItem {
13
14	/**
15	 * Identifies Completion event of the MEGACO Continuity Package. Its value
16	 * shall be set equal to 0x0005.
17	 */
18	public static final int CONT_COMPL_EVENT = 0x0005;
19
20	private ContinuityPkg itemsPackageId = new ContinuityPkg();
21
22	/**
23	 * Constructs a Jain MEGACO Object representing event item of the MEGACO
24	 * Package for Event Completion and Package as Continuity.
25	 */
26	public ContComplEvt() {
27		super();
28		super.itemId = CONT_COMPL_EVENT;
29		super.eventId = CONT_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 Completion event of Continuity Package.
36	 * 
37	 * @return It shall return {@link CONT_COMPL_EVENT}.
38	 */
39	public 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
47	 * Completion event of Continuity Package.
48	 * 
49	 * @return It shall return {@link CONT_COMPL_EVENT}.
50	 */
51	public int getItemId() {
52
53		return super.itemId;
54	}
55
56	/**
57	 * This method gets the package id to which the item belongs. Since the
58	 * Completion event is defined in the Continuity Package of MEGACO protocol,
59	 * this method returns the ContinuityPkg class object.
60	 * 
61	 * @return The package is ContinuityPkg .
62	 */
63	public MegacoPkg getItemsPackageId() {
64		return itemsPackageId;
65	}
66
67}