Liferay 6.0.5

com.liferay.portlet.asset.service
Class AssetTagLocalServiceUtil

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

public class AssetTagLocalServiceUtil
extends Object

The utility for the asset tag local service. This utility wraps AssetTagLocalServiceImpl 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 AssetTagLocalServiceImpl 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:
AssetTagLocalService, AssetTagLocalServiceBaseImpl, AssetTagLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
AssetTagLocalServiceUtil()
           
 
Method Summary
static AssetTag addAssetTag(AssetTag assetTag)
          Adds the asset tag to the database.
static AssetTag addTag(long userId, String name, String[] tagProperties, ServiceContext serviceContext)
           
static void addTagResources(AssetTag tag, boolean addCommunityPermissions, boolean addGuestPermissions)
           
static void addTagResources(AssetTag tag, String[] communityPermissions, String[] guestPermissions)
           
static void checkTags(long userId, long groupId, String[] names)
           
static AssetTag createAssetTag(long tagId)
          Creates a new asset tag with the primary key.
static AssetTag decrementAssetCount(long tagId, long classNameId)
           
static void deleteAssetTag(AssetTag assetTag)
          Deletes the asset tag from the database.
static void deleteAssetTag(long tagId)
          Deletes the asset tag with the primary key from the database.
static void deleteTag(AssetTag tag)
           
static void deleteTag(long tagId)
           
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 AssetTag getAssetTag(long tagId)
          Gets the asset tag with the primary key.
static List<AssetTag> getAssetTags(int start, int end)
          Gets a range of all the asset tags.
static int getAssetTagsCount()
          Gets the number of asset tags.
static List<AssetTag> getEntryTags(long entryId)
           
static List<AssetTag> getGroupTags(long groupId)
           
static AssetTagLocalService getService()
           
static AssetTag getTag(long tagId)
           
static AssetTag getTag(long groupId, String name)
           
static long[] getTagIds(long groupId, String[] names)
           
static String[] getTagNames()
           
static String[] getTagNames(long classNameId, long classPK)
           
static String[] getTagNames(String className, long classPK)
           
static List<AssetTag> getTags()
           
static List<AssetTag> getTags(long classNameId, long classPK)
           
static List<AssetTag> getTags(long groupId, long classNameId, String name)
           
static List<AssetTag> getTags(long groupId, long classNameId, String name, int start, int end)
           
static List<AssetTag> getTags(String className, long classPK)
           
static int getTagsSize(long groupId, long classNameId, String name)
           
static boolean hasTag(long groupId, String name)
           
static AssetTag incrementAssetCount(long tagId, long classNameId)
           
static void mergeTags(long fromTagId, long toTagId)
           
static JSONArray search(long groupId, String name, String[] tagProperties, int start, int end)
           
 void setService(AssetTagLocalService service)
           
static AssetTag updateAssetTag(AssetTag assetTag)
          Updates the asset tag in the database.
static AssetTag updateAssetTag(AssetTag assetTag, boolean merge)
          Updates the asset tag in the database.
static AssetTag updateTag(long userId, long tagId, String name, String[] tagProperties, ServiceContext serviceContext)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AssetTagLocalServiceUtil

public AssetTagLocalServiceUtil()
Method Detail

addAssetTag

public static AssetTag addAssetTag(AssetTag assetTag)
                            throws SystemException
Adds the asset tag to the database. Also notifies the appropriate model listeners.

Parameters:
assetTag - the asset tag to add
Returns:
the asset tag that was added
Throws:
SystemException - if a system exception occurred

createAssetTag

public static AssetTag createAssetTag(long tagId)
Creates a new asset tag with the primary key. Does not add the asset tag to the database.

Parameters:
tagId - the primary key for the new asset tag
Returns:
the new asset tag

deleteAssetTag

public static void deleteAssetTag(long tagId)
                           throws PortalException,
                                  SystemException
Deletes the asset tag with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
tagId - the primary key of the asset tag to delete
Throws:
PortalException - if a asset tag with the primary key could not be found
SystemException - if a system exception occurred

deleteAssetTag

public static void deleteAssetTag(AssetTag assetTag)
                           throws SystemException
Deletes the asset tag from the database. Also notifies the appropriate model listeners.

