/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/CPToneGenPkg/CPToneGenRtSignal.java
Java | 68 lines | 21 code | 11 blank | 36 comment | 0 complexity | 3e73d5e3e065370ffbe6c08777132704 MD5 | raw file
1package javax.megaco.pkg.CPToneGenPkg; 2 3import javax.megaco.pkg.MegacoPkg; 4import javax.megaco.pkg.PkgSignalItem; 5 6/** 7 * The MEGACO Ringing Tone signal class extends the PkgSignalItem class. This is 8 * a final class. This class defines Ringing Tone signal of MEGACO Call Progress 9 * Tone Generator package. The methods shall define that this signal item 10 * belongs to the Call Progress Tone Generator package. 11 */ 12public final class CPToneGenRtSignal extends PkgSignalItem { 13 14 /** 15 * Identifies Ringing tone signal of the MEGACO Call Progress Tone Generator 16 * Package. Its value shall be set equal to 0x0031. 17 */ 18 public static final int CP_TONE_GEN_BT_SIGNAL = 0x0031; 19 20 private CPToneGenPkg itemsPkgId = new CPToneGenPkg(); 21 22 /** 23 * Constructs a Jain MEGACO Object representing signal Item of the MEGACO 24 * Package for signal Ringing Tone and Package as Call Progress Tone 25 * Generator. 26 */ 27 public CPToneGenRtSignal() { 28 super(); 29 super.signalId = CP_TONE_GEN_BT_SIGNAL; 30 super.itemId = CP_TONE_GEN_BT_SIGNAL; 31 } 32 33 /** 34 * This method is used to get the item identifier from an Item object. The 35 * implementations of this method in this class returns the id of the 36 * Ringing Tone signal of Call Progress Tone Generator Package. 37 * 38 * @return It shall return {@link CP_TONE_GEN_BT_SIGNAL}. 39 */ 40 public int getItemId() { 41 42 return super.itemId; 43 } 44 45 /** 46 * This method is used to get the signal identifier from an Signal Item 47 * object. The implementations of this method in this class returns the id 48 * of the Ringing Tone signal of Call Progress Tone Generator Package. 49 * 50 * @return It shall return {@link CP_TONE_GEN_BT_SIGNAL}. 51 */ 52 public int getSignalId() { 53 return super.signalId; 54 } 55 56 /** 57 * This method gets the package id to which the item belongs. Since the Dial 58 * Tone signal is defined in the Call Progress Tone Generator Package of 59 * MEGACO protocol, this method returns the CPToneGenPkg class object. 60 * 61 * @return The package is CPToneGenPkg 62 */ 63 public MegacoPkg getItemsPkgId() { 64 65 return itemsPkgId; 66 } 67 68}