© 2005 BEA Systems, Inc.

com.bea.netuix.application.manager
Interface IPortletCategoryManager

All Known Subinterfaces:
PortletCategoryManager

public interface IPortletCategoryManager

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

addPortletDefinition

public void addPortletDefinition(CustomizationContext customizationContext,
                                 PortletCategoryDefinitionId pcdId,
                                 PortletDefinitionId pdId)
                          throws RemoteException,
                                 NotEntitledException
Adds a PortletDefinitionId to a portlet category.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
pdId - PortletDefinitionId
Throws:
NotEntitledException - if caller does not have permission for this operation
RemoteException

createCategory

public PortletCategoryDefinition createCategory(CustomizationContext customizationContext,
                                                PortletCategoryDefinition pcd)
                                         throws RemoteException,
                                                NotEntitledException,
                                                MissingDataException
Creates a persistent version of a PortletCategoryDefinition from the provided PortletCategoryDefinition.

Parameters:
customizationContext - customization information such as prefered locales
pcd - PortletCategoryDefinition
Returns:
handle to persisted PortletCategoryDefinition
Throws:
NotEntitledException - if caller does not have permission for this operation
MissingDataException - if data required to create a category is missing
RemoteException

createRootCategory

public PortletCategoryDefinition createRootCategory(CustomizationContext customizationContext,
                                                    PortletCategoryDefinition root)
                                             throws RemoteException,
                                                    MissingDataException,
                                                    NotEntitledException
Creates and returns a ROOT category

Parameters:
customizationContext - customization information such as prefered locales
root - PorletCategoryDefinition for ROOT category
Returns:
PortletCategoryDefinition for ROOT category with identifier set
Throws:
MissingDataException - if some data is missing
NotEntitledException - if caller does not have permission for this operation
RemoteException

deleteCategory

public int deleteCategory(CustomizationContext customizationContext,
                          PortletCategoryDefinitionId pcdId)
                   throws RemoteException,
                          NotEntitledException
Deletes all (including localized) versions of a category. Also deletes all subcategories of category in question.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - category to be removed
Returns:
number of categories deleted
Throws:
NotEntitledException - if caller does not have permission for this operation
RemoteException

deletePortletDefinition

public void deletePortletDefinition(CustomizationContext customizationContext,
                                    PortletCategoryDefinitionId pcdId,
                                    PortletDefinitionId pdId)
                             throws RemoteException,
                                    NotEntitledException
Deletes a PortletDefinitionId from a portlet category.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
pdId - PortletDefinitionId
Throws:
NotEntitledException - if caller does not have permission for this operation
RemoteException

deletePortletDefinitions

public int deletePortletDefinitions(CustomizationContext customizationContext,
                                    PortletDefinitionId pdId)
                             throws RemoteException,
                                    NotEntitledException
Deletes a PortletDefinitionId from all portlet categories.

Parameters:
customizationContext - customization information such as prefered locales
pdId - PortletDefinitionId
Returns:
number of instances PortletDefinition deleted
Throws:
NotEntitledException - is caller does not have permission for this operation
RemoteException

getAncestorIds

public PortletCategoryDefinitionId[] getAncestorIds(CustomizationContext customizationContext,
                                                    PortletCategoryDefinitionId pcdId)
                                             throws RemoteException,
                                                    ObjectNotFoundException
Returns an array of PortletCategoryDefinitionIds that represent the ancestors of a category starting with the parent category and ending with the root.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
Returns:
an array of PortletCategoryDefinitionIds
Throws:
ObjectNotFoundException - if category does not exist
RemoteException

getAncestors

public PortletCategoryDefinition[] getAncestors(CustomizationContext customizationContext,
                                                PortletCategoryDefinitionId pcdId)
                                         throws RemoteException,
                                                ObjectNotFoundException
Returns an array of PortletCategoryDefinitions that represent the ancestors of a category starting with the parent category and ending with the root.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
Returns:
an array of PortletCategoryDefinitions
Throws:
ObjectNotFoundException - if category does not exist
RemoteException

getCategories

