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  /***
23   * <P>
24   * The <CODE>Preference</CODE> interface provides access to a preference and its attributes.
25   * </P>
26   * <P>
27   * This interface defines the model as known from the MVC pattern.
28   * Its purpose is to provide read access to the data stored in the model.
29   * </P>
30   * 
31  
32   */
33  public interface Preference extends org.apache.pluto.om.Model
34  {
35  
36  
37      /***
38       * Returns the name
39       * 
40       * @return the name
41       */
42      public String getName();
43  
44      /***
45       * Returns the values in a readonly collection
46       * 
47       * @return the values
48       */
49      public java.util.Iterator getValues();
50  
51      /***
52       * Returns whether this preference is modifiable
53       * 
54       * @return true, if this preference is modifiable
55       */
56      public boolean isReadOnly();
57      
58      /***
59       * Returns whether this preference is set or not
60       *              
61       * @return <code>true</code>, if this preference is set
62       */
63      public boolean isValueSet();
64  }