org.apache.pluto.driver.services.portal
Class PortletWindowConfig

java.lang.Object
  extended by org.apache.pluto.driver.services.portal.PortletWindowConfig

public class PortletWindowConfig
extends java.lang.Object

Configuration of a portlet window on the portal page.


Constructor Summary
PortletWindowConfig()
          No-arg constructor.
 
Method Summary
static java.lang.String createPortletId(java.lang.String contextPath, java.lang.String portletName, java.lang.String metaInfo)
          Creates the portlet ID from context path and portlet name.
static PortletWindowConfig fromId(java.lang.String portletWindowId)
           
 java.lang.String getContextPath()
           
 java.lang.String getId()
           
 java.lang.String getMetaInfo()
           
 java.lang.String getPortletName()
           
static java.lang.String parseContextPath(java.lang.String portletId)
          Parses out the portlet context path from the portlet ID.
static java.lang.String parseMetaInfo(java.lang.String portletId)
           
static java.lang.String parsePortletName(java.lang.String portletId)
          Parses out the portlet context path from the portlet ID.
 void setContextPath(java.lang.String contextPath)
           
 void setMetaInfo(java.lang.String metaInfo)
           
 void setPortletName(java.lang.String portletName)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortletWindowConfig

public PortletWindowConfig()
No-arg constructor.

Method Detail

getId

public java.lang.String getId()

getContextPath

public java.lang.String getContextPath()

setContextPath

public void setContextPath(java.lang.String contextPath)

getPortletName

public java.lang.String getPortletName()

setPortletName

public void setPortletName(java.lang.String portletName)

getMetaInfo

public java.lang.String getMetaInfo()

setMetaInfo

public void setMetaInfo(java.lang.String metaInfo)

createPortletId

public static java.lang.String createPortletId(java.lang.String contextPath,
                                               java.lang.String portletName,
                                               java.lang.String metaInfo)
                                        throws java.lang.NullPointerException,
                                               java.lang.IllegalArgumentException
Creates the portlet ID from context path and portlet name. The portlet ID is constructed by concatinating the context path and the portlet name using a dot ('.'). The method checks that the portlet name parameter does not have a dot. This check is not done for the portlet ID.

Parameters:
contextPath - the portlet context path.
portletName - the portlet name.
Throws:
java.lang.IllegalArgumentException - if the portletName has a dot
java.lang.NullPointerException - if the portlet Name or context path is null.

parseContextPath

public static java.lang.String parseContextPath(java.lang.String portletId)
Parses out the portlet context path from the portlet ID.

Parameters:
portletId - the portlet ID to parse.
Returns:
the portlet context path.

parsePortletName

public static java.lang.String parsePortletName(java.lang.String portletId)
Parses out the portlet context path from the portlet ID.

Parameters:
portletId - the portlet ID to parse.
Returns:
the portlet context path.

parseMetaInfo

public static java.lang.String parseMetaInfo(java.lang.String portletId)

fromId

public static PortletWindowConfig fromId(java.lang.String portletWindowId)


Copyright © 2003-2010 Apache Software Foundation. All Rights Reserved.