org.apache.jetspeed.om.profile.psml
Class PsmlPortlets

java.lang.Object
  org.apache.jetspeed.om.profile.psml.PsmlConfigElement
      org.apache.jetspeed.om.profile.psml.PsmlIdentityElement
          org.apache.jetspeed.om.profile.psml.PsmlPortlets

All Implemented Interfaces:

java.lang.Cloneable, ConfigElement, IdentityElement, MetaInfo, Portlets, java.io.Serializable

Direct Known Subclasses:

PsmlReference

public class PsmlPortlets

extends PsmlIdentityElement

implements Portlets, java.io.Serializable

Base simple bean-like implementation of the Portlets interface suitable for Castor XML serialization.

Version:

$Id: PsmlPortlets.java,v 1.11 2004/02/23 03:02:54 jford Exp $

Author:

David Sean Taylor

See Also:

Serialized Form

Constructor Summary

PsmlPortlets()

Method Summary

void	addEntry(Entry entry)
void	addPortlets(Portlets p)
void	addPortlets(PsmlPortlets p)
void	addReference(PsmlReference ref)
void	addReference(Reference ref)
java.lang.Object	clone() Create a clone of this object
Controller	getController()
java.util.Vector	getEntries()
Entry[]	getEntriesArray()
java.util.Iterator	getEntriesIterator()
Entry	getEntry(int index)
int	getEntryCount()
Portlets	getParentPortlets() Returns the parent.
java.util.Vector	getPortlets() Return a list of portlet.
Portlets	getPortlets(int index)
Portlets[]	getPortletsArray()
int	getPortletsCount()
java.util.Iterator	getPortletsIterator()
Reference	getReference(int index)
Reference[]	getReferenceArray()
int	getReferenceCount()
java.util.Iterator	getReferenceIterator()
java.util.Vector	getReferences()
Security	getSecurity()
SecurityReference	getSecurityRef() Getter for property securityRef.
Entry	removeEntry(int index)
Portlets	removePortlets(int index)
Reference	removeReference(int index)
void	setController(Controller controller)
void	setEntries(java.util.Vector entries)
void	setParentPortlets(Portlets parent) Sets the parent.
void	setPortlets(java.util.Vector portlets)
void	setSecurity(Security security)
void	setSecurityRef(SecurityReference securityRef) Setter for property securityRef.

Methods inherited from class org.apache.jetspeed.om.profile.psml.PsmlIdentityElement

getControl, getDescription, getId, getImage, getLayout, getMetaInfo, getSkin, getTitle, setControl, setDescription, setId, setImage, setLayout, setMetaInfo, setSkin, setTitle

Methods inherited from class org.apache.jetspeed.om.profile.psml.PsmlConfigElement

addParameter, getName, getParameter, getParameter, getParameter, getParameterCount, getParameterIterator, getParameters, getParameterValue, removeAllParameter, removeParameter, setName, setParameter, setParameters

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.jetspeed.om.profile.IdentityElement

getControl, getId, getLayout, getMetaInfo, getSkin, setControl, setId, setLayout, setMetaInfo, setSkin

Methods inherited from interface org.apache.jetspeed.om.profile.MetaInfo

getDescription, getImage, getTitle, setDescription, setImage, setTitle

Methods inherited from interface org.apache.jetspeed.om.profile.ConfigElement

addParameter, getName, getParameter, getParameter, getParameter, getParameterCount, getParameterIterator, getParameterValue, removeAllParameter, removeParameter, setName, setParameter

Constructor Detail

PsmlPortlets

public PsmlPortlets()

Method Detail

getController

public Controller getController()

Specified by:

getController in interface Portlets

Overrides:

getController in class PsmlIdentityElement

setController

public void setController(Controller controller)

Specified by:

setController in interface Portlets

Overrides:

setController in class PsmlIdentityElement

setSecurity

public void setSecurity(Security security)

Specified by:

setSecurity in interface Portlets

getSecurity

public Security getSecurity()

