com.liferay.portlet.asset.service
Interface AssetCategoryLocalService

All Known Implementing Classes:

AssetCategoryLocalServiceBaseImpl, AssetCategoryLocalServiceImpl, AssetCategoryLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AssetCategoryLocalService

The interface for the asset category local service.

Never modify or reference this interface directly. Always use AssetCategoryLocalServiceUtil to access the asset category local service. Add custom service methods to AssetCategoryLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:

AssetCategoryLocalServiceUtil, AssetCategoryLocalServiceBaseImpl, AssetCategoryLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

AssetCategory	addAssetCategory(AssetCategory assetCategory) Adds the asset category to the database.
AssetCategory	addCategory(long userId, long parentCategoryId, Map<Locale,String> titleMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext)
void	addCategoryResources(AssetCategory category, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addCategoryResources(AssetCategory category, String[] communityPermissions, String[] guestPermissions)
AssetCategory	createAssetCategory(long categoryId) Creates a new asset category with the primary key.
void	deleteAssetCategory(AssetCategory assetCategory) Deletes the asset category from the database.
void	deleteAssetCategory(long categoryId) Deletes the asset category with the primary key from the database.
void	deleteCategory(AssetCategory category)
void	deleteCategory(long categoryId)
void	deleteVocabularyCategories(long vocabularyId)
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
List<AssetCategory>	getAssetCategories(int start, int end) Gets a range of all the asset categories.
int	getAssetCategoriesCount() Gets the number of asset categories.
AssetCategory	getAssetCategory(long categoryId) Gets the asset category with the primary key.
AssetCategory	getAssetCategoryByUuidAndGroupId(String uuid, long groupId) Gets the asset category with the UUID and group id.
List<AssetCategory>	getCategories()
List<AssetCategory>	getCategories(long classNameId, long classPK)
List<AssetCategory>	getCategories(String className, long classPK)
AssetCategory	getCategory(long categoryId)
long[]	getCategoryIds(String className, long classPK)
List<AssetCategory>	getChildCategories(long parentCategoryId, int start, int end, OrderByComparator obc)
int	getChildCategoriesCount(long parentCategoryId)
List<AssetCategory>	getEntryCategories(long entryId)
List<AssetCategory>	getVocabularyCategories(long vocabularyId, int start, int end, OrderByComparator obc)
List<AssetCategory>	getVocabularyCategories(long parentCategoryId, long vocabularyId, int start, int end, OrderByComparator obc)
List<AssetCategory>	getVocabularyRootCategories(long vocabularyId, int start, int end, OrderByComparator obc)
void	mergeCategories(long fromCategoryId, long toCategoryId)
JSONArray	search(long groupId, String name, String[] categoryProperties, int start, int end)
AssetCategory	updateAssetCategory(AssetCategory assetCategory) Updates the asset category in the database.
AssetCategory	updateAssetCategory(AssetCategory assetCategory, boolean merge) Updates the asset category in the database.
AssetCategory	updateCategory(long userId, long categoryId, long parentCategoryId, Map<Locale,String> titleMap, long vocabularyId, String[] categoryProperties, ServiceContext serviceContext)

Method Detail

addAssetCategory

AssetCategory addAssetCategory(AssetCategory assetCategory)
                               throws SystemException

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

Parameters:

assetCategory - the asset category to add

Returns:

the asset category that was added

Throws:

SystemException - if a system exception occurred

createAssetCategory

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

void 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 to delete

Throws:

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

SystemException - if a system exception occurred

deleteAssetCategory

void deleteAssetCategory(AssetCategory assetCategory)
                         throws SystemException

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

Parameters:

assetCategory - the asset category to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

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 to search with

start - the lower bound of the range of model instances to return

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

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

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 to search with

start - the lower bound of the range of model instances to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getAssetCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetCategory getAssetCategory(long categoryId)
                               throws PortalException,
                                      SystemException

Gets the asset category with the primary key.

Parameters:

categoryId - the primary key of the asset category to get

Returns:

the asset category

Throws:

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

SystemException - if a system exception occurred

getAssetCategoryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetCategory getAssetCategoryByUuidAndGroupId(String uuid,
                                                                                        long groupId)
                                               throws PortalException,
                                                      SystemException

Gets the asset category with the UUID and group id.

Parameters:

uuid - the UUID of asset category to get

groupId - the group id of the asset category to get

Returns:

the asset category

Throws:

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

SystemException - if a system exception occurred

getAssetCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getAssetCategories(int start,
                                                                                int end)
                                       throws SystemException

Gets 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 to return

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

Returns:

the range of asset categories

Throws:

SystemException - if a system exception occurred

getAssetCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetCategoriesCount()
                            throws SystemException

Gets the number of asset categories.

Returns:

the number of asset categories

Throws:

SystemException - if a system exception occurred

updateAssetCategory

AssetCategory updateAssetCategory(AssetCategory assetCategory)
                                  throws SystemException

Updates the asset category in the database. Also notifies the appropriate model listeners.

Parameters:

assetCategory - the asset category to update

Returns:

the asset category that was updated

Throws:

SystemException - if a system exception occurred

updateAssetCategory

AssetCategory updateAssetCategory(AssetCategory assetCategory,
                                  boolean merge)
                                  throws SystemException

Updates the asset category in the database. Also notifies the appropriate model listeners.

Parameters:

assetCategory - the asset category to update

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

addCategory

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

Throws:

PortalException

SystemException

addCategoryResources

void addCategoryResources(AssetCategory category,
                          boolean addCommunityPermissions,
                          boolean addGuestPermissions)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

addCategoryResources

void addCategoryResources(AssetCategory category,
                          String[] communityPermissions,
                          String[] guestPermissions)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deleteCategory

void deleteCategory(AssetCategory category)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

deleteCategory

void deleteCategory(long categoryId)
                    throws PortalException,
                           SystemException

Throws:

PortalException

SystemException

deleteVocabularyCategories

void deleteVocabularyCategories(long vocabularyId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getCategories()
                                  throws SystemException

Throws:

SystemException

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getCategories(long classNameId,
                                                                           long classPK)
                                  throws SystemException

Throws:

SystemException

getCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getCategories(String className,
                                                                           long classPK)
                                  throws SystemException

Throws:

SystemException

getCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetCategory getCategory(long categoryId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

getCategoryIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getCategoryIds(String className,
                                                               long classPK)
                      throws SystemException

Throws:

SystemException

getChildCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getChildCategories(long parentCategoryId,
                                                                                int start,
                                                                                int end,
                                                                                OrderByComparator obc)
                                       throws SystemException

Throws:

SystemException

getChildCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getChildCategoriesCount(long parentCategoryId)
                            throws SystemException

Throws:

SystemException

getEntryCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getEntryCategories(long entryId)
                                       throws SystemException

Throws:

SystemException

getVocabularyCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getVocabularyCategories(long vocabularyId,
                                                                                     int start,
                                                                                     int end,
                                                                                     OrderByComparator obc)
                                            throws SystemException

Throws:

SystemException

getVocabularyCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getVocabularyCategories(long parentCategoryId,
                                                                                     long vocabularyId,
                                                                                     int start,
                                                                                     int end,
                                                                                     OrderByComparator obc)
                                            throws SystemException

Throws:

SystemException

getVocabularyRootCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getVocabularyRootCategories(long vocabularyId,
                                                                                         int start,
                                                                                         int end,
                                                                                         OrderByComparator obc)
                                                throws SystemException

Throws:

SystemException

mergeCategories

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

Throws:

PortalException

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
JSONArray search(long groupId,
                                                          String name,
                                                          String[] categoryProperties,
                                                          int start,
                                                          int end)
                 throws SystemException

Throws:

SystemException

updateCategory

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

Throws:

PortalException

SystemException