© 2004 BEA Systems, Inc.

com.bea.netuix.application.definition
Class PortletCategoryDefinition

java.lang.Object
  extended bycom.bea.netuix.application.definition.PortletCategoryDefinition
All Implemented Interfaces:
CategoryDefinition, Serializable

public class PortletCategoryDefinition
extends Object
implements CategoryDefinition

Provides a mechanism to categorize PortletDefinitions.

See Also:
Serialized Form

Field Summary
protected  boolean isRoot
           
 
Constructor Summary
PortletCategoryDefinition(PortletCategoryDefinitionId pid, LocalizationResource ld, String webAppName)
          Ctor.
PortletCategoryDefinition(PortletCategoryDefinitionId pid, LocalizationResource ld, String webAppName, boolean isRoot)
           
 
Method Summary
 LocalizationResource getLocalizationResource()
          Returns the LocalizationResource associated with this CategoryDefinition.
 PortletCategoryDefinitionId getParentId()
          Returns the parent PortletCategoryDefinitionId for this PortletCategoryDefinition.
 PortletCategoryDefinitionId getPortletCategoryDefinitionId()
          Returns the PortletCategoryDefinitionId for the PortletCategoryDefinition.
 String getWebAppName()
          Returns the name of the J2EE web application this portlet category is scoped to.
 boolean isRoot()
          Determines if the category is a root category.
 void setLocalizationResource(LocalizationResource localizationResource)
          Sets LocalizationResource for this CategoryDefinition.
 void setParentId(PortletCategoryDefinitionId pid)
           
 void setWebAppName(String webAppName)
          Scopes this portlet category to given web application.
 String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

isRoot

protected boolean isRoot
Constructor Detail

PortletCategoryDefinition

public PortletCategoryDefinition(PortletCategoryDefinitionId pid,
                                 LocalizationResource ld,
                                 String webAppName)
Ctor.

When creating a PortletDefinition for the ROOT category the parent portlet category id can be set to null.

Parameters:
pid - PortletCategoryDefinitionId of parent portlet category
ld - LocalizationResource

PortletCategoryDefinition

public PortletCategoryDefinition(PortletCategoryDefinitionId pid,
                                 LocalizationResource ld,
                                 String webAppName,
                                 boolean isRoot)
Method Detail

getPortletCategoryDefinitionId

public PortletCategoryDefinitionId getPortletCategoryDefinitionId()
Returns the PortletCategoryDefinitionId for the PortletCategoryDefinition.

Returns:
PortletCategoryDefinitionId

getParentId

public PortletCategoryDefinitionId getParentId()
Returns the parent PortletCategoryDefinitionId for this PortletCategoryDefinition.

Returns:
PortletCategoryDefinitionId for it's parent

setParentId

public void setParentId(PortletCategoryDefinitionId pid)

getLocalizationResource

public LocalizationResource getLocalizationResource()
Returns the LocalizationResource associated with this CategoryDefinition.

Specified by:
getLocalizationResource in interface CategoryDefinition
Returns:
LocalizationResource

setLocalizationResource

public void setLocalizationResource(LocalizationResource localizationResource)
Sets LocalizationResource for this CategoryDefinition.

Specified by:
setLocalizationResource in interface CategoryDefinition
Parameters:
localizationResource -

isRoot

public boolean isRoot()
Determines if the category is a root category.

Specified by:
isRoot in interface CategoryDefinition
Returns:
true if this category is the root

getWebAppName

public String getWebAppName()
Returns the name of the J2EE web application this portlet category is scoped to.

Returns:
web application name

setWebAppName

public void setWebAppName(String webAppName)
Scopes this portlet category to given web application.

Parameters:
webAppName -

toString

public String toString()

© 2004 BEA Systems, Inc.

Copyright © 2004 BEA Systems, Inc. All Rights Reserved