PageRenderTime 10ms CodeModel.GetById 1ms app.highlight 5ms RepoModel.GetById 1ms app.codeStats 1ms

/protocols/jain-megaco/megaco-api/src/main/java/javax/megaco/pkg/BaseRootPkg/RootNormMGCExecTimePrpt.java

http://mobicents.googlecode.com/
Java | 95 lines | 32 code | 13 blank | 50 comment | 0 complexity | ca0dffe52fc924f026d2db9343a39364 MD5 | raw file
 1package javax.megaco.pkg.BaseRootPkg;
 2
 3import javax.megaco.message.DescriptorType;
 4import javax.megaco.pkg.MegacoPkg;
 5import javax.megaco.pkg.ParamValueType;
 6import javax.megaco.pkg.PkgPrptyItem;
 7
 8/**
 9 * The MEGACO NormMGCExecTime property class extends the PkgPrptyItem class.
10 * This is a final class. This class defines NormMGCExecTime property of MEGACO
11 * Root package. The methods shall define that this property item belongs to the
12 * Root package.
13 */
14public final class RootNormMGCExecTimePrpt extends PkgPrptyItem {
15
16	/**
17	 *Identifies NormMGCExecTime property of the MEGACO Base Root Package. Its
18	 * value shall be set equal to 0x0004.
19	 */
20	public static final int ROOT_NORM_MGC_EXEC_TIME_PRPT = 0x0004;
21
22	protected int[] itemsDescriptorIds = null;
23
24	/**
25	 * Constructs a Jain MEGACO Object representing property item of the MEGACO
26	 * Package for property NormMGCExecTime and Package as Base Root.
27	 */
28	public RootNormMGCExecTimePrpt() {
29		super();
30		super.propertyId = ROOT_NORM_MGC_EXEC_TIME_PRPT;
31		super.itemId = ROOT_NORM_MGC_EXEC_TIME_PRPT;
32		super.packageId = new BaseRootPkg();
33		super.itemValueType = ParamValueType.M_INTEGER;
34
35		this.itemsDescriptorIds = new int[] { DescriptorType.M_TERMINATION_STATE_DESC };
36	}
37
38	/**
39	 * This method is used to get the item identifier from an Item object. The
40	 * implementations of this method in this class returns the id of the Normal
41	 * MGC Execution Time property of ROOT Package.
42	 * 
43	 * @return It shall return {@link ROOT_NORM_MGC_EXEC_TIME_PRPT}
44	 */
45	public int getItemId() {
46		return super.itemId;
47	}
48
49	/**
50	 * The method can be used to get the type of the value as defined in the
51	 * MEGACO packages. These could be one of string or enumerated value or
52	 * integer or double value or boolean.
53	 * 
54	 * @return It returns {@link ParamValueType.INTEGER}
55	 *         indicating that the parameter is a double.
56	 */
57	public int getItemValueType() {
58		return super.itemValueType;
59	}
60
61	/**
62	 * This method is used to get the property identifier from an Property Item
63	 * object. The implementations of this method in this class returns the id
64	 * of the Normal MGC Execution Time property of ROOT Package.
65	 * 
66	 * @return It shall return {@link ROOT_NORM_MGC_EXEC_TIME_PRPT}
67	 */
68	public int getPropertyId() {
69
70		return super.propertyId;
71	}
72
73	/**
74	 * This method gets the package id to which the item belongs. Since the
75	 * Normal MGC Execution Time property is defined in the Base ROOT Package of
76	 * MEGACO protocol, this method returns the value {@link BASE_ROOT_PACKAGE}
77	 * constant. This constant is defined in the PkgConsts class.
78	 */
79	public MegacoPkg getItemsPkgId() {
80		return this.packageId;
81	}
82
83	/**
84	 * The method can be used to get the descriptor ids corresponding to the
85	 * parameters to which the parameter can be set.
86	 * 
87	 * @return This parameter can be present in Event descriptor. It shall thus
88	 *         return a value DescriptorType.M_TERMINATION_STATE_DESC as a part
89	 *         of integer vector.
90	 */
91	public int[] getDescriptorIds() {
92		return this.itemsDescriptorIds;
93
94	}
95}