|
© 2005 BEA Systems, Inc. | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
Defines methods to manage a hierarchy of PortletDefinitions.
Assumes that the hierarchy is a top down tree with each category having
only one parent category. However, lets a PortletDefinition
reside under multiple categories. All calls are subject to entitlements
based filtering.
| Method Summary | |
void |
addPortletDefinition(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
PortletDefinitionId pdId)
Adds a PortletDefinitionId to a portlet category. |
PortletCategoryDefinition |
createCategory(CustomizationContext customizationContext,
PortletCategoryDefinition pcd)
Creates a persistent version of a PortletCategoryDefinition
from the provided PortletCategoryDefinition. |
PortletCategoryDefinition |
createRootCategory(CustomizationContext customizationContext,
PortletCategoryDefinition root)
Creates and returns a ROOT category |
int |
deleteCategory(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
Deletes all (including localized) versions of a category. |
void |
deletePortletDefinition(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
PortletDefinitionId pdId)
Deletes a PortletDefinitionId from a portlet category. |
int |
deletePortletDefinitions(CustomizationContext customizationContext,
PortletDefinitionId pdId)
Deletes a PortletDefinitionId from all portlet categories. |
PortletCategoryDefinitionId[] |
getAncestorIds(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
Returns an array of PortletCategoryDefinitionIds that
represent the ancestors of a category starting with the parent
category and ending with the root. |
PortletCategoryDefinition[] |
getAncestors(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
Returns an array of PortletCategoryDefinitions that
represent the ancestors of a category starting with the parent
category and ending with the root. |
PortletCategoryDefinition[] |
getCategories(CustomizationContext customizationContext,
PortletCategoryDefinitionId[] pcdId)
Returns an array of PortletCategoryDefinitions corresponding
to an array of PortletCategoryDefinitionIds. |
PortletCategoryDefinition |
getCategory(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
Returns a PortletCategoryDefinition corresponding to a
PortletCategoryDefinitionId. |
int |
getCategoryCount(CustomizationContext customizationContext,
String webAppName)
Returns the number of categories recursively starting with the root category. |
PortletCategoryDefinitionId[] |
getCategoryIds(CustomizationContext customizationContext,
int begin,
int end,
String webAppName)
Returns an array of PorletCategoryDefinitionIds in the
begin and end range. |
PortletCategoryView |
getCategoryView(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
Returns a PortletCategoryView corresponding to a
PortletCategoryDefinitionId. |
PortletCategoryView[] |
getCategoryViews(CustomizationContext customizationContext,
PortletCategoryDefinitionId[] pcdId)
Returns an array of PortletCategoryViews corresponding
to an array of PortletCategoryDefinitionIds. |
int |
getNonCategorizedPortletDefinitionCount(CustomizationContext customizationContext,
String webAppName)
Returns the number of PortletDefinitions that are
not included under any category. |
PortletDefinitionId[] |
getNonCategorizedPortletDefinitionIds(CustomizationContext customizationContext,
int begin,
int end,
String webAppName)
Returns noncategorized PortletDefinitionIds in the
begin and end range. |
PortletDefinition[] |
getNonCategorizedPortletDefinitions(CustomizationContext customizationContext,
int begin,
int end,
String webAppName)
Returns noncategorized PortletDefinitions in the
begin and end range. |
PortletView[] |
getNonCategorizedPortletViews(CustomizationContext customizationContext,
int begin,
int end,
String webAppName)
Returns noncategorized PortletViews in the
begin and end range. |
PortletCategoryDefinitionId[] |
getPortletDefinitionCategories(CustomizationContext customizationContext,
PortletDefinitionId pdId)
Returns all the PortletCategoryDefinitions that a
PortletDefinition is a part of. |
int |
getPortletDefinitionCount(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
Returns the number of PortletDefinitions under category
pcdId. |
PortletDefinition[] |
getPortletDefinitions(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
Returns PortletDefinitions in the begin
and end range under the category pcdId.
|
PortletView[] |
getPortletViews(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
Returns PortletViews in the begin and
end range under the category pcdId. |
PortletCategoryDefinition |
getRootCategory(CustomizationContext customizationContext,
String webAppName)
Returns root of the PortletCategory hierarchy. |
PortletCategoryDefinition[] |
getSiblingCategories(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
Returns an array of PorletCategoryDefinitions for
sibling categories of the category represented by pcdId in
the begin and end range.If fewer categories
than (begin-end) exist then the former number of categories is
returned. |
int |
getSiblingCategoryCount(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
Returns the number of categories at the same level as a category. |
PortletCategoryDefinitionId[] |
getSiblingCategoryIds(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
Returns an array of PorletCategoryDefinitionIds for
sibling categories of the category represented by pcdId in
the begin and end range. |
PortletCategoryView[] |
getSiblingCategoryViews(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
Returns an array of PorletCategoryViews for
sibling categories of the category represented by pcdId in
the begin and end range. |
PortletCategoryDefinition[] |
getSubCategories(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
Returns an array of PorletCategoryDefinitions for
subcategories of the category represented by pcdId in the
begin and end range.If fewer categories
than (begin-end) exist then the former number of categories is
returned. |
int |
getSubCategoryCount(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
Returns the number of immediate categories under category pcdId. |
PortletCategoryDefinitionId[] |
getSubCategoryIds(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
Returns an array of PorletCategoryDefinitionIds for
subcategories of the category represented by pcdId in the
begin and end range. |
void |
moveCategory(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
PortletCategoryDefinitionId newParentId)
Moves a category under a new parent. |
void |
updateCategory(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
PortletCategoryDefinition newPcd)
Updates a locale specific version of a category based on a new PortletCategoryDefinition. |
| Method Detail |
public void addPortletDefinition(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
PortletDefinitionId pdId)
throws RemoteException,
NotEntitledException
PortletDefinitionId to a portlet category.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdpdId - PortletDefinitionId
NotEntitledException - if caller does not have permission for this
operation
RemoteException
public PortletCategoryDefinition createCategory(CustomizationContext customizationContext,
PortletCategoryDefinition pcd)
throws RemoteException,
NotEntitledException,
MissingDataException
PortletCategoryDefinition
from the provided PortletCategoryDefinition.
customizationContext - customization information such as prefered
localespcd - PortletCategoryDefinition
PortletCategoryDefinition
NotEntitledException - if caller does not have permission for this
operation
MissingDataException - if data required to create a category is
missing
RemoteException
public PortletCategoryDefinition createRootCategory(CustomizationContext customizationContext,
PortletCategoryDefinition root)
throws RemoteException,
MissingDataException,
NotEntitledException
customizationContext - customization information such as prefered
localesroot - PorletCategoryDefinition for ROOT category
MissingDataException - if some data is missing
NotEntitledException - if caller does not have permission for this
operation
RemoteException
public int deleteCategory(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
throws RemoteException,
NotEntitledException
customizationContext - customization information such as prefered
localespcdId - category to be removed
NotEntitledException - if caller does not have permission for this
operation
RemoteException
public void deletePortletDefinition(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
PortletDefinitionId pdId)
throws RemoteException,
NotEntitledException
PortletDefinitionId from a portlet category.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdpdId - PortletDefinitionId
NotEntitledException - if caller does not have permission for this
operation
RemoteException
public int deletePortletDefinitions(CustomizationContext customizationContext,
PortletDefinitionId pdId)
throws RemoteException,
NotEntitledException
PortletDefinitionId from all portlet categories.
customizationContext - customization information such as prefered
localespdId - PortletDefinitionId
PortletDefinition deleted
NotEntitledException - is caller does not have permission for this
operation
RemoteException
public PortletCategoryDefinitionId[] getAncestorIds(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
throws RemoteException,
ObjectNotFoundException
PortletCategoryDefinitionIds that
represent the ancestors of a category starting with the parent
category and ending with the root.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionId
PortletCategoryDefinitionIds
ObjectNotFoundException - if category does not exist
RemoteException
public PortletCategoryDefinition[] getAncestors(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
throws RemoteException,
ObjectNotFoundException
PortletCategoryDefinitions that
represent the ancestors of a category starting with the parent
category and ending with the root.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionId
PortletCategoryDefinitions
ObjectNotFoundException - if category does not exist
RemoteException
public PortletCategoryDefinition[] getCategories(CustomizationContext customizationContext,
PortletCategoryDefinitionId[] pcdId)
throws RemoteException,
ObjectNotFoundException
PortletCategoryDefinitions corresponding
to an array of PortletCategoryDefinitionIds.
customizationContext - customization information such as prefered
localespcdId - array of PortletCategoryDefinitionIds
PortletCategoryDefinitions
ObjectNotFoundException - if category for any key does not exist
RemoteException
public PortletCategoryDefinition getCategory(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
throws RemoteException,
ObjectNotFoundException
PortletCategoryDefinition corresponding to a
PortletCategoryDefinitionId.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionId
PortletCategoryDefinition
ObjectNotFoundException - if no category definition is found
RemoteException
public int getCategoryCount(CustomizationContext customizationContext,
String webAppName)
throws RemoteException
webAppName - the name of the webapp as defined in the config.xml
RemoteException
public PortletCategoryDefinitionId[] getCategoryIds(CustomizationContext customizationContext,
int begin,
int end,
String webAppName)
throws RemoteException
PorletCategoryDefinitionIds in the
begin and end range. If fewer categories
than (begin-end) exist then the former number of categories is
returned. If no definitions are found an empty array is returned.PortletCategoryDefinitionIds in a consistent
order.
customizationContext - customization information such as prefered
localesbegin - begin indexend - end indexwebAppName - as defined in the config.xml
PortletCategoryDefinitionIds
RemoteException
public PortletCategoryView getCategoryView(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
throws RemoteException,
ObjectNotFoundException
PortletCategoryView corresponding to a
PortletCategoryDefinitionId.PortletCategoryDefinitionId
in the category hierarchy the larger the size of the returned
PortletCategoryView object is going to be. An example of
such a degenerative case would be to call this method for the root
category in which case all category definitions and all portlet
definitions that are categorized will be returned.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionId
PortletCategoryView
ObjectNotFoundException - if no category definition is found
RemoteException
public PortletCategoryView[] getCategoryViews(CustomizationContext customizationContext,
PortletCategoryDefinitionId[] pcdId)
throws RemoteException,
ObjectNotFoundException
PortletCategoryViews corresponding
to an array of PortletCategoryDefinitionIds.PortletCategoryDefinitions in the
method argument are parents or children of one another duplicated data
will get returned in the PortletCategoryView objects.
customizationContext - customization information such as prefered
localespcdId - array of PortletCategoryDefinitionIds
PortletCategoryViews
ObjectNotFoundException - if category for any key does not exist
RemoteExceptionnote for caveat
public int getNonCategorizedPortletDefinitionCount(CustomizationContext customizationContext,
String webAppName)
throws RemoteException
PortletDefinitions that are
not included under any category.
webAppName - the web app name as defined in the config.xml
PortletDefinitions
RemoteException
public PortletDefinitionId[] getNonCategorizedPortletDefinitionIds(CustomizationContext customizationContext,
int begin,
int end,
String webAppName)
throws RemoteException
PortletDefinitionIds in the
begin and end range. If fewer categories
than (begin-end) exist then the former number of categories is
returned. If no definitions are found an empty array is returned.PortletDefinitionIds.PortletDefinitions in a consistent
order.
customizationContext - customization information such as prefered
localesbegin - begin indexend - end indexwebAppName - the web app name as defined in the config.xml
PortletDefinitionIds
RemoteException
public PortletDefinition[] getNonCategorizedPortletDefinitions(CustomizationContext customizationContext,
int begin,
int end,
String webAppName)
throws RemoteException
PortletDefinitions in the
begin and end range. If fewer categories
than (begin-end) exist then the former number of categories is
returned. If no definitions are found an empty array is returned.PortletDefinitions.PortletDefinitions in a consistent
order.
customizationContext - customization information such as prefered
localesbegin - begin indexend - end indexwebAppName - the web app name as defined in the config.xml
PortletDefinitions
RemoteException
public PortletView[] getNonCategorizedPortletViews(CustomizationContext customizationContext,
int begin,
int end,
String webAppName)
throws RemoteException
PortletViews in the
begin and end range. If fewer categories
than (begin-end) exist then the former number of category views is
returned. If no definitions are found an empty array is returned.PortletDefinitions.PortletViews in a consistent
order.
customizationContext - customization information such as prefered
localesbegin - begin indexend - end indexwebAppName - the web app name as defined in the config.xml
PortletViews
RemoteException
public PortletCategoryDefinitionId[] getPortletDefinitionCategories(CustomizationContext customizationContext,
PortletDefinitionId pdId)
throws RemoteException
PortletCategoryDefinitions that a
PortletDefinition is a part of. Returns an empty array
if the latter is noncategorized.
customizationContext - customization information such as prefered
localespdId - PortletDefinitionId
PortletCategoryDefinitionIds
RemoteException
public int getPortletDefinitionCount(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
throws RemoteException
PortletDefinitions under category
pcdId.
pcdId - PortletCategoryDefinitionId
PortletDefinitions under category
pcdId
RemoteException
public PortletDefinition[] getPortletDefinitions(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
throws RemoteException
PortletDefinitions in the begin
and end range under the category pcdId.
If fewer PortletDefinitions than (begin-end) exist
then the former number is returned. If no definitions are
found an empty array is returned.PortletDefinitions.PortletDefinitions in a consistent
order.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdbegin - begin indexend - end index
PortletDefinitions
RemoteException
public PortletView[] getPortletViews(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
throws RemoteException,
ObjectNotFoundException
PortletViews in the begin and
end range under the category pcdId. If fewer
views than (begin-end) exist then the former number of views is returned.
If no views are found an empty array is returned.PortletDefinitions.PortletViews in a consistent
order.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdbegin - begin indexend - end index
PortletViews
RemoteException
ObjectNotFoundExceptionnote for caveat
public PortletCategoryDefinition getRootCategory(CustomizationContext customizationContext,
String webAppName)
throws RemoteException,
ObjectNotFoundException
customizationContext - customization information such as prefered
localeswebAppName - the name of the webapp as defined in the config.xml
PortletCategoryDefinition.
ObjectNotFoundException - if the root category does not exist
RemoteException
public PortletCategoryDefinition[] getSiblingCategories(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
throws RemoteException,
ObjectNotFoundException
PorletCategoryDefinitions for
sibling categories of the category represented by pcdId in
the begin and end range.If fewer categories
than (begin-end) exist then the former number of categories is
returned. If no definitions are found an empty array is returned.PortletCategoryDefinitions in a consistent
order.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdbegin - begin indexend - end index
PortletCategoryDefinitions
ObjectNotFoundException - if category does not exist
RemoteException
public int getSiblingCategoryCount(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
throws RemoteException
pcdId - PortletCategoryDefinitionId
pcdId
RemoteException
public PortletCategoryDefinitionId[] getSiblingCategoryIds(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
throws RemoteException
PorletCategoryDefinitionIds for
sibling categories of the category represented by pcdId in
the begin and end range. If fewer categories
than (begin-end) exist then the former number of categories is
returned. If no definitions are found an empty array is returned.PortletCategoryDefinitionIds in a consistent
order.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdbegin - begin indexend - end index
PortletCategoryDefinitionIds
RemoteException
public PortletCategoryView[] getSiblingCategoryViews(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
throws RemoteException,
ObjectNotFoundException
PorletCategoryViews for
sibling categories of the category represented by pcdId in
the begin and end range. If fewer categories
than (begin-end) exist then the former number of category views is
returned. If no definitions are found an empty array is returned.PortletCategoryViews in a consistent
order.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdbegin - begin indexend - end index
PortletCategoryDefinitions
ObjectNotFoundException - if category does not exist
RemoteExceptionnote for caveat
public PortletCategoryDefinition[] getSubCategories(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
throws RemoteException,
ObjectNotFoundException
PorletCategoryDefinitions for
subcategories of the category represented by pcdId in the
begin and end range.If fewer categories
than (begin-end) exist then the former number of categories is
returned. If no definitions are found an empty array is returned.PortletCategoryDefinitions in a consistent
order.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdbegin - begin indexend - end index
PortletCategoryDefinitions
ObjectNotFoundException - if category does not exist
RemoteException
public int getSubCategoryCount(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId)
throws RemoteException
pcdId.
pcdId - PortletCategoryDefinitionId
pcdId
RemoteException
public PortletCategoryDefinitionId[] getSubCategoryIds(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
int begin,
int end)
throws RemoteException
PorletCategoryDefinitionIds for
subcategories of the category represented by pcdId in the
begin and end range. If fewer categories
than (begin-end) exist then the former number of categories is
returned. If no definitions are found an empty array is returned.PortletCategoryDefinitionIds in a consistent
order.
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdbegin - begin indexend - end index
PortletCategoryDefinitionIds
RemoteException
public void moveCategory(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
PortletCategoryDefinitionId newParentId)
throws RemoteException,
ObjectNotFoundException,
NotEntitledException
customizationContext - customization information such as prefered
localespcdId - PortletCategoryDefinitionIdnewParentId - new parent PortletCategoryDefinitionId
ObjectNotFoundException - if category does not exist
NotEntitledException - if caller does not have permission for this
operation
RemoteException
public void updateCategory(CustomizationContext customizationContext,
PortletCategoryDefinitionId pcdId,
PortletCategoryDefinition newPcd)
throws RemoteException,
ObjectNotFoundException,
ObjectInUseException,
NotEntitledException,
MissingDataException
PortletCategoryDefinition.
customizationContext - customization information such as prefered
localespcdId - PorletCategoryDefinitionIdnewPcd - new PorletCategoryDefinition
ObjectNotFoundException - if category does not exist
NotEntitledException - if caller does not have permission for this
operation
MissingDataException - if data required to update a category is
missing
RemoteException
ObjectInUseException
|
© 2005 BEA Systems, Inc. | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||