KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > snmp4j > agent > MutableMOScope


1 /*_############################################################################
2   _##
3   _## SNMP4J-Agent - MutableMOScope.java
4   _##
5   _## Copyright (C) 2005-2007 Frank Fock (SNMP4J.org)
6   _##
7   _## Licensed under the Apache License, Version 2.0 (the "License");
8   _## you may not use this file except in compliance with the License.
9   _## You may obtain a copy of the License at
10   _##
11   _## http://www.apache.org/licenses/LICENSE-2.0
12   _##
13   _## Unless required by applicable law or agreed to in writing, software
14   _## distributed under the License is distributed on an "AS IS" BASIS,
15   _## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   _## See the License for the specific language governing permissions and
17   _## limitations under the License.
18   _##
19   _##########################################################################*/
20
21 package org.snmp4j.agent;
22
23 import org.snmp4j.smi.OID;
24
25 /**
26  * The <code>MutableMOScope</code> interface describes a mutable scope
27  * as needed for query processing.
28  *
29  * @author Frank Fock
30  * @version 1.0
31  */
32 public interface MutableMOScope extends MOScope {
33
34   /**
35    * Sets the lower bound OID of the scope.
36    * @param lowerBound
37    * an OID.
38    */
39   void setLowerBound(OID lowerBound);
40
41   /**
42    * Sets the flag specifying whether the lower bound OID is included in the
43    * scope or not.
44    * @param lowerIncluded
45    * <code>true</code> if the lower bound is included, <code>false</code>
46    * otherwise.
47    */
48   void setLowerIncluded(boolean lowerIncluded);
49
50   /**
51    * Sets the upper bound OID of the scope (can be <code>null</code> for an
52    * unbounded scope.
53    * @param upperBound
54    * an OID or <code>null</code>.
55    */
56   void setUpperBound(OID upperBound);
57
58   /**
59    * Sets the flag specifying whether the upper bound OID is included in the
60    * scope or not. This flag has no effect if <code>upperBound</code> is
61    * <code>null</code>.
62    *
63    * @param upperIncluded
64    * <code>true</code> if the upper bound is included, <code>false</code>
65    * otherwise.
66    */
67   void setUpperIncluded(boolean upperIncluded);
68
69   /**
70    * Changes the scope to no longer cover any elements in covered by the
71    * specified scope.
72    * @param scope
73    * a <code>MOScope</code> instance that defines the range of OIDs
74    * that should be no longer in this scope.
75    */
76   void substractScope(MOScope scope);
77
78 }
79
Popular Tags