org.apache.jetspeed.om.profile
Interface Portlets

All Superinterfaces:
java.lang.Cloneable, ConfigElement, IdentityElement, MetaInfo, java.io.Serializable
All Known Subinterfaces:
Reference
All Known Implementing Classes:
PsmlPortlets, PsmlReference

public interface Portlets
extends IdentityElement

Portlets is collection of portlet entries and other portlet sets within a configuration Document.

Version:
$Id: Portlets.java,v 1.7 2004/02/23 03:05:01 jford Exp $
Author:
David Sean Taylor

Method Summary
 void addEntry(Entry entry)
           
 void addPortlets(Portlets portlets)
           
 void addReference(Reference ref)
           
 Controller getController()
           
 Entry[] getEntriesArray()
           
 java.util.Iterator getEntriesIterator()
           
 Entry getEntry(int index)
           
 int getEntryCount()
           
 Portlets getParentPortlets()
           
 Portlets getPortlets(int index)
           
 Portlets[] getPortletsArray()
           
 int getPortletsCount()
           
 java.util.Iterator getPortletsIterator()
           
 Reference getReference(int index)
           
 Reference[] getReferenceArray()
           
 int getReferenceCount()
           
 java.util.Iterator getReferenceIterator()
           
 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 setParentPortlets(Portlets parent)
           
 void setSecurity(Security security)
           
 void setSecurityRef(SecurityReference securityRef)
          Setter for property securityRef.
 
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
clone, getDescription, getImage, getTitle, setDescription, setImage, setTitle
 
Methods inherited from interface org.apache.jetspeed.om.profile.ConfigElement
addParameter, clone, getName, getParameter, getParameter, getParameter, getParameterCount, getParameterIterator, getParameterValue, removeAllParameter, removeParameter, setName, setParameter
 

Method Detail

getController

public Controller getController()

setController

public void setController(Controller controller)

setSecurity

public void setSecurity(Security security)

getSecurity

public Security getSecurity()

getEntryCount

public int getEntryCount()

getPortletsCount

public int getPortletsCount()

getReferenceCount

public int getReferenceCount()

getPortlets

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

getEntry

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

getReference

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

removeEntry

public Entry removeEntry(int index)

removePortlets

public Portlets removePortlets(int index)

removeReference

public Reference removeReference(int index)

getEntriesIterator

public java.util.Iterator getEntriesIterator()

getPortletsIterator

public java.util.Iterator getPortletsIterator()

getReferenceIterator

public java.util.Iterator getReferenceIterator()

addEntry

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

addPortlets

public void addPortlets(Portlets portlets)
                 throws java.lang.IndexOutOfBoundsException
Throws:
java.lang.IndexOutOfBoundsException

addReference

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

getEntriesArray

public Entry[] getEntriesArray()

getPortletsArray

public Portlets[] getPortletsArray()

getReferenceArray

public Reference[] getReferenceArray()

getSecurityRef

public SecurityReference getSecurityRef()
Getter for property securityRef.

Returns:
Value of property securityRef.

setSecurityRef

public void setSecurityRef(SecurityReference securityRef)
Setter for property securityRef.

Parameters:
securityRef - New value of property securityRef.

getParentPortlets

public Portlets getParentPortlets()
Returns:
Portlets parent Portlets object for this Portlets collection null if it is the root.

setParentPortlets

public void setParentPortlets(Portlets parent)


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