com.liferay.portlet.asset.service
Class AssetCategoryLocalServiceUtil

java.lang.Object
  com.liferay.portlet.asset.service.AssetCategoryLocalServiceUtil

public class AssetCategoryLocalServiceUtil
extends Object

The utility for the asset category local service. This utility wraps com.liferay.portlet.asset.service.impl.AssetCategoryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

AssetCategoryLocalService, com.liferay.portlet.asset.service.base.AssetCategoryLocalServiceBaseImpl, com.liferay.portlet.asset.service.impl.AssetCategoryLocalServiceImpl

Constructor Summary

AssetCategoryLocalServiceUtil()

Method Summary

static AssetCategory	addAssetCategory(AssetCategory assetCategory) Adds the asset category to the database.
static void	addAssetEntryAssetCategories(long entryId, List<AssetCategory> AssetCategories)
static void	addAssetEntryAssetCategories(long entryId, long[] categoryIds)
static void	addAssetEntryAssetCategory(long entryId, AssetCategory assetCategory)
static void	addAssetEntryAssetCategory(long entryId, long categoryId)
static AssetCategory	addCategory(long userId, long parentCategoryId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext)
static void	addCategoryResources(AssetCategory category, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addCategoryResources(AssetCategory category, String[] groupPermissions, String[] guestPermissions)
static void	clearAssetEntryAssetCategories(long entryId)
static AssetCategory	createAssetCategory(long categoryId) Creates a new asset category with the primary key.
static AssetCategory	deleteAssetCategory(AssetCategory assetCategory) Deletes the asset category from the database.
static AssetCategory	deleteAssetCategory(long categoryId) Deletes the asset category with the primary key from the database.
static void	deleteAssetEntryAssetCategories(long entryId, List<AssetCategory> AssetCategories)
static void	deleteAssetEntryAssetCategories(long entryId, long[] categoryIds)
static void	deleteAssetEntryAssetCategory(long entryId, AssetCategory assetCategory)
static void	deleteAssetEntryAssetCategory(long entryId, long categoryId)
static void	deleteCategory(AssetCategory category)
static void	deleteCategory(long categoryId)
static void	deleteVocabularyCategories(long vocabularyId)
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static AssetCategory	fetchAssetCategory(long categoryId)
static AssetCategory	fetchCategory(long categoryId)
static List<AssetCategory>	getAssetCategories(int start, int end) Returns a range of all the asset categories.
static int	getAssetCategoriesCount() Returns the number of asset categories.
static AssetCategory	getAssetCategory(long categoryId) Returns the asset category with the primary key.
static AssetCategory	getAssetCategoryByUuidAndGroupId(String uuid, long groupId) Returns the asset category with the UUID in the group.
static List<AssetCategory>	getAssetEntryAssetCategories(long entryId)
static List<AssetCategory>	getAssetEntryAssetCategories(long entryId, int start, int end)
static List<AssetCategory>	getAssetEntryAssetCategories(long entryId, int start, int end, OrderByComparator orderByComparator)
static int	getAssetEntryAssetCategoriesCount(long entryId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static List<AssetCategory>	getCategories()
static List<AssetCategory>	getCategories(long classNameId, long classPK)
static List<AssetCategory>	getCategories(String className, long classPK)
static AssetCategory	getCategory(long categoryId)
static AssetCategory	getCategory(String uuid, long groupId)
static long[]	getCategoryIds(String className, long classPK)
static String[]	getCategoryNames()
static String[]	getCategoryNames(long classNameId, long classPK)
static String[]	getCategoryNames(String className, long classPK)
static List<AssetCategory>	getChildCategories(long parentCategoryId)
static List<AssetCategory>	getChildCategories(long parentCategoryId, int start, int end, OrderByComparator obc)
static int	getChildCategoriesCount(long parentCategoryId)
static List<AssetCategory>	getEntryCategories(long entryId)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static AssetCategoryLocalService	getService()
static List<AssetCategory>	getVocabularyCategories(long vocabularyId, int start, int end, OrderByComparator obc)
static List<AssetCategory>	getVocabularyCategories(long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator obc)
static int	getVocabularyCategoriesCount(long vocabularyId)
static List<AssetCategory>	getVocabularyRootCategories(long vocabularyId, int start, int end, OrderByComparator obc)
static int	getVocabularyRootCategoriesCount(long vocabularyId)
static boolean	hasAssetEntryAssetCategories(long entryId)
static boolean	hasAssetEntryAssetCategory(long entryId, long categoryId)
static void	mergeCategories(long fromCategoryId, long toCategoryId)
static AssetCategory	moveCategory(long categoryId, long parentCategoryId, long vocabularyId, ServiceContext serviceContext)
static void	rebuildTree(long groupId, boolean force)
static List<AssetCategory>	search(long groupId, String name, String[] categoryProperties, int start, int end)
static void	setAssetEntryAssetCategories(long entryId, long[] categoryIds)
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(AssetCategoryLocalService service) Deprecated.
static AssetCategory	updateAssetCategory(AssetCategory assetCategory) Updates the asset category in the database or adds it if it does not yet exist.
static AssetCategory	updateAssetCategory(AssetCategory assetCategory, boolean merge) Updates the asset category in the database or adds it if it does not yet exist.
static AssetCategory	updateCategory(long userId, long categoryId, long parentCategoryId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetCategoryLocalServiceUtil

public AssetCategoryLocalServiceUtil()

Method Detail

addAssetCategory

public static AssetCategory addAssetCategory(AssetCategory assetCategory)
                                      throws SystemException

Adds the asset category to the database. Also notifies the appropriate model listeners.

Parameters:

assetCategory - the asset category

Returns:

the asset category that was added

Throws:

SystemException - if a system exception occurred

createAssetCategory

public static AssetCategory createAssetCategory(long categoryId)

Creates a new asset category with the primary key. Does not add the asset category to the database.

Parameters:

categoryId - the primary key for the new asset category

Returns:

the new asset category

deleteAssetCategory

public static AssetCategory deleteAssetCategory(long categoryId)
                                         throws PortalException,
                                                SystemException

Deletes the asset category with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

categoryId - the primary key of the asset category

Returns:

the asset category that was removed

Throws:

PortalException - if a asset category with the primary key could not be found

SystemException - if a system exception occurred

deleteAssetCategory

public static AssetCategory deleteAssetCategory(AssetCategory assetCategory)
                                         throws SystemException

Deletes the asset category from the database. Also notifies the appropriate model listeners.

Parameters:

assetCategory - the asset category

Returns:

the asset category that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchAssetCategory

public static AssetCategory fetchAssetCategory(long categoryId)
                                        throws SystemException

Throws:

SystemException

getAssetCategory

public static AssetCategory getAssetCategory(long categoryId)
                                      throws PortalException,
                                             SystemException

Returns the asset category with the primary key.

Parameters:

categoryId - the primary key of the asset category

Returns:

the asset category

Throws:

PortalException - if a asset category with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getAssetCategoryByUuidAndGroupId

public static AssetCategory getAssetCategoryByUuidAndGroupId(String uuid,
                                                             long groupId)
                                                      throws PortalException,
                                                             SystemException

Returns the asset category with the UUID in the group.

Parameters:

uuid - the UUID of asset category

groupId - the group id of the asset category

Returns:

the asset category

Throws:

PortalException - if a asset category with the UUID in the group could not be found

SystemException - if a system exception occurred

getAssetCategories

public static List<AssetCategory> getAssetCategories(int start,
                                                     int end)
                                              throws SystemException

Returns a range of all the asset categories.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of asset categories

end - the upper bound of the range of asset categories (not inclusive)

Returns:

the range of asset categories

Throws:

SystemException - if a system exception occurred

getAssetCategoriesCount

public static int getAssetCategoriesCount()
                                   throws SystemException

Returns the number of asset categories.

Returns:

the number of asset categories

Throws:

SystemException - if a system exception occurred

updateAssetCategory

public static AssetCategory updateAssetCategory(AssetCategory assetCategory)
                                         throws SystemException

Updates the asset category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

assetCategory - the asset category

Returns:

the asset category that was updated

Throws:

SystemException - if a system exception occurred

updateAssetCategory

public static AssetCategory updateAssetCategory(AssetCategory assetCategory,
                                                boolean merge)
                                         throws SystemException

Updates the asset category in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

assetCategory - the asset category

merge - whether to merge the asset category with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the asset category that was updated

Throws:

SystemException - if a system exception occurred

addAssetEntryAssetCategory

public static void addAssetEntryAssetCategory(long entryId,
                                              long categoryId)
                                       throws SystemException

Throws:

SystemException - if a system exception occurred

addAssetEntryAssetCategory

public static void addAssetEntryAssetCategory(long entryId,
                                              AssetCategory assetCategory)
                                       throws SystemException

Throws:

SystemException - if a system exception occurred

addAssetEntryAssetCategories

public static void addAssetEntryAssetCategories(long entryId,
                                                long[] categoryIds)
                                         throws SystemException

Throws:

SystemException - if a system exception occurred

addAssetEntryAssetCategories

public static void addAssetEntryAssetCategories(long entryId,
                                                List<AssetCategory> AssetCategories)
                                         throws SystemException

Throws:

SystemException - if a system exception occurred

clearAssetEntryAssetCategories

public static void clearAssetEntryAssetCategories(long entryId)
                                           throws SystemException

Throws:

SystemException - if a system exception occurred

deleteAssetEntryAssetCategory

public static void deleteAssetEntryAssetCategory(long entryId,
                                                 long categoryId)
                                          throws SystemException

Throws:

SystemException - if a system exception occurred

deleteAssetEntryAssetCategory

public static void deleteAssetEntryAssetCategory(long entryId,
                                                 AssetCategory assetCategory)
                                          throws SystemException

Throws:

SystemException - if a system exception occurred

deleteAssetEntryAssetCategories

public static void deleteAssetEntryAssetCategories(long entryId,
                                                   long[] categoryIds)
                                            throws SystemException

Throws:

SystemException - if a system exception occurred

deleteAssetEntryAssetCategories

public static void deleteAssetEntryAssetCategories(long entryId,
                                                   List<AssetCategory> AssetCategories)
                                            throws SystemException

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetCategories

public static List<AssetCategory> getAssetEntryAssetCategories(long entryId)
                                                        throws SystemException

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetCategories

public static List<AssetCategory> getAssetEntryAssetCategories(long entryId,
                                                               int start,
                                                               int end)
                                                        throws SystemException

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetCategories

public static List<AssetCategory> getAssetEntryAssetCategories(long entryId,
                                                               int start,
                                                               int end,
                                                               OrderByComparator orderByComparator)
                                                        throws SystemException

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetCategoriesCount

public static int getAssetEntryAssetCategoriesCount(long entryId)
                                             throws SystemException

Throws:

SystemException - if a system exception occurred

hasAssetEntryAssetCategory

public static boolean hasAssetEntryAssetCategory(long entryId,
                                                 long categoryId)
                                          throws SystemException

Throws:

SystemException - if a system exception occurred

hasAssetEntryAssetCategories

public static boolean hasAssetEntryAssetCategories(long entryId)
                                            throws SystemException

Throws:

SystemException - if a system exception occurred

setAssetEntryAssetCategories

public static void setAssetEntryAssetCategories(long entryId,
                                                long[] categoryIds)
                                         throws SystemException

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addCategory

public static AssetCategory addCategory(long userId,
                                        long parentCategoryId,
                                        Map<Locale,String> titleMap,
                                        Map<Locale,String> descriptionMap,
                                        long vocabularyId,
                                        String[] categoryProperties,
                                        ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addCategoryResources

public static void addCategoryResources(AssetCategory category,
                                        boolean addGroupPermissions,
                                        boolean addGuestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

addCategoryResources

public static void addCategoryResources(AssetCategory category,
                                        String[] groupPermissions,
                                        String[] guestPermissions)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

deleteCategory

public static void deleteCategory(AssetCategory category)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteCategory

public static void deleteCategory(long categoryId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteVocabularyCategories

public static void deleteVocabularyCategories(long vocabularyId)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

fetchCategory

public static AssetCategory fetchCategory(long categoryId)
                                   throws SystemException

Throws:

SystemException

getCategories

public static List<AssetCategory> getCategories()
                                         throws SystemException

Throws:

SystemException

getCategories

public static List<AssetCategory> getCategories(long classNameId,
                                                long classPK)
                                         throws SystemException

Throws:

SystemException

getCategories

public static List<AssetCategory> getCategories(String className,
                                                long classPK)
                                         throws SystemException

Throws:

SystemException

getCategory

public static AssetCategory getCategory(long categoryId)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getCategory

public static AssetCategory getCategory(String uuid,
                                        long groupId)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getCategoryIds

public static long[] getCategoryIds(String className,
                                    long classPK)
                             throws SystemException

Throws:

SystemException

getCategoryNames

public static String[] getCategoryNames()
                                 throws SystemException

Throws:

SystemException

getCategoryNames

public static String[] getCategoryNames(long classNameId,
                                        long classPK)
                                 throws SystemException

Throws:

SystemException

getCategoryNames

public static String[] getCategoryNames(String className,
                                        long classPK)
                                 throws SystemException

Throws:

SystemException

getChildCategories

public static List<AssetCategory> getChildCategories(long parentCategoryId)
                                              throws SystemException

Throws:

SystemException

getChildCategories

public static List<AssetCategory> getChildCategories(long parentCategoryId,
                                                     int start,
                                                     int end,
                                                     OrderByComparator obc)
                                              throws SystemException

Throws:

SystemException

getChildCategoriesCount

public static int getChildCategoriesCount(long parentCategoryId)
                                   throws SystemException

Throws:

SystemException

getEntryCategories

public static List<AssetCategory> getEntryCategories(long entryId)
                                              throws SystemException

Throws:

SystemException

getVocabularyCategories

public static List<AssetCategory> getVocabularyCategories(long vocabularyId,
                                                          int start,
                                                          int end,
                                                          OrderByComparator obc)
                                                   throws SystemException

Throws:

SystemException

getVocabularyCategories

public static List<AssetCategory> getVocabularyCategories(long parentCategoryId,
                                                          long vocabularyId,
                                                          int start,
                                                          int end,
                                                          OrderByComparator obc)
                                                   throws SystemException

Throws:

SystemException

getVocabularyCategoriesCount

public static int getVocabularyCategoriesCount(long vocabularyId)
                                        throws SystemException

Throws:

SystemException

getVocabularyRootCategories

public static List<AssetCategory> getVocabularyRootCategories(long vocabularyId,
                                                              int start,
                                                              int end,
                                                              OrderByComparator obc)
                                                       throws SystemException

Throws:

SystemException

getVocabularyRootCategoriesCount

public static int getVocabularyRootCategoriesCount(long vocabularyId)
                                            throws SystemException

Throws:

SystemException

mergeCategories

public static void mergeCategories(long fromCategoryId,
                                   long toCategoryId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

moveCategory

public static AssetCategory moveCategory(long categoryId,
                                         long parentCategoryId,
                                         long vocabularyId,
                                         ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

rebuildTree

public static void rebuildTree(long groupId,
                               boolean force)
                        throws SystemException

Throws:

SystemException

search

public static List<AssetCategory> search(long groupId,
                                         String name,
                                         String[] categoryProperties,
                                         int start,
                                         int end)
                                  throws SystemException

Throws:

SystemException

updateCategory

public static AssetCategory updateCategory(long userId,
                                           long categoryId,
                                           long parentCategoryId,
                                           Map<Locale,String> titleMap,
                                           Map<Locale,String> descriptionMap,
                                           long vocabularyId,
                                           String[] categoryProperties,
                                           ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException

getService

public static AssetCategoryLocalService getService()

setService

public void setService(AssetCategoryLocalService service)

Deprecated.