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