Liferay 6.0.5

com.liferay.portlet.asset.service
Class AssetCategoryLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.asset.service.AssetCategoryLocalServiceUtil

public class AssetCategoryLocalServiceUtil
extends Object

The utility for the asset category local service. This utility wraps AssetCategoryLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to AssetCategoryLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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:
AssetCategoryLocalService, AssetCategoryLocalServiceBaseImpl, AssetCategoryLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

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

Constructor Detail

AssetCategoryLocalServiceUtil

public AssetCategoryLocalServiceUtil()
Method Detail

addAssetCategory

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static 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

public static int getAssetCategoriesCount()
                                   throws SystemException
Gets the number of asset categories.

Returns:
the number of asset categories
Throws:
SystemException - if a system exception occurred

updateAssetCategory

public static 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

public static 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

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

addCategoryResources

public static void addCategoryResources(AssetCategory category,
                                        boolean addCommunityPermissions,
                                        boolean addGuestPermissions)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

addCategoryResources

public static void addCategoryResources(AssetCategory category,
                                        String[] communityPermissions,
                                        String[] guestPermissions)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

deleteCategory

public static void deleteCategory(AssetCategory category)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteCategory

public static void deleteCategory(long categoryId)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

deleteVocabularyCategories

public static void deleteVocabularyCategories(long vocabularyId)
                                       throws PortalException,
                                              SystemException
Throws:
PortalException
SystemException

getCategories

public static List<AssetCategory> getCategories()
                                         throws SystemException
Throws:
SystemException

getCategories

public static List<AssetCategory> getCategories(long classNameId,
                                                long classPK)
                                         throws SystemException
Throws:
SystemException

getCategories

public static List<AssetCategory> getCategories(String className,
                                                long classPK)
                                         throws SystemException
Throws:
SystemException

getCategory

public static AssetCategory getCategory(long categoryId)
                                 throws PortalException,
                                        SystemException
Throws:
PortalException
SystemException

getCategoryIds

public static long[] getCategoryIds(String className,
                                    long classPK)
                             throws SystemException
Throws:
SystemException

getChildCategories

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

getChildCategoriesCount

public static int getChildCategoriesCount(long parentCategoryId)
                                   throws SystemException
Throws:
SystemException

getEntryCategories

public static List<AssetCategory> getEntryCategories(long entryId)
                                              throws SystemException
Throws:
SystemException

getVocabularyCategories

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

getVocabularyCategories

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

getVocabularyRootCategories

public static List<AssetCategory> getVocabularyRootCategories(long vocabularyId,
                                                              int start,
                                                              int end,
                                                              OrderByComparator obc)
                                                       throws SystemException
Throws:
SystemException

mergeCategories

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

search

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

updateCategory

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

getService

public static AssetCategoryLocalService getService()

setService

public void setService(AssetCategoryLocalService service)

Liferay 6.0.5