PageRenderTime 39ms CodeModel.GetById 32ms app.highlight 4ms RepoModel.GetById 2ms app.codeStats 0ms

/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/DTMFDetPkg/DTMFDetParamMeth.java

http://mobicents.googlecode.com/
Java | 86 lines | 30 code | 12 blank | 44 comment | 0 complexity | 04001fc15f95a973d4b28b2e408b8ef1 MD5 | raw file
 1package javax.megaco.pkg.DTMFDetPkg;
 2
 3import javax.megaco.message.DescriptorType;
 4import javax.megaco.pkg.ParamValueType;
 5import javax.megaco.pkg.PkgItemParam;
 6
 7/**
 8 *The MEGACO parameter class for the Termination Method Parameter is associated
 9 * with Signal Completion event of DTMF Detect Package. This class defines all
10 * the static information for this parameter.
11 */
12public class DTMFDetParamMeth extends PkgItemParam {
13
14	/**
15	 * Identifies Termination method parameter of the MEGACO DTMF Detection
16	 * Package. Its value shall be set equal to 0x0003.
17	 */
18	public static final int DTMF_DET_PARAM_METH = 0x0003;
19	private DTMFDetPkg itemsPackageId = new DTMFDetPkg();
20
21	/**
22	 * Constructs a parameter class for DTMF Detect package that specifies the
23	 * parameter as Termination Method.
24	 */
25	public DTMFDetParamMeth() {
26		super();
27
28		super.itemValueType = ParamValueType.M_STRING;
29		super.paramId = DTMF_DET_PARAM_METH;
30		super.paramsDescriptorIds = new int[] { DescriptorType.M_OBSERVED_EVENT_DESC };
31		super.paramsItemIds = new int[] { DTMFDetCeEvt.DTMF_DET_CE_EVENT };
32	}
33
34	/**
35	 * The method can be used to get the parameter identifier as defined in the
36	 * MEGACO packages. The implementation of this method in this class returns
37	 * Id of Digit String parameter.
38	 * 
39	 * @return paramId - Returns param id {@link DTMF_DET_PARAM_METH}.
40	 */
41	public int getParamId() {
42
43		return super.paramId;
44	}
45
46	/**
47	 * The method can be used to get the type of the parameter as defined in the
48	 * MEGACO packages. These could be one of string or enumerated value or
49	 * integer or double value or boolean.
50	 * 
51	 * @return It returns {@link _STRING} indicating that the
52	 *         parameter is a string.
53	 */
54	public int getParamValueType() {
55		return super.itemValueType;
56	}
57
58	public DTMFDetPkg getItemsPackageId() {
59		return itemsPackageId;
60	}
61
62	/**
63	 * The method can be used to get the descriptor ids corresponding to the
64	 * parameters to which the parameter can be set.
65	 * 
66	 * @return This parameter can be present in Event descriptor. It shall thus
67	 *         return a value {@link M_OBSERVED_EVENT_DESC} as a part of integer
68	 *         vector.
69	 */
70	public int[] getParamsDescriptorIds() {
71		return super.paramsDescriptorIds;
72	}
73
74	/**
75	 * The method can be used to get the item ids corresponding to the
76	 * parameters to which the parameter can be set. This method specifies the
77	 * valid item (event/signal) ids to which the parameter can belong to.
78	 * 
79	 * @return The integer value corresponding to Network Failure. Thus this
80	 *         shall return {@link DTMF_DET_CE_EVENT}.
81	 */
82	public int[] getParamsItemIds() {
83		return super.paramsItemIds;
84	}
85
86}