/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/AnalogLineSPkg/AnalogLineSFlashEvt.java
Java | 65 lines | 21 code | 9 blank | 35 comment | 0 complexity | 0ff7cac8ee6f915aa9764857199194d6 MD5 | raw file
1package javax.megaco.pkg.AnalogLineSPkg; 2 3import javax.megaco.pkg.MegacoPkg; 4import javax.megaco.pkg.PkgEventItem; 5 6/** 7 * The MEGACO Flash Hook event class extends the PkgEventItem class. This is a 8 * final class. This class defines Flash Hook event of Analog Line Supervision 9 * package. The methods shall define that this event item belongs to the Analog 10 * Line Supervision package. 11 */ 12public final class AnalogLineSFlashEvt extends PkgEventItem { 13 /** 14 * Identifies Flash Hook event of the MEGACO Analog Line Supervision 15 * Package. Its value shall be set equal to 0x0006. 16 */ 17 public static final int ANALOG_LINE_FLASH_EVENT = 0x0006; 18 19 /** 20 * Constructs a Jain MEGACO Object representing event Item of the MEGACO 21 * Package for event FlashHook and package as Analog Line Supervision. 22 */ 23 public AnalogLineSFlashEvt() { 24 super(); 25 super.itemId = ANALOG_LINE_FLASH_EVENT; 26 super.eventId = ANALOG_LINE_FLASH_EVENT; 27 super.packageId = new AnalogLineSPkg(); 28 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 Flash Hook event of Analog Line Supervision Package. 35 * 36 * @return It shall {@link ANALOG_LINE_FLASH_EVENT}. 37 */ 38 public int getEventId() { 39 40 return super.itemId; 41 } 42 43 /** 44 * This method is used to get the item identifier from an Item object. The 45 * implementations of this method in this class returns the id of the Flash 46 * Hook event of Analog Line Supervision Package. 47 * 48 * @return It shall return {@link ANALOG_LINE_FLASH_EVENT}. 49 */ 50 public int getItemId() { 51 52 return super.itemId; 53 } 54 55 /** 56 * This method gets the package to which the item belongs. Since the Flash 57 * Hook event is defined in the Analog Line Supervision Package of MEGACO 58 * protocol, this method returns the AnalogLineSPkg class object. 59 * 60 * @return The package is {@link AnalogLineSPkg}. 61 */ 62 public MegacoPkg getItemsPkgId() { 63 return super.packageId; 64 } 65}