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>ParameterSetCtrl</CODE> interface  ...
25   * </P>
26   * <P>
27   * This interface defines the controller as known from the MVC pattern.
28   * Its purpose is to provide write access to the data stored in the model.
29   * </P>
30   * 
31  
32   */
33  
34  public interface ParameterSetCtrl extends org.apache.pluto.om.Controller
35  {
36  
37  
38      /***
39       * Creates a new parameter and adds it to the set
40       * 
41       * @param name   the name of the new parameter
42       * @param value  the value of the new parameter
43       * 
44       * @return the new parameter
45       */
46      public Parameter add(String name, String value);
47  
48      /***
49       * Removes the parameter with the given name
50       * from the set
51       * 
52       * @param name   the name of the parameter to be removed
53       * 
54       * @return the removed parameter
55       */
56      public Parameter remove(String name);
57  
58      /***
59       * Removes the given parameter from the set
60       * 
61       * @param parameter the parameter to be removed
62       */
63      public void remove(Parameter parameter);
64  
65  }