Parameter


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   * This interface provides access to a parameter and its attributes.
27   * A parameter is defined in the web.xml or in the portlet.xml
28   * of a portlet application archive file.
29   * </P>
30   * <P>
31   * This interface defines the model as known from the MVC pattern.
32   * Its purpose is to provide read access to the data stored in the model.
33   * </P>
34   * 
35  
36   */
37  public interface Parameter extends org.apache.pluto.om.Model
38  {
39  
40  
41      /**
42       * Returns the name
43       * The return value cannot be NULL.
44       *  
45       * @return the name
46       */
47      public String   getName();
48  
49      /**
50       * Returns the value
51       * The return value may be NULL.
52       *  
53       * @return the value
54       */
55      public String   getValue();
56  
57      /**
58       * Returns the description for the given locale
59       * The return value may be NULL.
60       * 
61       * @return the localized description
62       */
63      public Description getDescription(Locale   locale);
64  
65  }
66
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags