PortletCategoryDefinition Class

com.bea.netuix.application.definition
PortletCategoryDefinition Class

public class PortletCategoryDefinition

    extends Object
    implements CategoryDefinition

Provides a mechanism to categorize PortletDefinitions.


Hierarchy
Object
  PortletCategoryDefinition
All Implemented Interfaces

CategoryDefinition, Serializable

Field Summary

protected boolean
isRoot
boolean
 

Constructor Summary

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

PortletCategoryDefinition(PortletCategoryDefinitionId pid, LocalizationResource ld, String webAppName)

Ctor.
 

Method Summary

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

Field Detail

isRoot

protected boolean isRoot

 

Constructor Detail

PortletCategoryDefinition

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

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.

 

Method Detail

getLocalizationResource() Method

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

Returns

LocalizationResource

getParentId() Method

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

Returns

PortletCategoryDefinitionId for it's parent

getPortletCategoryDefinitionId() Method

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

Returns

PortletCategoryDefinitionId

getWebAppName() Method

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

Returns

web application name

isRoot() Method

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

Returns

true if this category is the root

setLocalizationResource(LocalizationResource) Method

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


setParentId(PortletCategoryDefinitionId) Method

public void setParentId(PortletCategoryDefinitionId pid)

setWebAppName(String) Method

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


toString() Method

public String toString()
Overrides
Object.toString()