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  package org.apache.jetspeed.om.preference;
18  
19  import java.util.List;
20  
21  /***
22   * This interface represents a fragment preference used to populate
23   * portlet user preferences on initial access.
24   *
25   * @version $Id$
26   */
27  public interface FragmentPreference
28  {
29      /***
30       * getName
31       *
32       * @return preference name
33       */
34      String getName();
35      
36      /***
37       * setName
38       *
39       * @param name preference name
40       */
41      void setName(String name);
42      
43      /***
44       * isReadOnly
45       *
46       * @return read only preference flag
47       */
48      boolean isReadOnly();
49      
50      /***
51       * setReadOnly
52       *
53       * @param readOnly read only preference flag
54       */
55      void setReadOnly(boolean readOnly);
56      
57      /***
58       * getValueList
59       *
60       * @return list of String preference values
61       */
62      List getValueList();
63      
64      /***
65       * setValueList
66       *
67       * @param values list of String preference values
68       */
69      void setValueList(List values);
70  }