View Javadoc

1   /*
2    * Copyright 2000-2001,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  package org.apache.jetspeed.om.registry;
18  
19  import java.util.Iterator;
20  import java.util.Map;
21  
22  /***
23   * The SkinEntry defines the properties used for storing a Skin description in
24   * the registry
25   * 
26   * @author <a href="mailto:raphael@apache.org">RaphaŽl Luta</a>
27   * @version $Id: SkinEntry.java,v 1.2 2004/02/23 03:11:39 jford Exp $
28   */
29  public interface SkinEntry extends RegistryEntry
30  {
31  
32      /*** @return an enumeration of this entry parameter names */
33      public Iterator getParameterNames();
34      
35      /*** Returns a map of parameter values keyed on the parameter names 
36       *  @return the parameter values map
37       */
38      public Map getParameterMap();
39  
40      /*** Search for a named parameter and return the associated
41       *  parameter object. The search is case sensitive.
42       *
43       *  @return the parameter object for a given parameter name
44       *  @param name the parameter name to look for
45       */
46      public Parameter getParameter( String name );
47          
48      /*** Adds a new parameter for this entry
49       *  @param name the new parameter name
50       *  @param value the new parameter value
51       */
52      public void addParameter( String name, String value );
53  
54      /*** Adds a new parameter for this entry
55       *  @param parameter the new parameter to add
56       */
57      public void addParameter( Parameter parameter );
58  
59      /*** Removes all parameter values associated with the
60       *  name
61       *
62       * @param name the parameter name to remove
63       */
64      public void removeParameter( String name );
65          
66  }