TCModule


1   /*_############################################################################
2     _## 
3     _##  SNMP4J-Agent - TCModule.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.mo.snmp.tc;
22  
23  import java.util.Collection  ;
24  
25  /**
26   * A <code>TCModule</code> interface defines the common public properties of
27   * a textual convention registration. By convention, there should be a
28   * <code>TCModule</code> instance for each MIB module definition supported by
29   * an agent. But it is also possible to have only a single instance,
30   * for example, a single managed object factory.
31   *
32   * @author Frank Fock
33   * @version 1.0
34   */
35  public interface TCModule {
36  
37    /**
38     * Returns the (unique) name of the module definition.
39     * @return
40     *    a unique SMI MODULE name (upper case string with hyphens).
41     */
42    String   getName();
43  
44    /**
45     * Gets the textual convention for the specified name.
46     * @param name
47     *    the object definition name of the TC MIB definition.
48     * @return
49     *    a <code>TextualConvention</code> instance.
50     */
51    TextualConvention getTextualConvention(String   name);
52  
53    /**
54     * Gets a collection of <code>TextualConvention</code> instances in this
55     * <code>TCModule</code>.
56     * @return
57     *    a Collection of <code>TextualConvention</code> instances.
58     */
59    Collection   getTextualConventions();
60  
61  }
62
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags