|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ControlInterface public interface PortletCategoryDefinitionControl
A custom control interface used to interact with portlet categories.
Method Summary | |
---|---|
void |
addPortletDefinition(PortletDefinitionId portletId,
PortletCategoryDefinitionId categoryId,
ResourceContext context)
Adds a PortletDefinitionId to a portlet category. |
PortletCategoryDefinition |
createCategory(String title,
String description,
PortletCategoryDefinitionId parentId,
String webAppName,
ResourceContext context)
Creates a persistent version of a PortletCategoryDefinition
from the provided PortletCategoryDefinition . |
PortletCategoryDefinition |
createRootCategory(String rootCategoryTitle,
String rootCategoryDescription,
String webAppName,
ResourceContext context)
Creates and returns a ROOT category |
int |
deleteCategory(PortletCategoryDefinitionId id,
ResourceContext context)
Deletes all (including localized) versions of a category. |
void |
deletePortletDefinition(PortletDefinitionId portletId,
PortletCategoryDefinitionId categoryId,
ResourceContext context)
Deletes a PortletDefinitionId from a portlet category. |
int |
deletePortletDefinitions(PortletDefinitionId portletId,
ResourceContext context)
Deletes a PortletDefinitionId from all portlet categories. |
SortableFilterablePagedResult<PortletCategoryDefinition> |
getCategories(int pageSize,
WebAppSearchCriteria criteria,
ResourceContext context)
Returns a SortableFilterablePagedResult of PortletCategoryDefinition s corresponding
to an array of PortletCategoryDefinitionId s. |
PortletCategoryDefinition |
getCategory(PortletCategoryDefinitionId id,
ResourceContext context)
Returns a PortletCategoryDefinition corresponding to a
PortletCategoryDefinitionId . |
SortableFilterablePagedResult<PortletDefinition> |
getNonCategorizedPortletDefinitions(int pageSize,
WebAppSearchCriteria criteria,
ResourceContext context)
Returns noncategorized PortletDefinition s. |
int |
getPortletDefinitionCount(PortletCategoryDefinitionId id,
ResourceContext context)
Returns the number of PortletDefinition s under category
pcdId . |
SortableFilterablePagedResult<PortletDefinition> |
getPortletDefinitions(int pageSize,
PortletCategoryDefinitionId id,
ResourceContext context)
Returns PortletDefinition s under the category pcdId . |
SortableFilterablePagedResult<PortletView> |
getPortletViews(int pageSize,
PortletCategoryDefinitionId id,
ResourceContext context)
Returns PortletView s. |
PortletCategoryDefinition |
getRootCategory(String webAppName,
ResourceContext context)
Returns root of the PortletCategory hierarchy. |
SortableFilterablePagedResult<PortletCategoryDefinition> |
getSubCategories(int pageSize,
PortletCategoryDefinitionId id,
WebAppSearchCriteria criteria,
ResourceContext context)
Returns a SortableFilterablePagedResult of PortletCategoryDefinition 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(PortletCategoryDefinitionId id,
ResourceContext context)
Returns the number of immediate categories under category pcdId . |
Method Detail |
---|
PortletCategoryDefinition createRootCategory(String rootCategoryTitle, String rootCategoryDescription, String webAppName, ResourceContext context) throws ToolsException, NotEntitledException, MissingDataException, ObjectNotFoundException
rootCategoryTitle
- rootCategoryDescription
- webAppName
- context
- the resource context.
ToolsException
NotEntitledException
MissingDataException
ObjectNotFoundException
PortletCategoryDefinition getRootCategory(String webAppName, ResourceContext context) throws ObjectNotFoundException, ToolsException
webAppName
- context
- the resource context.
ObjectNotFoundException
ToolsException
PortletCategoryDefinition getCategory(PortletCategoryDefinitionId id, ResourceContext context) throws ToolsException, ObjectNotFoundException
PortletCategoryDefinition
corresponding to a
PortletCategoryDefinitionId
.
id
- the portlet category definition id.context
- the resource context.
ToolsException
ObjectNotFoundException
SortableFilterablePagedResult<PortletCategoryDefinition> getCategories(int pageSize, WebAppSearchCriteria criteria, ResourceContext context) throws ToolsException, 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.
ToolsException
ObjectNotFoundException
int getSubCategoryCount(PortletCategoryDefinitionId id, ResourceContext context) throws ToolsException
pcdId
.
id
- the portlet category definition id.context
- the resource context.
ToolsException
SortableFilterablePagedResult<PortletCategoryDefinition> getSubCategories(int pageSize, PortletCategoryDefinitionId id, WebAppSearchCriteria criteria, ResourceContext context) throws ToolsException, ObjectNotFoundException
PortletCategoryDefinition
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.
ToolsException
ObjectNotFoundException
int getPortletDefinitionCount(PortletCategoryDefinitionId id, ResourceContext context) throws ToolsException
PortletDefinition
s under category
pcdId
.
id
- the portlet category definition id.context
- the resource context.
ToolsException
SortableFilterablePagedResult<PortletDefinition> getPortletDefinitions(int pageSize, PortletCategoryDefinitionId id, ResourceContext context) throws 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.
ToolsException
SortableFilterablePagedResult<PortletView> getPortletViews(int pageSize, PortletCategoryDefinitionId id, ResourceContext context) throws ToolsException, 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.
ToolsException
ObjectNotFoundException
void addPortletDefinition(PortletDefinitionId portletId, PortletCategoryDefinitionId categoryId, ResourceContext context) throws ToolsException, NotEntitledException
PortletDefinitionId
to a portlet category.
portletId
- portlet definition id.categoryId
- portlet category definition id.context
- the resource context.
ToolsException
NotEntitledException
void deletePortletDefinition(PortletDefinitionId portletId, PortletCategoryDefinitionId categoryId, ResourceContext context) throws ToolsException, NotEntitledException
PortletDefinitionId
from a portlet category.
portletId
- portlet definition id.categoryId
- portlet category definition id.context
- the resource context.
ToolsException
NotEntitledException
int deletePortletDefinitions(PortletDefinitionId portletId, ResourceContext context) throws ToolsException, NotEntitledException
PortletDefinitionId
from all portlet categories.
portletId
- portlet definition id.context
- the resource context.
ToolsException
NotEntitledException
SortableFilterablePagedResult<PortletDefinition> getNonCategorizedPortletDefinitions(int pageSize, WebAppSearchCriteria criteria, ResourceContext context) throws 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.
ToolsException
PortletCategoryDefinition createCategory(String title, String description, PortletCategoryDefinitionId parentId, String webAppName, ResourceContext context) throws ToolsException, NotEntitledException, MissingDataException, ObjectNotFoundException
PortletCategoryDefinition
from the provided PortletCategoryDefinition
.
title
- description
- parentId
- parent category definition id.webAppName
- context
- the resource context.
ToolsException
NotEntitledException
MissingDataException
ObjectNotFoundException
int deleteCategory(PortletCategoryDefinitionId id, ResourceContext context) throws ToolsException, NotEntitledException, ObjectNotFoundException
ResourceContext
via the setWebApp() method, otherwise
a NoWebAppFoundException
is thrown.
id
- the category definition id.context
- the resource context.
ToolsException
NotEntitledException
ObjectNotFoundException
|
Oracle Fusion Middleware Java API for Oracle WebLogic Portal 10g Release 3 (10.3.4) E14255-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |