CPToneGenPtSignal.java

package javax.megaco.pkg.CPToneGenPkg;

import javax.megaco.pkg.MegacoPkg;
import javax.megaco.pkg.PkgSignalItem;

/**
 * The MEGACO Payphone Recognition Tone signal class extends the PkgSignalItem
 * class. This is a final class. This class defines Payphone Recognition Tone
 * signal of MEGACO Call Progress Tone Generator package. The methods shall
 * define that this signal item belongs to the Call Progress Tone Generator
 * package.
 */
public final class CPToneGenPtSignal extends PkgSignalItem {

	/**
	 * Identifies Payphone Recognition tone signal of the MEGACO Call Progress
	 * Tone Generator Package. Its value shall be set equal to 0x0036.
	 */
	public static final int CP_TONE_GEN_PT_SIGNAL = 0x0036;

	private CPToneGenPkg itemsPkgId = new CPToneGenPkg();

	/**
	 * Constructs a Jain MEGACO Object representing signal Item of the MEGACO
	 * Package for signal Payphone Recognition Tone and Package as Call Progress
	 * Tone Generator.
	 */
	public CPToneGenPtSignal() {
		super();
		super.signalId = CP_TONE_GEN_PT_SIGNAL;
		super.itemId = CP_TONE_GEN_PT_SIGNAL;
	}

	/**
	 * This method is used to get the item identifier from an Item object. The
	 * implementations of this method in this class returns the id of the
	 * Payphone Recognition Tone signal of Call Progress Tone Generator Package.
	 * 
	 * @return It shall return {@link CP_TONE_GEN_PT_SIGNAL}.
	 */
	public int getItemId() {

		return super.itemId;
	}

	/**
	 * This method is used to get the signal identifier from an Signal Item
	 * object. The implementations of this method in this class returns the id
	 * of the Payphone Recognition Tone signal of Call Progress Tone Generator
	 * Package.
	 * 
	 * @return It shall return {@link CP_TONE_GEN_PT_SIGNAL}.
	 */
	public int getSignalId() {
		return super.signalId;
	}

	/**
	 * This method is used to get the signal identifier from an Signal Item
	 * object. The implementations of this method in this class returns the id
	 * of the Special Information Tone signal of Call Progress Tone Generator
	 * Package.
	 * 
	 * @return The package is CPToneGenPkg
	 */
	public MegacoPkg getItemsPkgId() {

		return itemsPkgId;
	}

}