Liferay 6.1.2-ce-ga3

com.liferay.portlet.asset.service
Interface AssetCategoryLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
AssetCategoryLocalServiceWrapper

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

The interface for the asset category local service.

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, com.liferay.portlet.asset.service.base.AssetCategoryLocalServiceBaseImpl, com.liferay.portlet.asset.service.impl.AssetCategoryLocalServiceImpl

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

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

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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetCategory fetchAssetCategory(long categoryId)
                                 throws SystemException
Throws:
SystemException

getAssetCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getAssetCategoryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetCategoriesCount()
                            throws SystemException
Returns 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 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

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

void addAssetEntryAssetCategory(long entryId,
                                long categoryId)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

addAssetEntryAssetCategory

void addAssetEntryAssetCategory(long entryId,
                                AssetCategory assetCategory)
                                throws SystemException
Throws:
SystemException - if a system exception occurred

addAssetEntryAssetCategories

void addAssetEntryAssetCategories(long entryId,
                                  long[] categoryIds)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

addAssetEntryAssetCategories

void addAssetEntryAssetCategories(long entryId,
                                  List<AssetCategory> AssetCategories)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

clearAssetEntryAssetCategories

void clearAssetEntryAssetCategories(long entryId)
                                    throws SystemException
Throws:
SystemException - if a system exception occurred

deleteAssetEntryAssetCategory

void deleteAssetEntryAssetCategory(long entryId,
                                   long categoryId)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

deleteAssetEntryAssetCategory

void deleteAssetEntryAssetCategory(long entryId,
                                   AssetCategory assetCategory)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

deleteAssetEntryAssetCategories

void deleteAssetEntryAssetCategories(long entryId,
                                     long[] categoryIds)
                                     throws SystemException
Throws:
SystemException - if a system exception occurred

deleteAssetEntryAssetCategories

void deleteAssetEntryAssetCategories(long entryId,
                                     List<AssetCategory> AssetCategories)
                                     throws SystemException
Throws:
SystemException - if a system exception occurred

getAssetEntryAssetCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getAssetEntryAssetCategories(long entryId)
                                                 throws SystemException
Throws:
SystemException - if a system exception occurred

getAssetEntryAssetCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getAssetEntryAssetCategories(long entryId,
                                                                                          int start,
                                                                                          int end)
                                                 throws SystemException
Throws:
SystemException - if a system exception occurred

getAssetEntryAssetCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getAssetEntryAssetCategories(long entryId,
                                                                                          int start,
                                                                                          int end,
                                                                                          OrderByComparator orderByComparator)
                                                 throws SystemException
Throws:
SystemException - if a system exception occurred

getAssetEntryAssetCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetEntryAssetCategoriesCount(long entryId)
                                      throws SystemException
Throws:
SystemException - if a system exception occurred

hasAssetEntryAssetCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasAssetEntryAssetCategory(long entryId,
                                                                            long categoryId)
                                   throws SystemException
Throws:
SystemException - if a system exception occurred

hasAssetEntryAssetCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasAssetEntryAssetCategories(long entryId)
                                     throws SystemException
Throws:
SystemException - if a system exception occurred

setAssetEntryAssetCategories

void setAssetEntryAssetCategories(long entryId,
                                  long[] categoryIds)
                                  throws SystemException
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addCategory

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

void addCategoryResources(AssetCategory category,
                          boolean addGroupPermissions,
                          boolean addGuestPermissions)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

addCategoryResources

void addCategoryResources(AssetCategory category,
                          String[] groupPermissions,
                          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

fetchCategory

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetCategory fetchCategory(long categoryId)
                            throws SystemException
Throws:
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

getCategory

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

getCategoryIds

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

getCategoryNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String[] getCategoryNames()
                          throws SystemException
Throws:
SystemException

getCategoryNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String[] getCategoryNames(long classNameId,
                                                                   long classPK)
                          throws SystemException
Throws:
SystemException

getCategoryNames

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

getChildCategories

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> getChildCategories(long parentCategoryId)
                                       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

getVocabularyCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getVocabularyCategoriesCount(long vocabularyId)
                                 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

getVocabularyRootCategoriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getVocabularyRootCategoriesCount(long vocabularyId)
                                     throws SystemException
Throws:
SystemException

mergeCategories

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

moveCategory

AssetCategory moveCategory(long categoryId,
                           long parentCategoryId,
                           long vocabularyId,
                           ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

rebuildTree

void rebuildTree(long groupId,
                 boolean force)
                 throws SystemException
Throws:
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetCategory> 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,
                             Map<Locale,String> descriptionMap,
                             long vocabularyId,
                             String[] categoryProperties,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3