Package com.liferay.asset.kernel.service
Interface AssetCategoryService
- All Superinterfaces:
BaseService
- All Known Implementing Classes:
AssetCategoryServiceWrapper
@AccessControlled
@CTAware
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={PortalException.class,SystemException.class})
public interface AssetCategoryService
extends BaseService
Provides the remote service interface for AssetCategory. 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}
-
Method Summary
Modifier and TypeMethodDescriptionaddCategory
(long groupId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) addCategory
(long groupId, String title, long vocabularyId, ServiceContext serviceContext) addCategory
(String externalReferenceCode, long groupId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) void
deleteCategories
(long[] categoryIds) void
deleteCategory
(long categoryId) fetchCategory
(long categoryId) fetchCategoryByExternalReferenceCode
(String externalReferenceCode, long groupId) getAssetCategoryByExternalReferenceCode
(long groupId, String externalReferenceCode) getCategories
(long classNameId, long classPK, int start, int end) Returns a range of assetCategories related to an AssetEntry with the given "classNameId-classPK".getCategories
(String className, long classPK) int
getCategoriesCount
(long classNameId, long classPK) Returns the number of assetCategories related to an AssetEntry with the given "classNameId-classPK".getCategory
(long categoryId) getCategoryPath
(long categoryId) getChildCategories
(long parentCategoryId) getChildCategories
(long parentCategoryId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) eturns a range of child assetCategories.int
getChildCategoriesCount
(long parentCategoryId) Returns the number of child categoriesReturns the OSGi service identifier.getVocabularyCategories
(long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) getVocabularyCategories
(long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) getVocabularyCategories
(long groupId, long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) getVocabularyCategories
(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) int
getVocabularyCategoriesCount
(long groupId, long vocabularyId) int
getVocabularyCategoriesCount
(long groupId, long parentCategory, long vocabularyId) int
getVocabularyCategoriesCount
(long groupId, String name, long vocabularyId) getVocabularyCategoriesDisplay
(long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) getVocabularyCategoriesDisplay
(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) getVocabularyRootCategories
(long groupId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) int
getVocabularyRootCategoriesCount
(long groupId, long vocabularyId) moveCategory
(long categoryId, long parentCategoryId, long vocabularyId, ServiceContext serviceContext) search
(long groupId, String keywords, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) searchCategoriesDisplay
(long[] groupIds, String title, long[] vocabularyIds, int start, int end) searchCategoriesDisplay
(long[] groupIds, String title, long[] parentCategoryIds, long[] vocabularyIds, int start, int end) searchCategoriesDisplay
(long[] groupIds, String title, long[] vocabularyIds, long[] parentCategoryIds, int start, int end, Sort sort) searchCategoriesDisplay
(long groupId, String title, long vocabularyId, int start, int end) searchCategoriesDisplay
(long groupId, String title, long parentCategoryId, long vocabularyId, int start, int end) searchCategoriesDisplay
(long groupId, String title, long vocabularyId, long parentCategoryId, int start, int end, Sort sort) updateCategory
(long categoryId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, String> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext)
-
Method Details
-
addCategory
AssetCategory addCategory(long groupId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) - Throws:
PortalException
-
addCategory
AssetCategory addCategory(long groupId, String title, long vocabularyId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
addCategory
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
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategory fetchCategory(long categoryId) throws PortalException - Throws:
PortalException
-
fetchCategoryByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategory fetchCategoryByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException - Throws:
PortalException
-
getAssetCategoryByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategory getAssetCategoryByExternalReferenceCode(long groupId, String externalReferenceCode) throws PortalException - Throws:
PortalException
-
getCategories
@Transactional(propagation=SUPPORTS, readOnly=true) 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 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
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetCategory> getCategories(String className, long classPK) throws PortalException - Throws:
PortalException
-
getCategoriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategory getCategory(long categoryId) throws PortalException - Throws:
PortalException
-
getCategoryPath
@Transactional(propagation=SUPPORTS, readOnly=true) String getCategoryPath(long categoryId) throws PortalException - Throws:
PortalException
-
getChildCategories
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetCategory> getChildCategories(long parentCategoryId) throws PortalException - Throws:
PortalException
-
getChildCategories
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getVocabularyCategories
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetCategory> getVocabularyCategories(long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) throws PortalException - Throws:
PortalException
-
getVocabularyCategories
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetCategory> getVocabularyCategories(long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) throws PortalException - Throws:
PortalException
-
getVocabularyCategories
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetCategory> getVocabularyCategories(long groupId, long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) -
getVocabularyCategories
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetCategory> getVocabularyCategories(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) -
getVocabularyCategoriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getVocabularyCategoriesCount(long groupId, long vocabularyId) -
getVocabularyCategoriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getVocabularyCategoriesCount(long groupId, long parentCategory, long vocabularyId) -
getVocabularyCategoriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getVocabularyCategoriesCount(long groupId, String name, long vocabularyId) -
getVocabularyCategoriesDisplay
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategoryDisplay getVocabularyCategoriesDisplay(long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) throws PortalException - Throws:
PortalException
-
getVocabularyCategoriesDisplay
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategoryDisplay getVocabularyCategoriesDisplay(long groupId, String name, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) throws PortalException - Throws:
PortalException
-
getVocabularyRootCategories
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetCategory> getVocabularyRootCategories(long groupId, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) -
getVocabularyRootCategoriesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getVocabularyRootCategoriesCount(long groupId, long vocabularyId) -
moveCategory
AssetCategory moveCategory(long categoryId, long parentCategoryId, long vocabularyId, ServiceContext serviceContext) throws PortalException - Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<AssetCategory> search(long groupId, String keywords, long vocabularyId, int start, int end, OrderByComparator<AssetCategory> orderByComparator) -
search
@Transactional(propagation=SUPPORTS, readOnly=true) JSONArray search(long groupId, String name, String[] categoryProperties, int start, int end) throws PortalException - Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) JSONArray search(long[] groupIds, String name, long[] vocabularyIds, int start, int end) throws PortalException - Throws:
PortalException
-
searchCategoriesDisplay
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategoryDisplay searchCategoriesDisplay(long groupId, String title, long vocabularyId, int start, int end) throws PortalException - Throws:
PortalException
-
searchCategoriesDisplay
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategoryDisplay searchCategoriesDisplay(long groupId, String title, long parentCategoryId, long vocabularyId, int start, int end) throws PortalException - Throws:
PortalException
-
searchCategoriesDisplay
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategoryDisplay searchCategoriesDisplay(long groupId, String title, long vocabularyId, long parentCategoryId, int start, int end, Sort sort) throws PortalException - Throws:
PortalException
-
searchCategoriesDisplay
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategoryDisplay searchCategoriesDisplay(long[] groupIds, String title, long[] vocabularyIds, int start, int end) throws PortalException - Throws:
PortalException
-
searchCategoriesDisplay
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategoryDisplay searchCategoriesDisplay(long[] groupIds, String title, long[] parentCategoryIds, long[] vocabularyIds, int start, int end) throws PortalException - Throws:
PortalException
-
searchCategoriesDisplay
@Transactional(propagation=SUPPORTS, readOnly=true) AssetCategoryDisplay searchCategoriesDisplay(long[] groupIds, String title, long[] vocabularyIds, long[] parentCategoryIds, int start, int end, Sort sort) throws PortalException - Throws:
PortalException
-
updateCategory
AssetCategory updateCategory(long categoryId, long parentCategoryId, Map<Locale, String> titleMap, Map<Locale, throws PortalExceptionString> descriptionMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext) - Throws:
PortalException
-