Specified by:

getSecurity in interface Portlets

getEntries

public java.util.Vector getEntries()

setEntries

public void setEntries(java.util.Vector entries)

getPortlets

public java.util.Vector getPortlets()

Return a list of portlet. Portlets that where added via a reference, see addReference(), are excluded.

Returns:

Vector of portlet

setPortlets

public void setPortlets(java.util.Vector portlets)

getReferences

public java.util.Vector getReferences()

addPortlets

public void addPortlets(PsmlPortlets p)

addReference

public void addReference(PsmlReference ref)

addReference

public void addReference(Reference ref)
                  throws java.lang.IndexOutOfBoundsException

Specified by:

addReference in interface Portlets

Throws:

java.lang.IndexOutOfBoundsException

getEntryCount

public int getEntryCount()

Specified by:

getEntryCount in interface Portlets

getReferenceCount

public int getReferenceCount()

Specified by:

getReferenceCount in interface Portlets

getPortletsCount

public int getPortletsCount()

Specified by:

getPortletsCount in interface Portlets

removeEntry

public Entry removeEntry(int index)

Specified by:

removeEntry in interface Portlets

removePortlets

public Portlets removePortlets(int index)

Specified by:

removePortlets in interface Portlets

removeReference

public Reference removeReference(int index)

Specified by:

removeReference in interface Portlets

getEntry

public Entry getEntry(int index)
               throws java.lang.IndexOutOfBoundsException

Specified by:

getEntry in interface Portlets

Throws:

java.lang.IndexOutOfBoundsException

getPortlets

public Portlets getPortlets(int index)
                     throws java.lang.IndexOutOfBoundsException

Specified by:

getPortlets in interface Portlets

Throws:

java.lang.IndexOutOfBoundsException

getReference

public Reference getReference(int index)
                       throws java.lang.IndexOutOfBoundsException

Specified by:

getReference in interface Portlets

Throws:

java.lang.IndexOutOfBoundsException

getEntriesIterator

public java.util.Iterator getEntriesIterator()

Specified by:

getEntriesIterator in interface Portlets

getPortletsIterator

public java.util.Iterator getPortletsIterator()

Specified by:

getPortletsIterator in interface Portlets

getReferenceIterator

public java.util.Iterator getReferenceIterator()

Specified by:

getReferenceIterator in interface Portlets

addEntry

public void addEntry(Entry entry)
              throws java.lang.IndexOutOfBoundsException

Specified by:

addEntry in interface Portlets

Throws:

java.lang.IndexOutOfBoundsException

addPortlets

public void addPortlets(Portlets p)
                 throws java.lang.IndexOutOfBoundsException

Specified by:

addPortlets in interface Portlets

Throws:

java.lang.IndexOutOfBoundsException

getEntriesArray

public Entry[] getEntriesArray()

Specified by:

getEntriesArray in interface Portlets

getPortletsArray

public Portlets[] getPortletsArray()

Specified by:

getPortletsArray in interface Portlets

getReferenceArray

public Reference[] getReferenceArray()

Specified by:

getReferenceArray in interface Portlets

getSecurityRef

public SecurityReference getSecurityRef()

Getter for property securityRef.

Specified by:

getSecurityRef in interface Portlets

Returns:

Value of property securityRef.

setSecurityRef

public void setSecurityRef(SecurityReference securityRef)

Setter for property securityRef.

Specified by:

setSecurityRef in interface Portlets

Parameters:

securityRef - New value of property securityRef.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Create a clone of this object

Specified by:

clone in interface MetaInfo

Overrides:

clone in class PsmlIdentityElement

Throws:

java.lang.CloneNotSupportedException

getParentPortlets

public Portlets getParentPortlets()

Returns the parent.

Specified by:

getParentPortlets in interface Portlets

Returns:

Portlets

setParentPortlets

public void setParentPortlets(Portlets parent)

Sets the parent.

Specified by:

setParentPortlets in interface Portlets

Parameters:

parent - The parent to set