org.soulwing.snmp

Interface IndexDescriptor

public interface IndexDescriptor

A descriptor for a conceptual table index object.

Author:

Carl Harris

Method Summary

Modifier and Type	Method and Description
int[]	getEncoded() Gets the encoded form of the index value described by the receiver.
String	getOid() Gets the object identifier of the index value described by the receiver.
int	getSyntax() Gets the SMI syntax indicator for the index object described by the receiver.
boolean	isImplied() Gets the state of a flag indicating whether the length of the index value described by the receiver is implied (i.e.

Method Detail

getOid

String getOid()

Gets the object identifier of the index value described by the receiver.

This method returns only that portion of the indexed object's OID that corresponds to the index value.

Returns:

object identifier substring representing the index value

getSyntax

int getSyntax()

Gets the SMI syntax indicator for the index object described by the receiver.

Returns:

syntax indicator

getEncoded

int[] getEncoded()

Gets the encoded form of the index value described by the receiver.

This method returns only that portion of the indexed object's OID that corresponds to the index value.

Returns:

an integer array containing the OID-encoded index value

isImplied

boolean isImplied()

Gets the state of a flag indicating whether the length of the index value described by the receiver is implied (i.e. not included in the object identifier).

Returns:

flag state