com.adventnet.snmp.mibs
Class ModuleComplianceModule

java.lang.Object
  |
  +--com.adventnet.snmp.mibs.ModuleComplianceModule

All Implemented Interfaces:

java.io.Serializable

public class ModuleComplianceModule

extends java.lang.Object

implements java.io.Serializable

This class represents the MODULE clause present in the MODULE-COMPLIANCE macro. An ModuleCompliance Module contains the following definition

 MODULE   <ModuleName>
 [MANDATORY-GROUPS    { <Objects> }]
 [<ComplianceGroup>    |   <Object>] 
 

 where ComplianceGroup contains the following clauses
	GROUP { <Objects> } 
	DESCRIPTION    Text
 

 and Object contains the following clauses
	OBJECT { <Objects> } 
	[SYNTAX	<SyntaxV2>] 
	[WRITE-SYNTAX	<SyntaxV2>]
	[MIN-ACCESS	<AccessV2>]
	DESCRIPTION	<Text> 
 

where

<SyntaxV2> is the SMIv2 syntax.

<AccessV2> is the SMIV2 access value.

<Objects> is one or more scalar or columnar objects name. Multiple objects are seperated by comma.

<Text> is a character String enclosed within double quotes.

The ModuleComplianceModule instance can be obtained as follows after loading the MIB module. The MIB module should contain the MODULE-COMPLIANCE macro with the MODULE clause.

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

 After getting the ModuleCompliance object, you can get the 
 ModuleComplianceModule object using any one of the following methods
 

 Method 1
 Vector mcModules = modcom.getMCModules();
 ModuleComplianceModule mcm = (ModuleComplianceModule)mcModules.elementAt(0);
 

 Method 2
 ModuleComplianceModule mcm = modcom.getMCModule("ModuleComplianceModuleName");
 

Since:

AdventNet SNMP API 4

See Also:

Serialized Form

Method Summary

java.lang.String	getGroupDescr(java.lang.String groupName) Returns the description for the given group name.
java.util.Vector	getGroups() Returns a Vector of groups defined in this ModuleCompliance Module.
java.util.Vector	getMandatoryGroups() Retuns a Vector of MandatoryGroups defined in this ModuleCompliance Module.
java.lang.String	getName() Returns the name of this ModuleComplianceModule object.
java.lang.String	getObjectDescr(java.lang.String objectName) Returns the description for the given object name.
java.lang.String	getObjectMinAccess(java.lang.String objectName) Returns the MIN-ACCESS value of the OBJECT with the given object name.
java.util.Vector	getObjects() Returns a Vector of objects defined in this ModuleCompliance Module.
java.lang.String	getObjectSyntax(java.lang.String objectName) Returns the SYNTAX value of the OBJECT with the given name.
java.lang.String	getObjectWriteSyntax(java.lang.String objectName) Returns the WRITE-SYNTAX value of the OBJECT with the given object name.
java.lang.String	toString() Returns the name of this ModuleComplianceModule 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 ModuleComplianceModule object.

See Also:

toString

toString

public java.lang.String toString()

Returns the name of this ModuleComplianceModule object. Same as getName()

Overrides:

toString in class java.lang.Object

See Also:

toString

getMandatoryGroups

public java.util.Vector getMandatoryGroups()

Retuns a Vector of MandatoryGroups defined in this ModuleCompliance Module.

Returns:

Vector of groups defined in MANDATORY-GROUPS clause. empty Vector if MANDATORY GROUPS clause is not present.

getObjects

public java.util.Vector getObjects()

Returns a Vector of objects defined in this ModuleCompliance Module.

getGroups

public java.util.Vector getGroups()

Returns a Vector of groups defined in this ModuleCompliance Module.

getGroupDescr

public java.lang.String getGroupDescr(java.lang.String groupName)

Returns the description for the given group name.

Returns:

value of the DESCRIPTION clause for the GROUP defined in this ModuleCompliance Module null if the specified group is not present in this ModuleCompliance Module

getObjectDescr

public java.lang.String getObjectDescr(java.lang.String objectName)

Returns the description for the given object name.

Returns:

value of the DESCRIPTION clause for the OBJECT defined in this ModuleCompliance Module null if the specified object is not present in this ModuleCompliance Module

getObjectSyntax

public java.lang.String getObjectSyntax(java.lang.String objectName)

Returns the SYNTAX value of the OBJECT with the given name.

Returns:

value of the SYNTAX clause for the OBJECT defined in this ModuleCompliance Module. null if the specified object is not present in this ModuleCompliance Module or if the SYNTAX clause is not present.

getObjectWriteSyntax

public java.lang.String getObjectWriteSyntax(java.lang.String objectName)

Returns the WRITE-SYNTAX value of the OBJECT with the given object name.

Returns:

value of the WRITE-SYNTAX clause for the OBJECT defined in this ModuleCompliance Module. null if the specified object is not present in this ModuleCompliance Module or if the WRITE-SYNTAX clause is not present.

getObjectMinAccess

public java.lang.String getObjectMinAccess(java.lang.String objectName)

Returns the MIN-ACCESS value of the OBJECT with the given object name.

Returns:

value of the MIN-ACCESS clause for the OBJECT defined in this ModuleCompliance Module. null if the specified object is not present in this ModuleCompliance Module or if the MIN-ACCESS clause is not present.