public PortletCategoryDefinition[] getCategories(CustomizationContext customizationContext,
                                                 PortletCategoryDefinitionId[] pcdId)
                                          throws RemoteException,
                                                 ObjectNotFoundException
Returns an array of PortletCategoryDefinitions corresponding to an array of PortletCategoryDefinitionIds.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - array of PortletCategoryDefinitionIds
Returns:
array of PortletCategoryDefinitions
Throws:
ObjectNotFoundException - if category for any key does not exist
RemoteException

getCategory

public PortletCategoryDefinition getCategory(CustomizationContext customizationContext,
                                             PortletCategoryDefinitionId pcdId)
                                      throws RemoteException,
                                             ObjectNotFoundException
Returns a PortletCategoryDefinition corresponding to a PortletCategoryDefinitionId.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
Returns:
PortletCategoryDefinition
Throws:
ObjectNotFoundException - if no category definition is found
RemoteException

getCategoryCount

public int getCategoryCount(CustomizationContext customizationContext,
                            String webAppName)
                     throws RemoteException
Returns the number of categories recursively starting with the root category. Note: categories are scoped to th web app.

Parameters:
webAppName - the name of the webapp as defined in the config.xml
Returns:
number of categories
Throws:
RemoteException

getCategoryIds

public PortletCategoryDefinitionId[] getCategoryIds(CustomizationContext customizationContext,
                                                    int begin,
                                                    int end,
                                                    String webAppName)
                                             throws RemoteException
Returns an array of 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.
Implementation has to ensure that repeated calls to this method return PortletCategoryDefinitionIds in a consistent order.

Parameters:
customizationContext - customization information such as prefered locales
begin - begin index
end - end index
webAppName - as defined in the config.xml
Returns:
an array of PortletCategoryDefinitionIds
Throws:
RemoteException

getCategoryView

public PortletCategoryView getCategoryView(CustomizationContext customizationContext,
                                           PortletCategoryDefinitionId pcdId)
                                    throws RemoteException,
                                           ObjectNotFoundException
Returns a PortletCategoryView corresponding to a PortletCategoryDefinitionId.
NOTE: This method returns a deep copy of a category definition. So, the higher the level of the 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.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
Returns:
PortletCategoryView
Throws:
ObjectNotFoundException - if no category definition is found
RemoteException

getCategoryViews

public PortletCategoryView[] getCategoryViews(CustomizationContext customizationContext,
                                              PortletCategoryDefinitionId[] pcdId)
                                       throws RemoteException,
                                              ObjectNotFoundException
Returns an array of PortletCategoryViews corresponding to an array of PortletCategoryDefinitionIds.
NOTE:If some of the PortletCategoryDefinitions in the method argument are parents or children of one another duplicated data will get returned in the PortletCategoryView objects.
Same caveat as method getCategoryView applies.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - array of PortletCategoryDefinitionIds
Returns:
array of PortletCategoryViews
Throws:
ObjectNotFoundException - if category for any key does not exist
RemoteException
See Also:
note for caveat

getNonCategorizedPortletDefinitionCount

public int getNonCategorizedPortletDefinitionCount(CustomizationContext customizationContext,
                                                   String webAppName)
                                            throws RemoteException
Returns the number of PortletDefinitions that are not included under any category.

Parameters:
webAppName - the web app name as defined in the config.xml
Returns:
number of noncategorized PortletDefinitions
Throws:
RemoteException

getNonCategorizedPortletDefinitionIds

public PortletDefinitionId[] getNonCategorizedPortletDefinitionIds(CustomizationContext customizationContext,
                                                                   int begin,
                                                                   int end,
                                                                   String webAppName)
                                                            throws RemoteException
Returns noncategorized 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.
Use this method after getting the number of noncategorized PortletDefinitionIds.
The implementation has to ensure that repeated calls to this method return PortletDefinitions in a consistent order.

Parameters:
customizationContext - customization information such as prefered locales
begin - begin index
end - end index
webAppName - the web app name as defined in the config.xml
Returns:
array of PortletDefinitionIds
Throws:
RemoteException

getNonCategorizedPortletDefinitions

public PortletDefinition[] getNonCategorizedPortletDefinitions(CustomizationContext customizationContext,
                                                               int begin,
                                                               int end,
                                                               String webAppName)
                                                        throws RemoteException
Returns noncategorized 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.
Use this method after getting the number of noncategorized PortletDefinitions.
Implementation has to ensure that repeated calls to this method return PortletDefinitions in a consistent order.

Parameters:
customizationContext - customization information such as prefered locales
begin - begin index
end - end index
webAppName - the web app name as defined in the config.xml
Returns:
array of PortletDefinitions
Throws:
RemoteException

getNonCategorizedPortletViews

public PortletView[] getNonCategorizedPortletViews(CustomizationContext customizationContext,
                                                   int begin,
                                                   int end,
                                                   String webAppName)
                                            throws RemoteException
Returns noncategorized 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.
Use this method after getting the number of noncategorized PortletDefinitions.
Implementation has to ensure that repeated calls to this method return PortletViews in a consistent order.

Parameters:
customizationContext - customization information such as prefered locales
begin - begin index
end - end index
webAppName - the web app name as defined in the config.xml
Returns:
array of PortletViews
Throws:
RemoteException

getPortletDefinitionCategories

public PortletCategoryDefinitionId[] getPortletDefinitionCategories(CustomizationContext customizationContext,
                                                                    PortletDefinitionId pdId)
                                                             throws RemoteException
Returns all the PortletCategoryDefinitions that a PortletDefinition is a part of. Returns an empty array if the latter is noncategorized.

Parameters:
customizationContext - customization information such as prefered locales
pdId - PortletDefinitionId
Returns:
an array of PortletCategoryDefinitionIds
Throws:
RemoteException

getPortletDefinitionCount

public int getPortletDefinitionCount(CustomizationContext customizationContext,
                                     PortletCategoryDefinitionId pcdId)
                              throws RemoteException
Returns the number of PortletDefinitions under category pcdId.

Parameters:
pcdId - PortletCategoryDefinitionId
Returns:
number of PortletDefinitions under category pcdId
Throws:
RemoteException

getPortletDefinitions

public PortletDefinition[] getPortletDefinitions(CustomizationContext customizationContext,
                                                 PortletCategoryDefinitionId pcdId,
                                                 int begin,
                                                 int end)
                                          throws RemoteException
Returns 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.
Use this method after getting the number of PortletDefinitions.
Implementation has to ensure that repeated calls to this method return PortletDefinitions in a consistent order.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
begin - begin index
end - end index
Returns:
array of PortletDefinitions
Throws:
RemoteException

getPortletViews

public PortletView[] getPortletViews(CustomizationContext customizationContext,
                                     PortletCategoryDefinitionId pcdId,
                                     int begin,
                                     int end)
                              throws RemoteException,
                                     ObjectNotFoundException
Returns 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.
Use this method after getting the number of PortletDefinitions.
Implementation has to ensure that repeated calls to this method return PortletViews in a consistent order.
Same caveat as method getCategoryView applies.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
begin - begin index
end - end index
Returns:
array of PortletViews
Throws:
RemoteException
ObjectNotFoundException
See Also:
note for caveat

getRootCategory

public PortletCategoryDefinition getRootCategory(CustomizationContext customizationContext,
                                                 String webAppName)
                                          throws RemoteException,
                                                 ObjectNotFoundException
Returns root of the PortletCategory hierarchy.

Parameters:
customizationContext - customization information such as prefered locales
webAppName - the name of the webapp as defined in the config.xml
Returns:
the root PortletCategoryDefinition.
Throws:
ObjectNotFoundException - if the root category does not exist
RemoteException

getSiblingCategories

public PortletCategoryDefinition[] getSiblingCategories(CustomizationContext customizationContext,
                                                        PortletCategoryDefinitionId pcdId,
                                                        int begin,
                                                        int end)
                                                 throws RemoteException,
                                                        ObjectNotFoundException
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. If no definitions are found an empty array is returned.
Implementation has to ensure that repeated calls to this method return PortletCategoryDefinitions in a consistent order.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
begin - begin index
end - end index
Returns:
an array of PortletCategoryDefinitions
Throws:
ObjectNotFoundException - if category does not exist
RemoteException

getSiblingCategoryCount

public int getSiblingCategoryCount(CustomizationContext customizationContext,
                                   PortletCategoryDefinitionId pcdId)
                            throws RemoteException
Returns the number of categories at the same level as a category. All these categories have the same parent.

Parameters:
pcdId - PortletCategoryDefinitionId
Returns:
number of code>PortletDefinitions under category pcdId
Throws:
RemoteException

getSiblingCategoryIds

public PortletCategoryDefinitionId[] getSiblingCategoryIds(CustomizationContext customizationContext,
                                                           PortletCategoryDefinitionId pcdId,
                                                           int begin,
                                                           int end)
                                                    throws RemoteException
Returns an array of 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.
Implementation has to ensure that repeated calls to this method return PortletCategoryDefinitionIds in a consistent order.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
begin - begin index
end - end index
Returns:
an array of PortletCategoryDefinitionIds
Throws:
RemoteException

getSiblingCategoryViews

public PortletCategoryView[] getSiblingCategoryViews(CustomizationContext customizationContext,
                                                     PortletCategoryDefinitionId pcdId,
                                                     int begin,
                                                     int end)
                                              throws RemoteException,
                                                     ObjectNotFoundException
Returns an array of 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.
Implementation has to ensure that repeated calls to this method return PortletCategoryViews in a consistent order.
Same caveat as method getCategoryView applies.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
begin - begin index
end - end index
Returns:
an array of PortletCategoryDefinitions
Throws:
ObjectNotFoundException - if category does not exist
RemoteException
See Also:
note for caveat

getSubCategories

public PortletCategoryDefinition[] getSubCategories(CustomizationContext customizationContext,
                                                    PortletCategoryDefinitionId pcdId,
                                                    int begin,
                                                    int end)
                                             throws RemoteException,
                                                    ObjectNotFoundException
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. If no definitions are found an empty array is returned.
Implementation has to ensure that repeated calls to this method return PortletCategoryDefinitions in a consistent order.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
begin - begin index
end - end index
Returns:
an array of PortletCategoryDefinitions
Throws:
ObjectNotFoundException - if category does not exist
RemoteException

getSubCategoryCount

public int getSubCategoryCount(CustomizationContext customizationContext,
                               PortletCategoryDefinitionId pcdId)
                        throws RemoteException
Returns the number of immediate categories under category pcdId.

Parameters:
pcdId - PortletCategoryDefinitionId
Returns:
number of categories under category pcdId
Throws:
RemoteException

getSubCategoryIds

public PortletCategoryDefinitionId[] getSubCategoryIds(CustomizationContext customizationContext,
                                                       PortletCategoryDefinitionId pcdId,
                                                       int begin,
                                                       int end)
                                                throws RemoteException
Returns an array of 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.
Implementation has to ensure that repeated calls to this method return PortletCategoryDefinitionIds in a consistent order.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
begin - begin index
end - end index
Returns:
an array of PortletCategoryDefinitionIds
Throws:
RemoteException

moveCategory

public void moveCategory(CustomizationContext customizationContext,
                         PortletCategoryDefinitionId pcdId,
                         PortletCategoryDefinitionId newParentId)
                  throws RemoteException,
                         ObjectNotFoundException,
                         NotEntitledException
Moves a category under a new parent.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PortletCategoryDefinitionId
newParentId - new parent PortletCategoryDefinitionId
Throws:
ObjectNotFoundException - if category does not exist
NotEntitledException - if caller does not have permission for this operation
RemoteException

updateCategory

public void updateCategory(CustomizationContext customizationContext,
                           PortletCategoryDefinitionId pcdId,
                           PortletCategoryDefinition newPcd)
                    throws RemoteException,
                           ObjectNotFoundException,
                           ObjectInUseException,
                           NotEntitledException,
                           MissingDataException
Updates a locale specific version of a category based on a new PortletCategoryDefinition.

Parameters:
customizationContext - customization information such as prefered locales
pcdId - PorletCategoryDefinitionId
newPcd - new PorletCategoryDefinition
Throws:
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.

Copyright © 2005 BEA Systems, Inc. All Rights Reserved