View Javadoc

1   /*
2    * Copyright 2003,2004 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  
18   */
19  
20  package org.apache.pluto.om.common;
21  
22  import java.util.Locale;
23  
24  /***
25   * <P>
26   * The <CODE>DescriptionSet</CODE> interface represents all localized texts
27   * for one description.
28   * </P>
29   * <P>
30   * This interface defines the model as known from the MVC pattern.
31   * Its purpose is to provide read access to the data stored in the model.
32   * </P>
33   * 
34   */
35  
36  public interface DescriptionSet extends org.apache.pluto.om.Model
37  {
38  
39  
40      /***
41       * Returns the elements of this set
42       * 
43       * @return An iterator containg all elements of type Description
44       */
45      public java.util.Iterator iterator();
46  
47      /***
48       * Returns the description for the given locale
49       * 
50       * @return the localized description
51       */
52      public Description get(Locale locale);
53  
54  }