org.apache.jetspeed.om.profile
Interface ConfigElement

All Superinterfaces:
java.lang.Cloneable
All Known Subinterfaces:
Control, Controller, Entry, IdentityElement, Layout, Portlets, Reference, Skin
All Known Implementing Classes:
PsmlConfigElement, PsmlControl, PsmlController, PsmlEntry, PsmlIdentityElement, PsmlLayout, PsmlPortlets, PsmlReference, PsmlSkin

public interface ConfigElement
extends java.lang.Cloneable

ConfigElement is the base interface that objects must implement in order to be used with the Profile service.

Version:
$Id: ConfigElement.java,v 1.6 2005/03/21 18:21:36 sgala Exp $
Author:
RaphaŽl Luta, David Sean Taylor

Method Summary
 void addParameter(Parameter vParameter)
           
 java.lang.Object clone()
          Create a clone of this object
 java.lang.String getName()
           
 Parameter[] getParameter()
           
 Parameter getParameter(int index)
           
 Parameter getParameter(java.lang.String name)
           
 int getParameterCount()
           
 java.util.Iterator getParameterIterator()
           
 java.lang.String getParameterValue(java.lang.String name)
           
 void removeAllParameter()
           
 Parameter removeParameter(int index)
           
 void setName(java.lang.String name)
          Changes the name of this entry
 void setParameter(int index, Parameter vParameter)
           
 

Method Detail

getName

public java.lang.String getName()
Returns:
the name of this entry. This value is guaranteed to be unique at least within the current Document.

setName

public void setName(java.lang.String name)
Changes the name of this entry

Parameters:
name - the new name for this entry

getParameterValue

public java.lang.String getParameterValue(java.lang.String name)

getParameter

public Parameter getParameter(java.lang.String name)

getParameterIterator

public java.util.Iterator getParameterIterator()

getParameter

public Parameter getParameter(int index)
                       throws java.lang.IndexOutOfBoundsException
Throws:
java.lang.IndexOutOfBoundsException

getParameterCount

public int getParameterCount()

removeAllParameter

public void removeAllParameter()

removeParameter

public Parameter removeParameter(int index)

setParameter

public void setParameter(int index,
                         Parameter vParameter)
                  throws java.lang.IndexOutOfBoundsException
Throws:
java.lang.IndexOutOfBoundsException

getParameter

public Parameter[] getParameter()

addParameter

public void addParameter(Parameter vParameter)
                  throws java.lang.IndexOutOfBoundsException
Throws:
java.lang.IndexOutOfBoundsException

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException
Create a clone of this object

Throws:
java.lang.CloneNotSupportedException


Copyright © 2000-2005 Apache Software Foundation. All Rights Reserved.