/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/RTPPkg/RTPPltransEvt.java

 1package javax.megaco.pkg.RTPPkg;
 2
 3import javax.megaco.pkg.MegacoPkg;
 4import javax.megaco.pkg.PkgEventItem;
 5
 6/**
 7 * The MEGACO Payload Transition event class extends the PkgEventItem class.
 8 * This is a final class. This class defines Payload Transition event of MEGACO
 9 * RTP package. The methods shall define that this event item belongs to the RTP
10 * package.
11 */
12public class RTPPltransEvt extends PkgEventItem {
13
14	/**
15	 * Identifies Payload Transition event of the MEGACO RTP Package. Its value
16	 * shall be set equal to 0x0001.
17	 */
18	public static final int RTP_PLTRANS_EVENT = 0x0001;
19
20	/**
21	 * Constructs a Jain MEGACO Object representing event Item of the MEGACO
22	 * Package for event Payload Transition and package as RTP.
23	 */
24	public RTPPltransEvt() {
25		super();
26		super.eventId = RTP_PLTRANS_EVENT;
27		super.itemId = RTP_PLTRANS_EVENT;
28		super.packageId = new RTPPkg();
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 Payload Transition event of RTP Package.
35	 * 
36	 * @return It shall return {@link RTP_PLTRANS_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	 * Payload Transition event of RTP Package.
46	 * 
47	 * @return It shall return {@link RTP_PLTRANS_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	 * Payload Transition event is defined in the RTP Package of MEGACO
56	 * protocol, this method returns the RTPPkg class object.
57	 * 
58	 * @return The package is RTPPkg.
59	 */
60	public MegacoPkg getItemsPkgId() {
61
62		return super.getItemsPkgId();
63	}
64
65}