KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > pluto > om > common > PreferenceSet


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 javax.portlet.PreferencesValidator;
23
24 /**
25  * <P>
26  * This interface provides access to a set of <CODE>Preference</CODE> objects.
27  * </P>
28  * <P>
29  * This interface defines the model as known from the MVC pattern.
30  * Its purpose is to provide read access to the data stored in the model.
31  * </P>
32  */

33
34 public interface PreferenceSet extends org.apache.pluto.om.Model
35 {
36
37
38     /**
39      * Returns all elements of this set as iterator.
40      * The return value cannot be NULL.
41      *
42      * @return An iterator containing all preference objects
43      */

44     public java.util.Iterator JavaDoc iterator();
45
46     /**
47      * Returns the preference object of the given name.
48      * The return value may be NULL.
49      *
50      * @return the preference object
51      */

52     public Preference get(String JavaDoc name);
53  
54     /**
55      * Returns the PreferencesValidator for this preference set.
56      *
57      * @return the preferencesValidator object
58      */

59     public PreferencesValidator getPreferencesValidator();
60 }
61
Popular Tags