com.liferay.asset.kernel.service

Class AssetCategoryServiceUtil

Object

com.liferay.asset.kernel.service.AssetCategoryServiceUtil

public class AssetCategoryServiceUtil
extends Object

Provides the remote service utility for AssetCategory. This utility wraps com.liferay.portlet.asset.service.impl.AssetCategoryServiceImpl and is an access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

Author:

Brian Wing Shun Chan

See Also:

AssetCategoryService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
AssetCategoryServiceUtil()

Method Summary

Modifier and Type	Method and Description
static AssetCategory	addCategory(long groupId, long parentCategoryId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) NOTE FOR DEVELOPERS: Never modify or reference this interface directly.
static AssetCategory	addCategory(long groupId, String title, long vocabularyId, ServiceContext serviceContext)
static void	deleteCategories(long[] categoryIds)
static List<AssetCategory>	deleteCategories(long[] categoryIds, ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), Replaced by deleteCategories(long[])
static void	deleteCategory(long categoryId)
static AssetCategory	fetchCategory(long categoryId)
static List<AssetCategory>	getCategories(long classNameId, long classPK, int start, int end) Returns a range of assetCategories related to an AssetEntry with the given "classNameId-classPK".
static List<AssetCategory>	getCategories(String className, long classPK)
static int	getCategoriesCount(long classNameId, long classPK) Returns the number of assetCategories related to an AssetEntry with the given "classNameId-classPK".
static AssetCategory	getCategory(long categoryId)
static String	getCategoryPath(long categoryId)
static List<AssetCategory>	getChildCategories(long parentCategoryId)
static List<AssetCategory>	getChildCategories(long parentCategoryId, int start, int end, OrderByComparator<AssetCategory> obc) eturns a range of child assetCategories.
static int	getChildCategoriesCount(long parentCategoryId) Returns the number of child categories
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static AssetCategoryService	getService()
static List<AssetCategory>	getVocabularyCategories(long vocabularyId, int start, int end, OrderByComparator<AssetCategory> obc)
static List<AssetCategory>	getVocabularyCategories(long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> obc)
static List<AssetCategory>	getVocabularyCategories(long groupId, long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> obc)
static List<AssetCategory>	getVocabularyCategories(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> obc)
static int	getVocabularyCategoriesCount(long groupId, long vocabularyId)
static int	getVocabularyCategoriesCount(long groupId, long parentCategory, long vocabularyId)
static int	getVocabularyCategoriesCount(long groupId, String name, long vocabularyId)
static AssetCategoryDisplay	getVocabularyCategoriesDisplay(long vocabularyId, int start, int end, OrderByComparator<AssetCategory> obc)
static AssetCategoryDisplay	getVocabularyCategoriesDisplay(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> obc)
static List<AssetCategory>	getVocabularyRootCategories(long groupId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> obc)
static int	getVocabularyRootCategoriesCount(long groupId, long vocabularyId)
static AssetCategory	moveCategory(long categoryId, long parentCategoryId, long vocabularyId, ServiceContext serviceContext)
static JSONArray	search(long[] groupIds, String name, long[] vocabularyIds, int start, int end)
static List<AssetCategory>	search(long groupId, String keywords, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> obc)
static JSONArray	search(long groupId, String name, String[] categoryProperties, int start, int end)
static AssetCategoryDisplay	searchCategoriesDisplay(long[] groupIds, String title, long[] vocabularyIds, int start, int end)
static AssetCategoryDisplay	searchCategoriesDisplay(long[] groupIds, String title, long[] parentCategoryIds, long[] vocabularyIds, int start, int end)
static AssetCategoryDisplay	searchCategoriesDisplay(long[] groupIds, String title, long[] vocabularyIds, long[] parentCategoryIds, int start, int end, Sort sort)
static AssetCategoryDisplay	searchCategoriesDisplay(long groupId, String title, long vocabularyId, int start, int end)
static AssetCategoryDisplay	searchCategoriesDisplay(long groupId, String title, long parentCategoryId, long vocabularyId, int start, int end)
static AssetCategoryDisplay	searchCategoriesDisplay(long groupId, String title, long vocabularyId, long parentCategoryId, int start, int end, Sort sort)
static AssetCategory	updateCategory(long categoryId, long parentCategoryId, Map<Locale,String> titleMap, Map<Locale,String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext)

Methods inherited from class Object

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

Constructor Detail

AssetCategoryServiceUtil

public AssetCategoryServiceUtil()

Method Detail

addCategory

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

NOTE FOR DEVELOPERS: Never modify or reference this interface directly. Always use AssetCategoryServiceUtil to access the asset category remote service. Add custom service methods to com.liferay.portlet.asset.service.impl.AssetCategoryServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

Throws:

PortalException

addCategory

public static AssetCategory addCategory(long groupId,
                                        String title,
                                        long vocabularyId,
                                        ServiceContext serviceContext)
                                 throws PortalException

Throws:

PortalException

deleteCategories

public static void deleteCategories(long[] categoryIds)
                             throws PortalException

Throws:

PortalException

deleteCategories

@Deprecated
public static List<AssetCategory> deleteCategories(long[] categoryIds,
                                                               ServiceContext serviceContext)
                                                        throws PortalException

Deprecated. As of Wilberforce (7.0.x), Replaced by deleteCategories(long[])

Throws:

PortalException

deleteCategory

public static void deleteCategory(long categoryId)
                           throws PortalException

Throws:

PortalException

fetchCategory

public static AssetCategory fetchCategory(long categoryId)
                                   throws PortalException

