|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface PortletCategoryDefinitionControl
A custom control interface used to interact with portlet categories.
Method Summary | |
---|---|
void |
addPortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId portletId,
com.bea.netuix.application.identifier.PortletCategoryDefinitionId categoryId,
com.bea.portal.tools.common.ResourceContext context)
Adds a PortletDefinitionId to a portlet category. |
com.bea.netuix.application.definition.PortletCategoryDefinition |
createCategory(String title,
String description,
com.bea.netuix.application.identifier.PortletCategoryDefinitionId parentId,
String webAppName,
com.bea.portal.tools.common.ResourceContext context)
Creates a persistent version of a PortletCategoryDefinition
from the provided PortletCategoryDefinition . |
com.bea.netuix.application.definition.PortletCategoryDefinition |
createRootCategory(String rootCategoryTitle,
String rootCategoryDescription,
String webAppName,
com.bea.portal.tools.common.ResourceContext context)
Creates and returns a ROOT category |
int |
deleteCategory(com.bea.netuix.application.identifier.PortletCategoryDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Deletes all (including localized) versions of a category. |
void |
deletePortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId portletId,
com.bea.netuix.application.identifier.PortletCategoryDefinitionId categoryId,
com.bea.portal.tools.common.ResourceContext context)
Deletes a PortletDefinitionId from a portlet category. |
int |
deletePortletDefinitions(com.bea.netuix.application.identifier.PortletDefinitionId portletId,
com.bea.portal.tools.common.ResourceContext context)
Deletes a PortletDefinitionId from all portlet categories. |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletCategoryDefinition> |
getCategories(int pageSize,
com.bea.netuix.application.search.WebAppSearchCriteria criteria,
com.bea.portal.tools.common.ResourceContext context)
Returns a SortableFilterablePagedResult of PortletCategoryDefinition s corresponding
to an array of PortletCategoryDefinitionId s. |
com.bea.netuix.application.definition.PortletCategoryDefinition |
getCategory(com.bea.netuix.application.identifier.PortletCategoryDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Returns a PortletCategoryDefinition corresponding to a
PortletCategoryDefinitionId . |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletDefinition> |
getNonCategorizedPortletDefinitions(int pageSize,
com.bea.netuix.application.search.WebAppSearchCriteria criteria,
com.bea.portal.tools.common.ResourceContext context)
Returns noncategorized PortletDefinition s. |
int |
getPortletDefinitionCount(com.bea.netuix.application.identifier.PortletCategoryDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Returns the number of PortletDefinition s under category
pcdId . |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletDefinition> |
getPortletDefinitions(int pageSize,
com.bea.netuix.application.identifier.PortletCategoryDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Returns PortletDefinition s under the category pcdId . |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.view.PortletView> |
getPortletViews(int pageSize,
com.bea.netuix.application.identifier.PortletCategoryDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Returns PortletView s. |
com.bea.netuix.application.definition.PortletCategoryDefinition |
getRootCategory(String webAppName,
com.bea.portal.tools.common.ResourceContext context)
Returns root of the PortletCategory hierarchy. |
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletCategoryDefinition> |
getSubCategories(int pageSize,
com.bea.netuix.application.identifier.PortletCategoryDefinitionId id,
com.bea.netuix.application.search.WebAppSearchCriteria criteria,
com.bea.portal.tools.common.ResourceContext context)
Returns a SortableFilterablePagedResult of PorletCategoryDefinition s for
subcategories of the category represented by pcdId
If no definitions are found an empty SortableFilterablePagedResult is returned.Implementation has to ensure that repeated calls to this method return PortletCategoryDefinition s in a consistent
order. |
int |
getSubCategoryCount(com.bea.netuix.application.identifier.PortletCategoryDefinitionId id,
com.bea.portal.tools.common.ResourceContext context)
Returns the number of immediate categories under category pcdId . |
Method Detail |
---|
com.bea.netuix.application.definition.PortletCategoryDefinition createRootCategory(String rootCategoryTitle, String rootCategoryDescription, String webAppName, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.MissingDataException, com.bea.netuix.application.exception.ObjectNotFoundException
rootCategoryTitle
- rootCategoryDescription
- webAppName
- context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.MissingDataException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.netuix.application.definition.PortletCategoryDefinition getRootCategory(String webAppName, com.bea.portal.tools.common.ResourceContext context) throws com.bea.netuix.application.exception.ObjectNotFoundException, com.bea.portal.tools.common.exceptions.ToolsException
webAppName
- context
- the resource context.
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.definition.PortletCategoryDefinition getCategory(com.bea.netuix.application.identifier.PortletCategoryDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.ObjectNotFoundException
PortletCategoryDefinition
corresponding to a
PortletCategoryDefinitionId
.
id
- the portlet category definition id.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.ObjectNotFoundException
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletCategoryDefinition> getCategories(int pageSize, com.bea.netuix.application.search.WebAppSearchCriteria criteria, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.ObjectNotFoundException
PortletCategoryDefinition
s corresponding
to an array of PortletCategoryDefinitionId
s.
pageSize
- the number of entries per page of the SortableFilterablePagedResult
criteria
- the search criteria, including the web app namecontext
- the resource context.
pageSize
entries.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.ObjectNotFoundException
int getSubCategoryCount(com.bea.netuix.application.identifier.PortletCategoryDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
pcdId
.
id
- the portlet category definition id.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletCategoryDefinition> getSubCategories(int pageSize, com.bea.netuix.application.identifier.PortletCategoryDefinitionId id, com.bea.netuix.application.search.WebAppSearchCriteria criteria, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.ObjectNotFoundException
PorletCategoryDefinition
s for
subcategories of the category represented by pcdId
If no definitions are found an empty SortableFilterablePagedResult is returned.PortletCategoryDefinition
s in a consistent
order.
pageSize
- the number of entries per page of the SortableFilterablePagedResult
id
- the portlet category definition id.criteria
- the search criteria, including the web app namecontext
- the resource context.
pageSize
entries.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.ObjectNotFoundException
int getPortletDefinitionCount(com.bea.netuix.application.identifier.PortletCategoryDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
PortletDefinition
s under category
pcdId
.
id
- the portlet category definition id.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletDefinition> getPortletDefinitions(int pageSize, com.bea.netuix.application.identifier.PortletCategoryDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
PortletDefinition
s under the category pcdId
.
If no definitions are found an empty SortableFilterablePagedResult is returned.PortletDefinition
s.PortletDefinition
s in a consistent
order.
pageSize
- the number of entries per page of the SortableFilterablePagedResult
id
- the portlet category definition id.context
- the resource context.
pageSize
entries.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.view.PortletView> getPortletViews(int pageSize, com.bea.netuix.application.identifier.PortletCategoryDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.ObjectNotFoundException
PortletView
s.
If no views are found an empty SortableFilterablePagedResult is returned.PortletDefinition
s.PortletView
s in a consistent
order.
pageSize
- the number of entries per page of the SortableFilterablePagedResult
id
- the portlet category definition id.context
- the resource context.
pageSize
entries.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.ObjectNotFoundException
void addPortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId portletId, com.bea.netuix.application.identifier.PortletCategoryDefinitionId categoryId, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException
PortletDefinitionId
to a portlet category.
portletId
- portlet definition id.categoryId
- portlet category definition id.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
void deletePortletDefinition(com.bea.netuix.application.identifier.PortletDefinitionId portletId, com.bea.netuix.application.identifier.PortletCategoryDefinitionId categoryId, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException
PortletDefinitionId
from a portlet category.
portletId
- portlet definition id.categoryId
- portlet category definition id.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
int deletePortletDefinitions(com.bea.netuix.application.identifier.PortletDefinitionId portletId, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException
PortletDefinitionId
from all portlet categories.
portletId
- portlet definition id.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.p13n.pagination.SortableFilterablePagedResult<com.bea.netuix.application.definition.PortletDefinition> getNonCategorizedPortletDefinitions(int pageSize, com.bea.netuix.application.search.WebAppSearchCriteria criteria, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException
PortletDefinition
s.
If no definitions are found an empty SortableFilterablePagedResult is returned.PortletDefinition
s.PortletDefinition
s in a consistent
order.
pageSize
- the number of entries per page of the SortableFilterablePagedResult
criteria
- the criteria for the search, including web app name.context
- the resource context.
pageSize
entries.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.definition.PortletCategoryDefinition createCategory(String title, String description, com.bea.netuix.application.identifier.PortletCategoryDefinitionId parentId, String webAppName, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.MissingDataException, com.bea.netuix.application.exception.ObjectNotFoundException
PortletCategoryDefinition
from the provided PortletCategoryDefinition
.
title
- description
- parentId
- parent category definition id.webAppName
- context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.MissingDataException
com.bea.netuix.application.exception.ObjectNotFoundException
int deleteCategory(com.bea.netuix.application.identifier.PortletCategoryDefinitionId id, com.bea.portal.tools.common.ResourceContext context) throws com.bea.portal.tools.common.exceptions.ToolsException, com.bea.netuix.application.exception.NotEntitledException, com.bea.netuix.application.exception.ObjectNotFoundException
ResourceContext
via the setWebApp() method, otherwise
a NoWebAppFoundException
is thrown.
id
- the category definition id.context
- the resource context.
com.bea.portal.tools.common.exceptions.ToolsException
com.bea.netuix.application.exception.NotEntitledException
com.bea.netuix.application.exception.ObjectNotFoundException
|
Copyright © 2006 BEA Systems, Inc. All Rights Reserved | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |