com.liferay.portlet.asset.service
Class AssetTagLocalServiceUtil

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

@ProviderType
public class AssetTagLocalServiceUtil
extends 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.

See Also:

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

Constructor Summary

AssetTagLocalServiceUtil()

Method Summary

static void	addAssetEntryAssetTag(long entryId, AssetTag assetTag)
static void	addAssetEntryAssetTag(long entryId, long tagId)
static void	addAssetEntryAssetTags(long entryId, 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, String name, String[] tagProperties, ServiceContext serviceContext) Adds an asset tag.
static void	addTagResources(AssetTag tag, boolean addGroupPermissions, boolean addGuestPermissions) Adds resources for the asset tag.
static void	addTagResources(AssetTag tag, String[] groupPermissions, String[] guestPermissions) Adds resources for the asset tag using the group and guest permissions.
static List<AssetTag>	checkTags(long userId, Group group, String[] names) Returns the asset tags matching the group and names, creating new asset tags matching the names if the group doesn't already have them.
static void	checkTags(long userId, long groupId, String[] names) Returns the asset tags matching the group and names, creating new asset tags matching the names if the group doesn't already have them.
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) Decrements the number of assets to which the asset tag has been applied.
static void	deleteAssetEntryAssetTag(long entryId, AssetTag assetTag)
static void	deleteAssetEntryAssetTag(long entryId, long tagId)
static void	deleteAssetEntryAssetTags(long entryId, 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) Deletes all asset tags in the group.
static void	deleteTag(AssetTag tag) Deletes the asset tag.
static void	deleteTag(long tagId) Deletes the asset tag.
static DynamicQuery	dynamicQuery()
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) 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 List<AssetTag>	getAssetEntryAssetTags(long entryId)
static List<AssetTag>	getAssetEntryAssetTags(long entryId, int start, int end)
static 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 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 String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static List<AssetTag>	getEntryTags(long entryId) Returns the asset tags of the asset entry.
static List<AssetTag>	getGroupsTags(long[] groupIds) Returns the asset tags in the groups.
static List<AssetTag>	getGroupTags(long groupId) Returns the asset tags in the group.
static List<AssetTag>	getGroupTags(long groupId, int start, int end) Returns a range of all the asset tags in the group.
static int	getGroupTagsCount(long groupId) Returns the number of asset tags in the group.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static AssetTagLocalService	getService()
static List<AssetTag>	getSocialActivityCounterOffsetTags(long groupId, String socialActivityCounterName, int startOffset, int endOffset)
static List<AssetTag>	getSocialActivityCounterPeriodTags(long groupId, String socialActivityCounterName, int startPeriod, int endPeriod)
static AssetTag	getTag(long tagId) Returns the asset tag with the primary key.
static AssetTag	getTag(long groupId, String name) Returns the asset tag with the name in the group.
static long[]	getTagIds(long[] groupIds, String name) Returns the primary keys of the asset tags with the name in the groups.
static long[]	getTagIds(long[] groupIds, String[] names) Returns the primary keys of the asset tags with the names in the groups.
static long[]	getTagIds(long groupId, String[] names) Returns the primary keys of the asset tags with the names in the group.
static String[]	getTagNames() Returns the names of all the asset tags.
static String[]	getTagNames(long classNameId, long classPK) Returns the names of the asset tags of the entity.
static String[]	getTagNames(String className, long classPK) Returns the names of the asset tags of the entity
static List<AssetTag>	getTags() Returns all the asset tags.
static List<AssetTag>	getTags(long classNameId, long classPK) Returns the asset tags of the entity.
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) Returns the asset tags of the entity.
static int	getTagsSize(long groupId, long classNameId, String name)
static boolean	hasAssetEntryAssetTag(long entryId, long tagId)
static boolean	hasAssetEntryAssetTags(long entryId)
static boolean	hasTag(long groupId, String name) Returns true if the group contains an asset tag with the name.
static AssetTag	incrementAssetCount(long tagId, long classNameId) Increments the number of assets to which the asset tag has been applied.
static void	mergeTags(long fromTagId, long toTagId, boolean overrideProperties) Replaces all occurrences of the first asset tag with the second asset tag and deletes the first asset tag.
static List<AssetTag>	search(long[] groupIds, String name, String[] tagProperties, int start, int end) Returns the asset tags in the groups whose names match the pattern and the properties.
static List<AssetTag>	search(long groupId, String name, String[] tagProperties, int start, int end) Returns the asset tags in the group whose names match the pattern and the properties.
static void	setAssetEntryAssetTags(long entryId, long[] tagIds)
static void	setBeanIdentifier(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, 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

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 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 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 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(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getAssetTags

public static 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,
                                          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,
                                             List<AssetTag> AssetTags)
                                      throws SystemException

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetTags

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

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetTags

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

Throws:

SystemException - if a system exception occurred

getAssetEntryAssetTags

public static 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 String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(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,
                              String name,
                              String[] tagProperties,
                              ServiceContext serviceContext)
                       throws PortalException,
                              SystemException

Adds an asset tag.

Parameters:

userId - the primary key of the user adding the asset tag

name - the asset tag's name

tagProperties - the tag's properties

serviceContext - the service context

Returns:

the asset tag that was added

Throws:

PortalException - if a user with the primary key could not be found, if an asset tag already exists with the name, or if a portal exception occurred

SystemException - if a system exception occurred

addTagResources

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

Adds resources for the asset tag.

Parameters:

tag - the asset tag for which to add resources

addGroupPermissions - whether to add group permissions

addGuestPermissions - whether to add guest permissions

Throws:

PortalException - if resources could not be added for the asset tag or if a portal exception occurred

SystemException - if a system exception occurred

addTagResources

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

Adds resources for the asset tag using the group and guest permissions.

Parameters:

tag - the asset tag for which to add resources

groupPermissions - the group permissions to be applied

guestPermissions - the guest permissions to be applied

Throws:

PortalException - if resources could not be added for the asset tag or if a portal exception occurred

SystemException - if a system exception occurred

checkTags

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

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

For each name, if an asset tag with the name doesn't already exist in the group, this method creates a new asset tag with the name in the group.

Parameters:

userId - the primary key of the user checking the asset tags

group - the group in which to check the asset tags

names - the asset tag names

Returns:

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

Throws:

PortalException - if a matching group could not be found or if a portal exception occurred

SystemException - if a system exception occurred

checkTags

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

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

Parameters:

userId - the primary key of the user checking the asset tags

groupId - the primary key of the group in which check the asset tags

names - the asset tag names

Throws:

PortalException - if a matching group could not be found or if a portal exception occurred

SystemException - if a system exception occurred

decrementAssetCount

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

Decrements the number of assets to which the asset tag has been applied.

Parameters:

tagId - the primary key of the asset tag

classNameId - the class name ID of the entity to which the asset tag had been applied

Returns:

the asset tag

Throws:

PortalException - if an asset tag with the primary key could not be found or if a portal exception occurred

SystemException - if a system exception occurred

deleteGroupTags

public static void deleteGroupTags(long groupId)
                            throws PortalException,
                                   SystemException

Deletes all asset tags in the group.

Parameters:

groupId - the primary key of the group in which to delete all asset tags

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

deleteTag

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

Deletes the asset tag.

Parameters:

tag - the asset tag to be deleted

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

deleteTag

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

Deletes the asset tag.

Parameters:

tagId - the primary key of the asset tag

Throws:

PortalException - if no asset tag could be found with the primary key or if a portal exception occurred

SystemException - if a system exception occurred

getEntryTags

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

Returns the asset tags of the asset entry.

Parameters:

entryId - the primary key of the asset entry

Returns:

the asset tags of the asset entry

Throws:

SystemException - if a system exception occurred

getGroupsTags

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

Returns the asset tags in the groups.

Parameters:

groupIds - the primary keys of the groups

Returns:

the asset tags in the groups

Throws:

SystemException - if a system exception occurred

getGroupTags

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

Returns the asset tags in the group.

Parameters:

groupId - the primary key of the group

Returns:

the asset tags in the group

Throws:

SystemException - if a system exception occurred

getGroupTags

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

Returns a range of all the asset tags in the group.

Parameters:

groupId - the primary key of the group

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 matching asset tags

Throws:

SystemException - if a system exception occurred

getGroupTagsCount

public static int getGroupTagsCount(long groupId)
                             throws SystemException

Returns the number of asset tags in the group.

Parameters:

groupId - the primary key of the group

Returns:

the number of asset tags in the group

Throws:

SystemException - if a system exception occurred

getSocialActivityCounterOffsetTags

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

Throws:

SystemException

getSocialActivityCounterPeriodTags

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

Throws:

SystemException

getTag

public static AssetTag getTag(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 with the primary key

Throws:

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

SystemException - if a system exception occurred

getTag

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

Returns the asset tag with the name in the group.

Parameters:

groupId - the primary key of the group

name - the name of the asset tag

Returns:

the asset tag with the name in the group

Throws:

PortalException - if a matching asset tag could not be found

SystemException - if a system exception occurred

getTagIds

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

Returns the primary keys of the asset tags with the names in the group.

Parameters:

groupId - the primary key of the group

names - the names of the asset tags

Returns:

the primary keys of the asset tags with the names in the group

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getTagIds

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

Returns the primary keys of the asset tags with the name in the groups.

Parameters:

groupIds - the primary keys of the groups

name - the name of the asset tags

Returns:

the primary keys of the asset tags with the name in the groups

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getTagIds

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

Returns the primary keys of the asset tags with the names in the groups.

Parameters:

groupIds - the primary keys of the groups

names - the names of the asset tags

Returns:

the primary keys of the asset tags with the names in the groups

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

getTagNames

public static String[] getTagNames()
                            throws SystemException

Returns the names of all the asset tags.

Returns:

the names of all the asset tags

Throws:

SystemException - if a system exception occurred

getTagNames

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

Returns the names of the asset tags of the entity.

Parameters:

classNameId - the class name ID of the entity

classPK - the primary key of the entity

Returns:

the names of the asset tags of the entity

Throws:

SystemException - if a system exception occurred

getTagNames

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

Returns the names of the asset tags of the entity

Parameters:

className - the class name of the entity

classPK - the primary key of the entity

Returns:

the names of the asset tags of the entity

Throws:

SystemException - if a system exception occurred

getTags

public static List<AssetTag> getTags()
                              throws SystemException

Returns all the asset tags.

Returns:

the asset tags

Throws:

SystemException - if a system exception occurred

getTags

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

Returns the asset tags of the entity.

Parameters:

classNameId - the class name ID of the entity

classPK - the primary key of the entity

Returns:

the asset tags of the entity

Throws:

SystemException - if a system exception occurred

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

Returns the asset tags of the entity.

Parameters:

className - the class name of the entity

classPK - the primary key of the entity

Returns:

the asset tags of the entity

Throws:

SystemException - if a system exception occurred

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

Returns true if the group contains an asset tag with the name.

Parameters:

groupId - the primary key of the group

name - the name of the asset tag

Returns:

true if the group contains an asset tag with the name; false otherwise.

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

incrementAssetCount

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

Increments the number of assets to which the asset tag has been applied.

Parameters:

tagId - the primary key of the asset tag

classNameId - the class name ID of the entity to which the asset tag is being applied

Returns:

the asset tag

Throws:

PortalException - if a asset tag with the primary key could not be found or if a portal exception occurred

SystemException - if a system exception occurred

mergeTags

public static void mergeTags(long fromTagId,
                             long toTagId,
                             boolean overrideProperties)
                      throws PortalException,
                             SystemException

Replaces all occurrences of the first asset tag with the second asset tag and deletes the first asset tag.

Parameters:

fromTagId - the primary key of the asset tag to be replaced

toTagId - the primary key of the asset tag to apply to the asset entries of the other asset tag

overrideProperties - whether to override the properties of the second asset tag with the properties of the first asset tag

Throws:

PortalException - if a portal exception occurred

SystemException - if a system exception occurred

search

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

Returns the asset tags in the group whose names match the pattern and the properties.

Parameters:

groupId - the primary key of the group

name - the pattern to match

tagProperties - the properties to match

start - the lower bound of the range of asset tags

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

Returns:

the asset tags in the group whose names match the pattern

Throws:

SystemException - if a system exception occurred

search

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

Returns the asset tags in the groups whose names match the pattern and the properties.

Parameters:

groupIds - the primary keys of the groups

name - the pattern to match

tagProperties - the properties to match

start - the lower bound of the range of asset tags

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

Returns:

the asset tags in the groups whose names match the pattern

Throws:

SystemException - if a system exception occurred

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)

Deprecated. As of 6.2.0