Throws:

PortalException

getCategories

public static List<AssetCategory> getCategories(long classNameId,
                                                long classPK,
                                                int start,
                                                int end)

Returns a range of assetCategories related to an AssetEntry with the given "classNameId-classPK".

Parameters:

classNameId - the className of the asset

classPK - the classPK of the asset

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

Returns:

the matching assetCategories

getCategories

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

Throws:

PortalException

getCategoriesCount

public static int getCategoriesCount(long classNameId,
                                     long classPK)

Returns the number of assetCategories related to an AssetEntry with the given "classNameId-classPK".

Parameters:

classNameId - the className of the asset

classPK - the classPK of the asset

Returns:

the number of matching assetCategories

getCategory

public static AssetCategory getCategory(long categoryId)
                                 throws PortalException

Throws:

PortalException

getCategoryPath

public static String getCategoryPath(long categoryId)
                              throws PortalException

Throws:

PortalException

getChildCategories

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

Throws:

PortalException

getChildCategories

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

eturns a range of child assetCategories.

Parameters:

parentCategoryId - the parent category ID

start - the lower bound of the range of results

end - the upper bound of the range of results (not inclusive)

obc - the comparator

Returns:

the matching categories

Throws:

PortalException

getChildCategoriesCount

public static int getChildCategoriesCount(long parentCategoryId)
                                   throws PortalException

Returns the number of child categories

Parameters:

parentCategoryId - the parent category ID

Returns:

the number of child categories

Throws:

PortalException

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getVocabularyCategories

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

Throws:

PortalException

getVocabularyCategories

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

Throws:

PortalException

getVocabularyCategories

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

getVocabularyCategories

public static List<AssetCategory> getVocabularyCategories(long groupId,
                                                          String name,
                                                          long vocabularyId,
                                                          int start,
                                                          int end,
                                                          OrderByComparator<AssetCategory> obc)

getVocabularyCategoriesCount

public static int getVocabularyCategoriesCount(long groupId,
                                               long vocabularyId)

getVocabularyCategoriesCount

public static int getVocabularyCategoriesCount(long groupId,
                                               long parentCategory,
                                               long vocabularyId)

getVocabularyCategoriesCount

public static int getVocabularyCategoriesCount(long groupId,
                                               String name,
                                               long vocabularyId)

getVocabularyCategoriesDisplay

public static AssetCategoryDisplay getVocabularyCategoriesDisplay(long vocabularyId,
                                                                  int start,
                                                                  int end,
                                                                  OrderByComparator<AssetCategory> obc)
                                                           throws PortalException

Throws:

PortalException

getVocabularyCategoriesDisplay

public static AssetCategoryDisplay getVocabularyCategoriesDisplay(long groupId,
                                                                  String name,
                                                                  long vocabularyId,
                                                                  int start,
                                                                  int end,
                                                                  OrderByComparator<AssetCategory> obc)
                                                           throws PortalException

Throws:

PortalException

getVocabularyRootCategories

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

getVocabularyRootCategoriesCount

public static int getVocabularyRootCategoriesCount(long groupId,
                                                   long vocabularyId)

moveCategory

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

Throws:

PortalException

search

public static List<AssetCategory> search(long groupId,
                                         String keywords,
                                         long vocabularyId,
                                         int start,
                                         int end,
                                         OrderByComparator<AssetCategory> obc)

search

public static JSONArray search(long groupId,
                               String name,
                               String[] categoryProperties,
                               int start,
                               int end)
                        throws PortalException

Throws:

PortalException

search

public static JSONArray search(long[] groupIds,
                               String name,
                               long[] vocabularyIds,
                               int start,
                               int end)
                        throws PortalException

Throws:

PortalException

searchCategoriesDisplay

public static AssetCategoryDisplay searchCategoriesDisplay(long groupId,
                                                           String title,
                                                           long vocabularyId,
                                                           int start,
                                                           int end)
                                                    throws PortalException

Throws:

PortalException

searchCategoriesDisplay

public static AssetCategoryDisplay searchCategoriesDisplay(long groupId,
                                                           String title,
                                                           long parentCategoryId,
                                                           long vocabularyId,
                                                           int start,
                                                           int end)
                                                    throws PortalException

Throws:

PortalException

searchCategoriesDisplay

public static AssetCategoryDisplay searchCategoriesDisplay(long groupId,
                                                           String title,
                                                           long vocabularyId,
                                                           long parentCategoryId,
                                                           int start,
                                                           int end,
                                                           Sort sort)
                                                    throws PortalException

Throws:

PortalException

searchCategoriesDisplay

public static AssetCategoryDisplay searchCategoriesDisplay(long[] groupIds,
                                                           String title,
                                                           long[] vocabularyIds,
                                                           int start,
                                                           int end)
                                                    throws PortalException

Throws:

PortalException

searchCategoriesDisplay

public static AssetCategoryDisplay searchCategoriesDisplay(long[] groupIds,
                                                           String title,
                                                           long[] parentCategoryIds,
                                                           long[] vocabularyIds,
                                                           int start,
                                                           int end)
                                                    throws PortalException

Throws:

PortalException

searchCategoriesDisplay

public static AssetCategoryDisplay searchCategoriesDisplay(long[] groupIds,
                                                           String title,
                                                           long[] vocabularyIds,
                                                           long[] parentCategoryIds,
                                                           int start,
                                                           int end,
                                                           Sort sort)
                                                    throws PortalException

Throws:

PortalException

updateCategory

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

Throws:

PortalException

getService

public static AssetCategoryService getService()