org.rhq.enterprise.gui.legacy
Class Portal

java.lang.Object
  org.rhq.enterprise.gui.legacy.Portal

public class Portal
extends Object

A class representing an individual page layout.

Constructor Summary

Portal()

Method Summary

void	addPortlet(Portlet portlet, int column) adds a single portlet to the column number provided
void	addPortletColumn(List definitions) Add a column of portlets to the portal.
void	addPortlets(List definitions) Attach a list of portlets to the first column of the portal.
void	addPortlets(List definitions, int column) Attach a list of portlets to the indicated column of the portal.
void	addPortletsFromString(String stringList, int column)
static Portal	createPortal() Create and return a new instance.
static Portal	createPortal(String portalName, String portletName) Create and return a new named instance with a portlet in the first column.
boolean	doWorkflow() Participate in workflow in the following circumstances: dialog isWorkflowPortal participate 0 0 1 0 1 0 1 0 0 1 1 1
int	getColumns()
String	getDescription()
String	getName()
List	getPortlets()
Map	getWorkflowParams()
boolean	isDialog()
boolean	isWorkflowPortal() Getter for property workflowPortal.
void	setColumns(int columns)
void	setColumns(String numCols)
void	setDescription(String description)
void	setDialog(boolean dialog)
void	setDialog(String dialog)
void	setName(String name)
void	setPortlets(List portlets)
void	setWorkflowParams(Map m)
void	setWorkflowPortal(boolean workflowPortal)
void	setWorkflowPortal(String workflowPortal)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Portal

public Portal()

Method Detail

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getColumns

public int getColumns()

setColumns

public void setColumns(int columns)

setColumns

public void setColumns(String numCols)

getPortlets

public List getPortlets()

setPortlets

public void setPortlets(List portlets)

addPortlet

public void addPortlet(Portlet portlet,
                       int column)

adds a single portlet to the column number provided

addPortlets

public void addPortlets(List definitions)

Attach a list of portlets to the first column of the portal.

Parameters:

definitions - the List of either Portlet instances or String instances representing portlet definitions

addPortlets

public void addPortlets(List definitions,
                        int column)

Attach a list of portlets to the indicated column of the portal.

Parameters:

definitions - the List of either Portlet instances or String instances representing portlet definitions

column - the column (1-based) to which the portlets are added

addPortletColumn

public void addPortletColumn(List definitions)

Add a column of portlets to the portal. A new column will be created, rather than adding the portlets to an existing column.

Parameters:

definitions - the List of either Portlet instances or String instances representing portlet definitions

toString

public String toString()

Overrides:

toString in class Object

isDialog

public boolean isDialog()

setDialog

public void setDialog(boolean dialog)

setDialog

public void setDialog(String dialog)

isWorkflowPortal

public boolean isWorkflowPortal()

Getter for property workflowPortal. If you wish to explictly set this screen as part of a workflow, set this to true in your controller action.

Returns:

Value of property workflowPortal.

setWorkflowPortal

public void setWorkflowPortal(boolean workflowPortal)

setWorkflowPortal

public void setWorkflowPortal(String workflowPortal)

getWorkflowParams

public Map getWorkflowParams()

setWorkflowParams

public void setWorkflowParams(Map m)

createPortal

public static Portal createPortal()

Create and return a new instance.

createPortal

public static Portal createPortal(String portalName,
                                  String portletName)

Create and return a new named instance with a portlet in the first column.

Parameters:

portalName - the portal name

portletName - the portlet definition name

addPortletsFromString

public void addPortletsFromString(String stringList,
                                  int column)

doWorkflow

public boolean doWorkflow()

Participate in workflow in the following circumstances: dialog isWorkflowPortal participate 0 0 1 0 1 0 1 0 0 1 1 1