View Javadoc

1   /*
2    * Copyright 2005 The Apache Software Foundation.
3    * 
4    * Licensed under the Apache License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at 
7    * 
8    *     http://www.apache.org/licenses/LICENSE-2.0
9    * 
10   * Unless required by applicable law or agreed to in writing, software 
11   * distributed under the License is distributed on an "AS IS" BASIS, 
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 
13   * See the License for the specific language governing permissions and 
14   * limitations under the License.
15   */
16  
17  package org.apache.jdo.model.jdo;
18  
19  import org.apache.jdo.model.ModelException;
20  
21  /***
22   * A JDOExtension instance represents a JDO vendor specific extension.
23   * 
24   * @author Michael Bouschen
25   */
26  public interface JDOExtension 
27  {
28      /***
29       * Returns the vendor name of this vendor extension.
30       */
31      public String getVendorName();
32  
33      /***
34       * Sets the vendor name for this vendor extension.
35       * @exception ModelException if impossible
36       */
37      public void setVendorName(String vendorName)
38          throws ModelException;
39      
40      /***
41       * Returns the key of this vendor extension.
42       */
43      public String getKey();
44  
45      /***
46       * Sets the key for this vendor extension.
47       * @exception ModelException if impossible
48       */
49      public void setKey(String key)
50          throws ModelException;
51      
52      /***
53       * Returns the value of this vendor extension.
54       */
55      public Object getValue();
56  
57      /***
58       * Sets the value for this vendor extension.
59       * @exception ModelException if impossible
60       */
61      public void setValue(Object value)
62          throws ModelException;
63  }