View Javadoc

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