com.adventnet.snmp.mibs
Class ModuleCompliance

java.lang.Object
  |
  +--com.adventnet.snmp.mibs.ModuleCompliance
All Implemented Interfaces:
java.io.Serializable

public class ModuleCompliance
extends java.lang.Object
implements java.io.Serializable

This class represents a MIB MODULE-COMPLIANCE macro in a module.

 The MODULE-COMPLIANCE macro definition is as follows
 
 lowerCaseName    MODULE-COMPLIANCE 
	STATUS          	<StatusV2> 
	DESCRIPTION     	<Text> 
	[REFERENCE      	<Text>] 
	[<Module>]* 
 ::= <oidValue> 
 
Where
<Module> is the ModuleCompliance Module. It corresponds to the ModuleComplianceModule object. There can be one or more ModuleComplianceModule.
<oidValue> is an object identifier value.
<Text> is a character String enclosed within double quotes.
<StatusV2> is any one of the following status values - "current", "deprecated" or "obsolete".

The ModuleCompliance instance can be obtained using any one of the following methods, after loading the MIB containing the MODULE-COMPLIANCE macro.

 MibOperations mibOps = new MibOperations();
 try
 {
  mibOps.loadMibModules("mibFile");
 }
 catch(Exception ex)
 {
  System.out.println(ex);
 }
 

Method 1 MibModule mod = mibops.getMibModule("moduleName"); ModuleCompliance modcom = mod.getModuleCompliance("ModuleComplianceName");

Method 2 MibModule mod = mibops.getMibModule("moduleName"); Enumeration en = mod.getDefinedModuleCompliances(); while(en.hasMoreElements()) { ModuleCompliance modcom = (ModuleCompliance)en.nextElement(); }

Since:
AdventNet SNMP API 4
See Also:
Serialized Form

Method Summary
 java.lang.String getDescription()
          Returns the value of the DESCRIPTION clause for this ModuleCompliance.
 ModuleComplianceModule getMCModule(java.lang.String module)
          Returns the ModuleComplianceModule object for the given name.
 java.util.Vector getMCModules()
          Returns the Vector of ModuleComplianceModule objects.
 java.lang.String getName()
          Returns the name of this ModuleCompliance object.
 java.lang.String getNumberedOIDString()
          Returns the numbered oid String of this ModuleCompliance node.
 java.lang.String getOIDString()
          Returns the named oid String of this ModuleCompliance node.
 java.lang.String getReference()
          Returns the value of the REFERENCE clause for this ModuleCompliance.
 java.lang.String getStatus()
          Returns the STATUS value of this ModuleCompliance.
 java.lang.String toString()
          Returns the name of this ModuleCompliance object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Method Detail

getName

public java.lang.String getName()
Returns the name of this ModuleCompliance object.

See Also:
toString()

toString

public java.lang.String toString()
Returns the name of this ModuleCompliance object. Same as getName()

Overrides:
toString in class java.lang.Object
See Also:
toString()

getStatus

public java.lang.String getStatus()
Returns the STATUS value of this ModuleCompliance.


getMCModules

public java.util.Vector getMCModules()
Returns the Vector of ModuleComplianceModule objects. This ModuleComplianceModule object contains information about the Modules defined in this ModuleCompliance.


getMCModule

public ModuleComplianceModule getMCModule(java.lang.String module)
Returns the ModuleComplianceModule object for the given name. This ModuleComplianceModule object contains information about the Modules defined in this ModuleCompliance.

Parameters:
module - name of the MODULE
Returns:
ModuleCompliance object if the module is defined in this ModuleCompliance. null otherwise

getOIDString

public java.lang.String getOIDString()
Returns the named oid String of this ModuleCompliance node.


getNumberedOIDString

public java.lang.String getNumberedOIDString()
Returns the numbered oid String of this ModuleCompliance node.


getDescription

public java.lang.String getDescription()
Returns the value of the DESCRIPTION clause for this ModuleCompliance.


getReference

public java.lang.String getReference()
Returns the value of the REFERENCE clause for this ModuleCompliance.



Copyright (c)AdventNet Inc., 1996-2006