Parameters:
assetTag - the asset tag 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

getAssetTag

public static AssetTag getAssetTag(long tagId)
                            throws PortalException,
                                   SystemException
Gets the asset tag with the primary key.

Parameters:
tagId - the primary key of the asset tag to get
Returns:
the asset tag
Throws:
PortalException - if a asset tag with the primary key could not be found
SystemException - if a system exception occurred

getAssetTags

public static List<AssetTag> getAssetTags(int start,
                                          int end)
                                   throws SystemException
Gets a range of all the asset tags.

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 tags to return
end - the upper bound of the range of asset tags to return (not inclusive)
Returns:
the range of asset tags
Throws:
SystemException - if a system exception occurred

getAssetTagsCount

public static int getAssetTagsCount()
                             throws SystemException
Gets the number of asset tags.

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

updateAssetTag

public static AssetTag updateAssetTag(AssetTag assetTag)
                               throws SystemException
Updates the asset tag in the database. Also notifies the appropriate model listeners.

Parameters:
assetTag - the asset tag to update
Returns:
the asset tag that was updated
Throws:
SystemException - if a system exception occurred

updateAssetTag

public static AssetTag updateAssetTag(AssetTag assetTag,
                                      boolean merge)
                               throws SystemException
Updates the asset tag in the database. Also notifies the appropriate model listeners.

Parameters:
assetTag - the asset tag to update
merge - whether to merge the asset tag 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 tag that was updated
Throws:
SystemException - if a system exception occurred

addTag

public static AssetTag addTag(long userId,
                              String name,
                              String[] tagProperties,
                              ServiceContext serviceContext)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

addTagResources

public static void addTagResources(AssetTag tag,
                                   boolean addCommunityPermissions,
                                   boolean addGuestPermissions)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

addTagResources

public static void addTagResources(AssetTag tag,
                                   String[] communityPermissions,
                                   String[] guestPermissions)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

checkTags

public static void checkTags(long userId,
                             long groupId,
                             String[] names)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

decrementAssetCount

public static AssetTag decrementAssetCount(long tagId,
                                           long classNameId)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

deleteTag

public static void deleteTag(AssetTag tag)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

deleteTag

public static void deleteTag(long tagId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

getEntryTags

public static List<AssetTag> getEntryTags(long entryId)
                                   throws SystemException
Throws:
SystemException

getGroupTags

public static List<AssetTag> getGroupTags(long groupId)
                                   throws SystemException
Throws:
SystemException

getTag

public static AssetTag getTag(long tagId)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

getTag

public static AssetTag getTag(long groupId,
                              String name)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

getTagIds

public static long[] getTagIds(long groupId,
                               String[] names)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getTagNames

public static String[] getTagNames()
                            throws SystemException
Throws:
SystemException

getTagNames

public static String[] getTagNames(long classNameId,
                                   long classPK)
                            throws SystemException
Throws:
SystemException

getTagNames

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

getTags

public static List<AssetTag> getTags()
                              throws SystemException
Throws:
SystemException

getTags

public static List<AssetTag> getTags(long classNameId,
                                     long classPK)
                              throws SystemException
Throws:
SystemException

getTags

public static List<AssetTag> getTags(long groupId,
                                     long classNameId,
                                     String name)
                              throws SystemException
Throws:
SystemException

getTags

public static List<AssetTag> getTags(long groupId,
                                     long classNameId,
                                     String name,
                                     int start,
                                     int end)
                              throws SystemException
Throws:
SystemException

getTags

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

getTagsSize

public static int getTagsSize(long groupId,
                              long classNameId,
                              String name)
                       throws SystemException
Throws:
SystemException

hasTag

public static boolean hasTag(long groupId,
                             String name)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

incrementAssetCount

public static AssetTag incrementAssetCount(long tagId,
                                           long classNameId)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

mergeTags

public static void mergeTags(long fromTagId,
                             long toTagId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

search

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

updateTag

public static AssetTag updateTag(long userId,
                                 long tagId,
                                 String name,
                                 String[] tagProperties,
                                 ServiceContext serviceContext)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

getService

public static AssetTagLocalService getService()

setService

public void setService(AssetTagLocalService service)

Liferay 6.0.5