KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > jetspeed > om > profile > ConfigElement


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.profile;
18
19 import java.util.Iterator JavaDoc;
20
21 /**
22  * ConfigElement is the base interface that objects must implement in order
23  * to be used with the Profile service.
24  *
25  * @author <a HREF="mailto:raphael@apache.org">RaphaŽl Luta</a>
26  * @author <a HREF="mailto:taylor@apache.org">David Sean Taylor</a>
27  * @version $Id: ConfigElement.java,v 1.5 2004/02/23 03:05:01 jford Exp $
28  */

29 public interface ConfigElement extends Cloneable JavaDoc
30 {
31
32     /**
33      * @return the name of this entry. This value is guaranteed to be unique at
34      * least within the current Document.
35      */

36     public String JavaDoc getName();
37
38     /**
39      * Changes the name of this entry
40      * @param name the new name for this entry
41      */

42     public void setName(String JavaDoc name);
43     
44     public String JavaDoc getParameterValue(String JavaDoc name);
45
46     public Parameter getParameter(String JavaDoc name);
47
48     public Iterator JavaDoc getParameterIterator();
49
50     public Parameter getParameter(int index)
51         throws java.lang.IndexOutOfBoundsException JavaDoc;
52
53     public int getParameterCount();
54
55     public void removeAllParameter();
56
57     public Parameter removeParameter(int index);
58
59     public void setParameter(int index, Parameter vParameter)
60         throws java.lang.IndexOutOfBoundsException JavaDoc;
61
62     public Parameter[] getParameter();
63
64     public void addParameter(Parameter vParameter)
65         throws java.lang.IndexOutOfBoundsException JavaDoc;
66
67     /**
68      * Create a clone of this object
69      */

70     public Object JavaDoc clone()
71         throws java.lang.CloneNotSupportedException JavaDoc;
72 }
73
Popular Tags