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 JDOPackage instance represents the JDO package metadata.
23   *
24   * @author Michael Bouschen
25   */
26  public interface JDOPackage 
27      extends JDOElement
28  {
29      /***
30       * Returns the name of this JDOPackage.
31       * @return the name
32       */
33      public String getName();
34  
35      /***
36       * Sets the name of this JDOPackage.
37       * @param name the name
38       * @exception ModelException if impossible
39       */
40      public void setName(String name)
41          throws ModelException;
42  
43      /***
44       * Returns the declaring JDOModel of this JDOPackage.
45       * @return the JDOModel that owns this JDOPackage.
46       */
47      public JDOModel getDeclaringModel();
48  
49      /***
50       * Set the declaring JDOModel for this JDOPackage.
51       * @param model the declaring JDOModel of this JDOPackage.
52       */
53      public void setDeclaringModel(JDOModel model);
54  }