Package com.liferay.asset.kernel.service
Class AssetCategoryServiceUtil
Object
com.liferay.asset.kernel.service.AssetCategoryServiceUtil
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:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic AssetCategoryaddCategory(long groupId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) static AssetCategoryaddCategory(long groupId, String title, long vocabularyId, ServiceContext serviceContext) static AssetCategoryaddCategory(String externalReferenceCode, long groupId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) static voiddeleteCategories(long[] categoryIds) static voiddeleteCategory(long categoryId) static AssetCategoryfetchCategory(long categoryId) static AssetCategoryfetchCategoryByExternalReferenceCode(String externalReferenceCode, long groupId) static AssetCategorygetAssetCategoryByExternalReferenceCode(long groupId, String externalReferenceCode) 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 intgetCategoriesCount(long classNameId, long classPK) Returns the number of assetCategories related to an AssetEntry with the given "classNameId-classPK".static AssetCategorygetCategory(long categoryId) static StringgetCategoryPath(long categoryId) static List<AssetCategory>getChildCategories(long parentCategoryId) static List<AssetCategory>getChildCategories(long parentCategoryId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) eturns a range of child assetCategories.static intgetChildCategoriesCount(long parentCategoryId) Returns the number of child categoriesstatic StringReturns the OSGi service identifier.static AssetCategoryServicestatic List<AssetCategory>getVocabularyCategories(long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) static List<AssetCategory>getVocabularyCategories(long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) static List<AssetCategory>getVocabularyCategories(long groupId, long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) static List<AssetCategory>getVocabularyCategories(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) static intgetVocabularyCategoriesCount(long groupId, long vocabularyId) static intgetVocabularyCategoriesCount(long groupId, long parentCategory, long vocabularyId) static intgetVocabularyCategoriesCount(long groupId, String name, long vocabularyId) static AssetCategoryDisplaygetVocabularyCategoriesDisplay(long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) static AssetCategoryDisplaygetVocabularyCategoriesDisplay(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) static List<AssetCategory>getVocabularyRootCategories(long groupId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) static intgetVocabularyRootCategoriesCount(long groupId, long vocabularyId) static AssetCategorymoveCategory(long categoryId, long parentCategoryId, long vocabularyId, ServiceContext serviceContext) static JSONArraystatic List<AssetCategory>search(long groupId, String keywords, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) static JSONArraystatic AssetCategoryDisplaysearchCategoriesDisplay(long[] groupIds, String title, long[] vocabularyIds, int start, int end) static AssetCategoryDisplaysearchCategoriesDisplay(long[] groupIds, String title, long[] parentCategoryIds, long[] vocabularyIds, int start, int end) static AssetCategoryDisplaysearchCategoriesDisplay(long[] groupIds, String title, long[] vocabularyIds, long[] parentCategoryIds, int start, int end, Sort sort) static AssetCategoryDisplaysearchCategoriesDisplay(long groupId, String title, long vocabularyId, int start, int end) static AssetCategoryDisplaysearchCategoriesDisplay(long groupId, String title, long parentCategoryId, long vocabularyId, int start, int end) static AssetCategoryDisplaysearchCategoriesDisplay(long groupId, String title, long vocabularyId, long parentCategoryId, int start, int end, Sort sort) static voidsetService(AssetCategoryService service) static AssetCategoryupdateCategory(long categoryId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext)
-
Constructor Details
-
AssetCategoryServiceUtil
public AssetCategoryServiceUtil()
-
-
Method Details
-
addCategory
public static AssetCategory addCategory(long groupId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) - Throws:
PortalException
-
addCategory
public static AssetCategory addCategory(long groupId, String title, long vocabularyId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addCategory
public static AssetCategory addCategory(String externalReferenceCode, long groupId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) - Throws:
PortalException
-
deleteCategories
- Throws:
PortalException
-
deleteCategory
- Throws:
PortalException
-
fetchCategory
- Throws:
PortalException
-
fetchCategoryByExternalReferenceCode
public static AssetCategory fetchCategoryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getAssetCategoryByExternalReferenceCode
public static AssetCategory getAssetCategoryByExternalReferenceCode(long groupId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
getCategories
Returns a range of assetCategories related to an AssetEntry with the given "classNameId-classPK".- Parameters:
classNameId- the className of the assetclassPK- the classPK of the assetstart- the lower bound of the range of resultsend- 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 assetclassPK- the classPK of the asset- Returns:
- the number of matching assetCategories
-
getCategory
- Throws:
PortalException
-
getCategoryPath
- Throws:
PortalException
-
getChildCategories
- Throws:
PortalException
-
getChildCategories
public static List<AssetCategory> getChildCategories(long parentCategoryId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) throws PortalException eturns a range of child assetCategories.- Parameters:
parentCategoryId- the parent category IDstart- the lower bound of the range of resultsend- the upper bound of the range of results (not inclusive)orderByComparator- the comparator- Returns:
- the matching categories
- Throws:
PortalException
-
getChildCategoriesCount
Returns the number of child categories- Parameters:
parentCategoryId- the parent category ID- Returns:
- the number of child categories
- Throws:
PortalException
-
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> orderByComparator) throws PortalException - Throws:
PortalException
-
getVocabularyCategories
public static List<AssetCategory> getVocabularyCategories(long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) throws PortalException - Throws:
PortalException
-
getVocabularyCategories
public static List<AssetCategory> getVocabularyCategories(long groupId, long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) -
getVocabularyCategories
public static List<AssetCategory> getVocabularyCategories(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) -
getVocabularyCategoriesCount
public static int getVocabularyCategoriesCount(long groupId, long vocabularyId) -
getVocabularyCategoriesCount
public static int getVocabularyCategoriesCount(long groupId, long parentCategory, long vocabularyId) -
getVocabularyCategoriesCount
-
getVocabularyCategoriesDisplay
public static AssetCategoryDisplay getVocabularyCategoriesDisplay(long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) throws PortalException - Throws:
PortalException
-
getVocabularyCategoriesDisplay
public static AssetCategoryDisplay getVocabularyCategoriesDisplay(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) throws PortalException - Throws:
PortalException
-
getVocabularyRootCategories
public static List<AssetCategory> getVocabularyRootCategories(long groupId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) -
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> orderByComparator) -
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, throws PortalExceptionString> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) - Throws:
PortalException
-
getService
-
setService
-