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

 1/**
 2 * Start time:17:09:08 2009-02-17<br>
 3 * Project: mobicents-jain-megaco-stack<br>
 4 * 
 5 * @author <a href="mailto:baranowb@gmail.com">baranowb - Bartosz Baranowski
 6 *         </a>
 7 * @author <a href="mailto:brainslog@gmail.com"> Alexandre Mendonca </a>
 8 */
 9package javax.megaco.pkg.GenericPkg;
10
11import javax.megaco.pkg.MegacoPkg;
12import javax.megaco.pkg.PkgConsts;
13
14/**
15 * The MEGACO Generic package inherits all methods of the Package, but overrides
16 * the getPkgId and getPkgName to define packageid corresponding to the Generic
17 * Package. This class also overrides the getExtendedPkgIds to define that there
18 * are no packages that this package extends.
19 */
20public class GenericPkg extends MegacoPkg {
21
22	/**
23	 * Constructs a MEGACO Generic Package.
24	 */
25	public GenericPkg() {
26		super();
27
28	}
29
30	/**
31	 * This method gets the package ids of all the package which the package had
32	 * directly or indirectly extended. Package ids are defined in PkgConsts.
33	 * 
34	 * @return Since this packge extends no other package, this shall return a
35	 *         NULL value.
36	 */
37	public final int[] getExtendedPkgIds() {
38
39		return null;
40	}
41
42	/**
43	 * This method return the package Id of the MEGACO package for which the
44	 * object is created. For Generic Package constant value GENERIC_PACKAGE
45	 * shall be returned.
46	 * 
47	 * @return Constant value {@link PkgConsts.GENERIC_PACKAGE} indicating
48	 *         Generic Package.
49	 */
50	public final int getPkgId() {
51
52		return PkgConsts.GENERIC_PACKAGE;
53	}
54
55}