Module org.snmp4j.agent

Package org.snmp4j.agent

Interface MOScope

All Known Subinterfaces:

MOContextScope, MOQuery, MutableMOScope

All Known Implementing Classes:

AgentppSimulationMib.AgentppSimDeleteRow, AgentppSimulationMib.AgentppSimDeleteTableContents, AgentppSimulationMib.AgentppSimMode, DateAndTimeScalar, DefaultMOContextScope, DefaultMOQuery, DefaultMOScope, DefaultMOTable, DisplayStringScalar, EnumeratedScalar, MOQueryWithSource, MOScalar, NotificationLogMib.NlmConfigGlobalAgeOut, NotificationLogMib.NlmConfigGlobalEntryLimit, OIDScope, Snmp4jConfigMib.Snmp4jCfgReset, Snmp4jConfigMib.Snmp4jCfgSecSrcAddrValidation, SnmpTsmMib.SnmpTsmConfigurationUsePrefix, SnmpUsmDhObjectsMib.UsmDHParameters, SNMPv2MIB.SysOREntry, SNMPv2MIB.SysUpTimeImpl, TestAndIncr, TimeStampScalar, UsmDHParametersImpl

public interface MOScope

A managed object scope defines a continuous region within the global OID space.

Version:

1.0

Author:

Frank Fock

Method Summary

Modifier and Type	Method	Description
boolean	covers(org.snmp4j.smi.OID oid)	Checks if this scope covers the supplied OID.
org.snmp4j.smi.OID	getLowerBound()	Gets the lower bound OID of the scope.
org.snmp4j.smi.OID	getUpperBound()	Gets the upper bound OID of the scope.
boolean	isCovered(MOScope other)	Checks whether the supplied scope is covered by this scope.
boolean	isLowerIncluded()	Indicates whether the lower bound OID is included in the scope or not.
boolean	isOverlapping(MOScope other)	Checks whether the supplied scope overlap with this one, thus sharing at least one OID with the supplied one.
boolean	isUpperIncluded()	Indicates whether the upper bound OID is included in the scope or not.

Method Detail

getLowerBound

org.snmp4j.smi.OID getLowerBound()

Gets the lower bound OID of the scope. Whether the lower bound is included or excluded from the scope's region is determined by isLowerIncluded().

Returns:

an OID.

getUpperBound

org.snmp4j.smi.OID getUpperBound()

Gets the upper bound OID of the scope. Whether the upper bound is included or excluded from the scope's region is determined by isUpperIncluded().

Returns:

OID

isLowerIncluded

boolean isLowerIncluded()

Indicates whether the lower bound OID is included in the scope or not.

Returns:

true if the lower bound is included.

isUpperIncluded

boolean isUpperIncluded()

Indicates whether the upper bound OID is included in the scope or not.

Returns:

true if the upper bound is included.

isCovered

boolean isCovered(MOScope other)

Checks whether the supplied scope is covered by this scope.

Parameters:

other - the MOScope to check

Returns:

true if the lower bound of other is greater or equal than the lower bound of this scope and if the upper bound of other is lower or equal than the upper bound of this scope.

isOverlapping

boolean isOverlapping(MOScope other)

Checks whether the supplied scope overlap with this one, thus sharing at least one OID with the supplied one.

Parameters:

other - a MOScope.

Returns:

true if there exists at least one OID that is included in both scopes.

covers

boolean covers(org.snmp4j.smi.OID oid)

Checks if this scope covers the supplied OID.

Parameters:

oid - an OID.

Returns:

true if oid is greater or equal the scope's lower bound and if it is less or equal its upper bound.