MySnmpCrawler API

snmp.mibdb
Interface OidRecord

All Known Implementing Classes:
OidEntity

public interface OidRecord

This is the external interface to the OidEntity object.

Version:
$Revision: 0.1 $ $Date: 2004/03/09 06:03:55 $
Author:
Scott Cheng

Field Summary
static int CURRENT_STATUS
           
static int DEPRECATED_STATUS
           
static int MANDATORY_STATUS
           
static int NO_ACCESS
           
static int NOTIFY_ACCESS
           
static int OBSOLETE_STATUS
           
static int OPTIONAL_STATUS
           
static int READ_ACCESS
           
static int READ_CREATE_ACCESS
           
static int READ_WRITE_ACCESS
           
static int WRITE_ACCESS
           
 
Method Summary
 boolean checkPermission(int permission)
          Checks the passed permission with the permission of the object variable in the MIB database.
 java.lang.String getAccess()
          Gets the access description of the object variable.
 byte getAsnType()
          Gets the ASN.1 type of the object variable.
 java.lang.String getDescription()
          Gets the description text of the object variable.
 java.lang.String getName()
          Gets the object variable name.
 java.lang.String getOid()
          Gets the object identifier (OID) string.
 OidRecord getOidGroup()
          Gets the parent object variable.
 java.lang.String getType()
          Gets the text description of the object type.
 

Field Detail

NO_ACCESS

public static final int NO_ACCESS
See Also:
Constant Field Values

NOTIFY_ACCESS

public static final int NOTIFY_ACCESS
See Also:
Constant Field Values

READ_ACCESS

public static final int READ_ACCESS
See Also:
Constant Field Values

WRITE_ACCESS

public static final int WRITE_ACCESS
See Also:
Constant Field Values

READ_WRITE_ACCESS

public static final int READ_WRITE_ACCESS
See Also:
Constant Field Values

READ_CREATE_ACCESS

public static final int READ_CREATE_ACCESS
See Also:
Constant Field Values

MANDATORY_STATUS

public static final int MANDATORY_STATUS
See Also:
Constant Field Values

OPTIONAL_STATUS

public static final int OPTIONAL_STATUS
See Also:
Constant Field Values

CURRENT_STATUS

public static final int CURRENT_STATUS
See Also:
Constant Field Values

DEPRECATED_STATUS

public static final int DEPRECATED_STATUS
See Also:
Constant Field Values

OBSOLETE_STATUS

public static final int OBSOLETE_STATUS
See Also:
Constant Field Values
Method Detail

getOid

public java.lang.String getOid()
Gets the object identifier (OID) string.

Returns:
The OID string.

getName

public java.lang.String getName()
Gets the object variable name.

Returns:
The object variable name.

getType

public java.lang.String getType()
Gets the text description of the object type.

Returns:
The text description of the object type.

getAsnType

public byte getAsnType()
Gets the ASN.1 type of the object variable.

Returns:
The ASN.1 type of the variable.

checkPermission

public boolean checkPermission(int permission)
Checks the passed permission with the permission of the object variable in the MIB database.

Returns:
True if the permission is valid, otherwise false.
Throws:
TypeOfException - Thrown when ...

getAccess

public java.lang.String getAccess()
Gets the access description of the object variable.

Returns:
The access description of the object variable.

getDescription

public java.lang.String getDescription()
Gets the description text of the object variable.

Returns:
The description text of the object variable.

getOidGroup

public OidRecord getOidGroup()
Gets the parent object variable.

Returns:
The parent object variable.

MySnmpCrawler API