com.liferay.portlet.asset.service

Class AssetTagLocalServiceUtil

java.lang.Object

com.liferay.portlet.asset.service.AssetTagLocalServiceUtil

@ProviderType
public class AssetTagLocalServiceUtil
extends java.lang.Object

Provides the local service utility for AssetTag. This utility wraps com.liferay.portlet.asset.service.impl.AssetTagLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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.

Author:

Brian Wing Shun Chan

See Also:

AssetTagLocalService, com.liferay.portlet.asset.service.base.AssetTagLocalServiceBaseImpl, com.liferay.portlet.asset.service.impl.AssetTagLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
AssetTagLocalServiceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addAssetEntryAssetTag(long entryId, AssetTag assetTag)
static void	addAssetEntryAssetTag(long entryId, long tagId)
static void	addAssetEntryAssetTags(long entryId, java.util.List<AssetTag> AssetTags)
static void	addAssetEntryAssetTags(long entryId, long[] tagIds)
static AssetTag	addAssetTag(AssetTag assetTag) Adds the asset tag to the database.
static AssetTag	addTag(long userId, java.lang.String name, java.lang.String[] tagProperties, ServiceContext serviceContext)
static void	addTagResources(AssetTag tag, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addTagResources(AssetTag tag, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
static java.util.List<AssetTag>	checkTags(long userId, Group group, java.lang.String[] names) Returns the tags matching the group and names, creating new tags with the names if the group doesn't already have them.
static void	checkTags(long userId, long groupId, java.lang.String[] names)
static void	clearAssetEntryAssetTags(long entryId)
static AssetTag	createAssetTag(long tagId) Creates a new asset tag with the primary key.
static AssetTag	decrementAssetCount(long tagId, long classNameId)
static void	deleteAssetEntryAssetTag(long entryId, AssetTag assetTag)
static void	deleteAssetEntryAssetTag(long entryId, long tagId)
static void	deleteAssetEntryAssetTags(long entryId, java.util.List<AssetTag> AssetTags)
static void	deleteAssetEntryAssetTags(long entryId, long[] tagIds)
static AssetTag	deleteAssetTag(AssetTag assetTag) Deletes the asset tag from the database.
static AssetTag	deleteAssetTag(long tagId) Deletes the asset tag with the primary key from the database.
static void	deleteGroupTags(long groupId)
static void	deleteTag(AssetTag tag)
static void	deleteTag(long tagId)
static DynamicQuery	dynamicQuery()
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static java.util.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) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static AssetTag	fetchAssetTag(long tagId)
static java.util.List<AssetTag>	getAssetEntryAssetTags(long entryId)
static java.util.List<AssetTag>	getAssetEntryAssetTags(long entryId, int start, int end)
static java.util.List<AssetTag>	getAssetEntryAssetTags(long entryId, int start, int end, OrderByComparator orderByComparator)
static int	getAssetEntryAssetTagsCount(long entryId)
static AssetTag	getAssetTag(long tagId) Returns the asset tag with the primary key.
static java.util.List<AssetTag>	getAssetTags(int start, int end) Returns a range of all the asset tags.
static int	getAssetTagsCount() Returns the number of asset tags.
static java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static java.util.List<AssetTag>	getEntryTags(long entryId)
static java.util.List<AssetTag>	getGroupsTags(long[] groupIds)
static java.util.List<AssetTag>	getGroupTags(long groupId)
static java.util.List<AssetTag>	getGroupTags(long groupId, int start, int end)
static int	getGroupTagsCount(long groupId)
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static AssetTagLocalService	getService()
static java.util.List<AssetTag>	getSocialActivityCounterOffsetTags(long groupId, java.lang.String socialActivityCounterName, int startOffset, int endOffset)
static java.util.List<AssetTag>	getSocialActivityCounterPeriodTags(long groupId, java.lang.String socialActivityCounterName, int startPeriod, int endPeriod)
static AssetTag	getTag(long tagId)
static AssetTag	getTag(long groupId, java.lang.String name)
static long[]	getTagIds(long[] groupIds, java.lang.String name)
static long[]	getTagIds(long[] groupIds, java.lang.String[] names)
static long[]	getTagIds(long groupId, java.lang.String[] names)
static java.lang.String[]	getTagNames()
static java.lang.String[]	getTagNames(long classNameId, long classPK)
static java.lang.String[]	getTagNames(java.lang.String className, long classPK)
static java.util.List<AssetTag>	getTags()
static java.util.List<AssetTag>	getTags(long classNameId, long classPK)
static java.util.List<AssetTag>	getTags(long groupId, long classNameId, java.lang.String name)
static java.util.List<AssetTag>	getTags(long groupId, long classNameId, java.lang.String name, int start, int end)
static java.util.List<AssetTag>	getTags(java.lang.String className, long classPK)
static int	getTagsSize(long groupId, long classNameId, java.lang.String name)
static boolean	hasAssetEntryAssetTag(long entryId, long tagId)
static boolean	hasAssetEntryAssetTags(long entryId)
static boolean	hasTag(long groupId, java.lang.String name)
static AssetTag	incrementAssetCount(long tagId, long classNameId)
static void	mergeTags(long fromTagId, long toTagId, boolean overrideProperties)
static java.util.List<AssetTag>	search(long[] groupIds, java.lang.String name, java.lang.String[] tagProperties, int start, int end)
static java.util.List<AssetTag>	search(long groupId, java.lang.String name, java.lang.String[] tagProperties, int start, int end)
static void	setAssetEntryAssetTags(long entryId, long[] tagIds)
static void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(AssetTagLocalService service) Deprecated. As of 6.2.0
static AssetTag	updateAssetTag(AssetTag assetTag) Updates the asset tag in the database or adds it if it does not yet exist.
static AssetTag	updateTag(long userId, long tagId, java.lang.String name, java.lang.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

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 AssetTag 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

Returns:

the asset tag that was removed

Throws:

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

SystemException - if a system exception occurred

deleteAssetTag

public static AssetTag deleteAssetTag(AssetTag assetTag)
                               throws SystemException

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

Parameters:

assetTag - the asset tag

Returns:

the asset tag that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static java.util.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

public static java.util.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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AssetTagModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

public static java.util.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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AssetTagModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchAssetTag

public static AssetTag fetchAssetTag(long tagId)
                              throws SystemException

Throws:

SystemException

getAssetTag

public static AssetTag getAssetTag(long tagId)
                            throws PortalException,
                                   SystemException

Returns the asset tag with the primary key.

Parameters:

tagId - the primary key of the asset tag

Returns:

the asset tag

Throws:

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getAssetTags

public static java.util.List<AssetTag> getAssetTags(int start,
                                    int end)
                                             throws SystemException

Returns 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from AssetTagModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of asset tags

end - the upper bound of the range of asset tags (not inclusive)

Returns:

the range of asset tags

Throws:

SystemException - if a system exception occurred

getAssetTagsCount

public static int getAssetTagsCount()
                             throws SystemException

Returns 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 or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

assetTag - the asset tag

Returns:

the asset tag that was updated

Throws:

SystemException - if a system exception occurred

addAssetEntryAssetTag

public static void addAssetEntryAssetTag(long entryId,
                         long tagId)
                                  throws SystemException

Throws:

SystemException - if a system exception occurred

addAssetEntryAssetTag

public static void addAssetEntryAssetTag(long entryId,
                         AssetTag assetTag)
                                  throws SystemException

Throws:

SystemException - if a system exception occurred

addAssetEntryAssetTags

public static void addAssetEntryAssetTags(long entryId,
                          long[] tagIds)
                                   throws SystemException

Throws:

SystemException - if a system exception occurred

addAssetEntryAssetTags

public static void addAssetEntryAssetTags(long entryId,
                          java.util.List<AssetTag> AssetTags)
                                   throws SystemException

Throws:

SystemException - if a system exception occurred

clearAssetEntryAssetTags

public static void clearAssetEntryAssetTags(long entryId)
                                     throws SystemException

Throws:

SystemException - if a system exception occurred

deleteAssetEntryAssetTag

public static void deleteAssetEntryAssetTag(long entryId,
                            long tagId)
                                     throws SystemException

Throws:

SystemException - if a system exception occurred

deleteAssetEntryAssetTag

public static void deleteAssetEntryAssetTag(long entryId,
                            AssetTag assetTag)
                                     throws SystemException

Throws:

SystemException - if a system exception occurred

deleteAssetEntryAssetTags

public static void deleteAssetEntryAssetTags(long entryId,
                             long[] tagIds)
                                      throws SystemException

Throws:

SystemException - if a system exception occurred

deleteAssetEntryAssetTags

public static void deleteAssetEntryAssetTags(long entryId,
                             java.util.List<AssetTag> AssetTags)
                                      throws SystemException

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetTags

public static java.util.List<AssetTag> getAssetEntryAssetTags(long entryId)
                                                       throws SystemException

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetTags

public static java.util.List<AssetTag> getAssetEntryAssetTags(long entryId,
                                              int start,
                                              int end)
                                                       throws SystemException

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetTags

public static java.util.List<AssetTag> getAssetEntryAssetTags(long entryId,
                                              int start,
                                              int end,
                                              OrderByComparator orderByComparator)
                                                       throws SystemException

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetTagsCount

public static int getAssetEntryAssetTagsCount(long entryId)
                                       throws SystemException

Throws:

SystemException - if a system exception occurred

hasAssetEntryAssetTag

public static boolean hasAssetEntryAssetTag(long entryId,
                            long tagId)
                                     throws SystemException

Throws:

SystemException - if a system exception occurred

hasAssetEntryAssetTags

public static boolean hasAssetEntryAssetTags(long entryId)
                                      throws SystemException

Throws:

SystemException - if a system exception occurred

setAssetEntryAssetTags

public static void setAssetEntryAssetTags(long entryId,
                          long[] tagIds)
                                   throws SystemException

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addTag

public static AssetTag addTag(long userId,
              java.lang.String name,
              java.lang.String[] tagProperties,
              ServiceContext serviceContext)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

addTagResources

public static void addTagResources(AssetTag tag,
                   boolean addGroupPermissions,
                   boolean addGuestPermissions)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

addTagResources

public static void addTagResources(AssetTag tag,
                   java.lang.String[] groupPermissions,
                   java.lang.String[] guestPermissions)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

checkTags

public static java.util.List<AssetTag> checkTags(long userId,
                                 Group group,
                                 java.lang.String[] names)
                                          throws PortalException,
                                                 SystemException

Returns the tags matching the group and names, creating new tags with the names if the group doesn't already have them.

For each name, if a tag with that name doesn't already exist for the group, this method creates a new tag with that name for the group. If a tag with that name already exists in the company group, this method copies that company group's tag's properties to the group's new tag.

Parameters:

userId - the primary key of the user

group - ID the primary key of the tag's group

names - the tag names

Returns:

the tags matching the group and names and new tags matching the names that don't already exist for the group

Throws:

PortalException - if a matching group could not be found, if the tag's key or value were invalid, or if a portal exception occurred

SystemException - if a system exception occurred

checkTags

public static void checkTags(long userId,
             long groupId,
             java.lang.String[] names)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

decrementAssetCount

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

Throws:

PortalException

SystemException

deleteGroupTags

public static void deleteGroupTags(long groupId)
                            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 java.util.List<AssetTag> getEntryTags(long entryId)
                                             throws SystemException

Throws:

SystemException

getGroupsTags

public static java.util.List<AssetTag> getGroupsTags(long[] groupIds)
                                              throws SystemException

Throws:

SystemException

getGroupTags

public static java.util.List<AssetTag> getGroupTags(long groupId)
                                             throws SystemException

Throws:

SystemException

getGroupTags

public static java.util.List<AssetTag> getGroupTags(long groupId,
                                    int start,
                                    int end)
                                             throws SystemException

Throws:

SystemException

getGroupTagsCount

public static int getGroupTagsCount(long groupId)
                             throws SystemException

Throws:

SystemException

getSocialActivityCounterOffsetTags

public static java.util.List<AssetTag> getSocialActivityCounterOffsetTags(long groupId,
                                                          java.lang.String socialActivityCounterName,
                                                          int startOffset,
                                                          int endOffset)
                                                                   throws SystemException

Throws:

SystemException

getSocialActivityCounterPeriodTags

public static java.util.List<AssetTag> getSocialActivityCounterPeriodTags(long groupId,
                                                          java.lang.String socialActivityCounterName,
                                                          int startPeriod,
                                                          int endPeriod)
                                                                   throws SystemException

Throws:

SystemException

getTag

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

Throws:

PortalException

SystemException

getTag

public static AssetTag getTag(long groupId,
              java.lang.String name)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getTagIds

public static long[] getTagIds(long groupId,
               java.lang.String[] names)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getTagIds

public static long[] getTagIds(long[] groupIds,
               java.lang.String name)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getTagIds

public static long[] getTagIds(long[] groupIds,
               java.lang.String[] names)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getTagNames

public static java.lang.String[] getTagNames()
                                      throws SystemException

Throws:

SystemException

getTagNames

public static java.lang.String[] getTagNames(long classNameId,
                             long classPK)
                                      throws SystemException

Throws:

SystemException

getTagNames

public static java.lang.String[] getTagNames(java.lang.String className,
                             long classPK)
                                      throws SystemException

Throws:

SystemException

getTags

public static java.util.List<AssetTag> getTags()
                                        throws SystemException

Throws:

SystemException

getTags

public static java.util.List<AssetTag> getTags(long classNameId,
                               long classPK)
                                        throws SystemException

Throws:

SystemException

getTags

public static java.util.List<AssetTag> getTags(long groupId,
                               long classNameId,
                               java.lang.String name)
                                        throws SystemException

Throws:

SystemException

getTags

public static java.util.List<AssetTag> getTags(long groupId,
                               long classNameId,
                               java.lang.String name,
                               int start,
                               int end)
                                        throws SystemException

Throws:

SystemException

getTags

public static java.util.List<AssetTag> getTags(java.lang.String className,
                               long classPK)
                                        throws SystemException

Throws:

SystemException

getTagsSize

public static int getTagsSize(long groupId,
              long classNameId,
              java.lang.String name)
                       throws SystemException

Throws:

SystemException

hasTag

public static boolean hasTag(long groupId,
             java.lang.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,
             boolean overrideProperties)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

search

public static java.util.List<AssetTag> search(long groupId,
                              java.lang.String name,
                              java.lang.String[] tagProperties,
                              int start,
                              int end)
                                       throws SystemException

Throws:

SystemException

search

public static java.util.List<AssetTag> search(long[] groupIds,
                              java.lang.String name,
                              java.lang.String[] tagProperties,
                              int start,
                              int end)
                                       throws SystemException

Throws:

SystemException

updateTag

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

Throws:

PortalException

SystemException

getService

public static AssetTagLocalService getService()

setService

public void setService(AssetTagLocalService service)

Deprecated. As of 6.2.0