com.agentpp.smi
Interface IObjectType

All Superinterfaces:

java.lang.Comparable, IObject, java.io.Serializable

public interface IObjectType
extends IObject

IObjectType represents a SMIv1/v2 OBJECT-TYPE construct.

Version:

1.8

Author:

Frank Fock

Field Summary

Fields inherited from interface com.agentpp.smi.IObject

AGENT_CAPABILITIES, MODULE_COMPLIANCE, MODULE_IDENTITY, NOTIFICATION_GROUP, NOTIFICATION_TYPE, OBJECT_GROUP, OBJECT_IDENTITY, OBJECT_NAME, OBJECT_TYPE, TEXTUAL_CONVENTION, TRAP_TYPE

Method Summary

java.lang.String	getAccess()
java.lang.String	getDefaultValue()
IIndexPart	getIndex() Get the INDEX defintion of a table.
ISyntax	getSyntaxDef() Get the SYNTAX clause definition of the OBJECT-TYPE construct.
java.lang.String[]	getTableEntries() Gets the table entries as an array of object names.
java.lang.String	getUnits()
boolean	hasDefaultValue()
boolean	hasIndexPart()
boolean	hasUnits()
boolean	isColumnarObject() Check whether the object type defines a column of a table.
boolean	isScalar() Checks whether the object type is a scalar object.
boolean	isTable() Check whether OBJECT-TYPE defines a table.

Methods inherited from interface com.agentpp.smi.IObject

getComment, getDeepClone, getDescription, getModuleID, getName, getObjectID, getPrintableOid, getReference, getStatus, getType, getTypeString, hasComment, hasDescription, hasReference, hasStatus, isStructural

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getAccess

java.lang.String getAccess()

hasDefaultValue

boolean hasDefaultValue()

getDefaultValue

java.lang.String getDefaultValue()

hasIndexPart

boolean hasIndexPart()

getIndex

IIndexPart getIndex()

Get the INDEX defintion of a table.

Returns:

an IIndexPart instance or null if isTable() and hasIndexPart() return false.

isTable

boolean isTable()

Check whether OBJECT-TYPE defines a table. return true if the OBJECT-TYPE defines the row of a SNMP table. Thus, it returns true if the object is an "...Entry" object.

getTableEntries

java.lang.String[] getTableEntries()

Gets the table entries as an array of object names.

Returns:

an array of object name strings denoting the columns of this table.

isColumnarObject

boolean isColumnarObject()

Check whether the object type defines a column of a table.

Returns:

true if receiver is part of a table definition, false otherwise.

getUnits

java.lang.String getUnits()

hasUnits

boolean hasUnits()

getSyntaxDef

ISyntax getSyntaxDef()

Get the SYNTAX clause definition of the OBJECT-TYPE construct.

Returns:

an ISyntax instance.

isScalar

boolean isScalar()

Checks whether the object type is a scalar object.

Returns:

true if the object is not a table, entry, or columnar object but a scalar accessible object type definition.