com.liferay.portlet.asset.service.impl
Class AssetTagLocalServiceImpl

java.lang.Object
  com.liferay.portal.service.BaseLocalServiceImpl
      com.liferay.portlet.asset.service.base.AssetTagLocalServiceBaseImpl
          com.liferay.portlet.asset.service.impl.AssetTagLocalServiceImpl

All Implemented Interfaces:

IdentifiableBean, BaseLocalService, PersistedModelLocalService, AssetTagLocalService

public class AssetTagLocalServiceImpl
extends AssetTagLocalServiceBaseImpl

Provides the local service for accessing, adding, checking, deleting, merging, and updating asset tags.

Field Summary

Fields inherited from class com.liferay.portlet.asset.service.base.AssetTagLocalServiceBaseImpl

assetCategoryFinder, assetCategoryLocalService, assetCategoryPersistence, assetCategoryPropertyFinder, assetCategoryPropertyLocalService, assetCategoryPropertyPersistence, assetCategoryPropertyService, assetCategoryService, assetEntryFinder, assetEntryLocalService, assetEntryPersistence, assetEntryService, assetLinkLocalService, assetLinkPersistence, assetTagFinder, assetTagLocalService, assetTagPersistence, assetTagPropertyFinder, assetTagPropertyKeyFinder, assetTagPropertyLocalService, assetTagPropertyPersistence, assetTagPropertyService, assetTagService, assetTagStatsLocalService, assetTagStatsPersistence, assetVocabularyFinder, assetVocabularyLocalService, assetVocabularyPersistence, assetVocabularyService, counterLocalService, groupFinder, groupLocalService, groupPersistence, groupService, persistedModelLocalServiceRegistry, resourceLocalService, userFinder, userLocalService, userPersistence, userService

Fields inherited from class com.liferay.portal.service.BaseLocalServiceImpl

layoutPersistence

Constructor Summary

AssetTagLocalServiceImpl()

Method Summary

AssetTag	addTag(long userId, String name, String[] tagProperties, ServiceContext serviceContext) Adds an asset tag.
void	addTagResources(AssetTag tag, boolean addGroupPermissions, boolean addGuestPermissions) Adds resources for the asset tag.
void	addTagResources(AssetTag tag, String[] groupPermissions, String[] guestPermissions) Adds resources for the asset tag using the group and guest permissions.
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.
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.
AssetTag	decrementAssetCount(long tagId, long classNameId) Decrements the number of assets to which the asset tag has been applied.
void	deleteGroupTags(long groupId) Deletes all asset tags in the group.
void	deleteTag(AssetTag tag) Deletes the asset tag.
void	deleteTag(long tagId) Deletes the asset tag.
List<AssetTag>	getEntryTags(long entryId) Returns the asset tags of the asset entry.
List<AssetTag>	getGroupsTags(long[] groupIds) Returns the asset tags in the groups.
List<AssetTag>	getGroupTags(long groupId) Returns the asset tags in the group.
List<AssetTag>	getGroupTags(long groupId, int start, int end) Returns a range of all the asset tags in the group.
int	getGroupTagsCount(long groupId) Returns the number of asset tags in the group.
List<AssetTag>	getSocialActivityCounterOffsetTags(long groupId, String socialActivityCounterName, int startOffset, int endOffset)
List<AssetTag>	getSocialActivityCounterPeriodTags(long groupId, String socialActivityCounterName, int startPeriod, int endPeriod)
AssetTag	getTag(long tagId) Returns the asset tag with the primary key.
AssetTag	getTag(long groupId, String name) Returns the asset tag with the name in the group.
long[]	getTagIds(long[] groupIds, String name) Returns the primary keys of the asset tags with the name in the groups.
long[]	getTagIds(long[] groupIds, String[] names) Returns the primary keys of the asset tags with the names in the groups.
long[]	getTagIds(long groupId, String[] names) Returns the primary keys of the asset tags with the names in the group.
String[]	getTagNames() Returns the names of all the asset tags.
protected String[]	getTagNames(List<AssetTag> tags)
String[]	getTagNames(long classNameId, long classPK) Returns the names of the asset tags of the entity.
String[]	getTagNames(String className, long classPK) Returns the names of the asset tags of the entity
List<AssetTag>	getTags() Returns all the asset tags.
List<AssetTag>	getTags(long classNameId, long classPK) Returns the asset tags of the entity.
List<AssetTag>	getTags(long groupId, long classNameId, String name)
List<AssetTag>	getTags(long groupId, long classNameId, String name, int start, int end)
List<AssetTag>	getTags(String className, long classPK) Returns the asset tags of the entity.
int	getTagsSize(long groupId, long classNameId, String name)
boolean	hasTag(long groupId, String name) Returns true if the group contains an asset tag with the name.
AssetTag	incrementAssetCount(long tagId, long classNameId) Increments the number of assets to which the asset tag has been applied.
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.
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.
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.
AssetTag	updateTag(long userId, long tagId, String name, String[] tagProperties, ServiceContext serviceContext)
protected void	validate(String name)

Methods inherited from class com.liferay.portlet.asset.service.base.AssetTagLocalServiceBaseImpl

addAssetEntryAssetTag, addAssetEntryAssetTag, addAssetEntryAssetTags, addAssetEntryAssetTags, addAssetTag, afterPropertiesSet, clearAssetEntryAssetTags, createAssetTag, deleteAssetEntryAssetTag, deleteAssetEntryAssetTag, deleteAssetEntryAssetTags, deleteAssetEntryAssetTags, deleteAssetTag, deleteAssetTag, destroy, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQuery, dynamicQueryCount, dynamicQueryCount, fetchAssetTag, getAssetCategoryFinder, getAssetCategoryLocalService, getAssetCategoryPersistence, getAssetCategoryPropertyFinder, getAssetCategoryPropertyLocalService, getAssetCategoryPropertyPersistence, getAssetCategoryPropertyService, getAssetCategoryService, getAssetEntryAssetTags, getAssetEntryAssetTags, getAssetEntryAssetTags, getAssetEntryAssetTagsCount, getAssetEntryFinder, getAssetEntryLocalService, getAssetEntryPersistence, getAssetEntryService, getAssetLinkLocalService, getAssetLinkPersistence, getAssetTag, getAssetTagFinder, getAssetTagLocalService, getAssetTagPersistence, getAssetTagPropertyFinder, getAssetTagPropertyKeyFinder, getAssetTagPropertyLocalService, getAssetTagPropertyPersistence, getAssetTagPropertyService, getAssetTags, getAssetTagsCount, getAssetTagService, getAssetTagStatsLocalService, getAssetTagStatsPersistence, getAssetVocabularyFinder, getAssetVocabularyLocalService, getAssetVocabularyPersistence, getAssetVocabularyService, getBeanIdentifier, getCounterLocalService, getGroupFinder, getGroupLocalService, getGroupPersistence, getGroupService, getModelClass, getModelClassName, getPersistedModel, getResourceLocalService, getUserFinder, getUserLocalService, getUserPersistence, getUserService, hasAssetEntryAssetTag, hasAssetEntryAssetTags, runSQL, setAssetCategoryFinder, setAssetCategoryLocalService, setAssetCategoryPersistence, setAssetCategoryPropertyFinder, setAssetCategoryPropertyLocalService, setAssetCategoryPropertyPersistence, setAssetCategoryPropertyService, setAssetCategoryService, setAssetEntryAssetTags, setAssetEntryFinder, setAssetEntryLocalService, setAssetEntryPersistence, setAssetEntryService, setAssetLinkLocalService, setAssetLinkPersistence, setAssetTagFinder, setAssetTagLocalService, setAssetTagPersistence, setAssetTagPropertyFinder, setAssetTagPropertyKeyFinder, setAssetTagPropertyLocalService, setAssetTagPropertyPersistence, setAssetTagPropertyService, setAssetTagService, setAssetTagStatsLocalService, setAssetTagStatsPersistence, setAssetVocabularyFinder, setAssetVocabularyLocalService, setAssetVocabularyPersistence, setAssetVocabularyService, setBeanIdentifier, setCounterLocalService, setGroupFinder, setGroupLocalService, setGroupPersistence, setGroupService, setResourceLocalService, setUserFinder, setUserLocalService, setUserPersistence, setUserService, updateAssetTag

Methods inherited from class com.liferay.portal.service.BaseLocalServiceImpl

getClassLoader, getLayoutURL, getLayoutURL

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AssetTagLocalServiceImpl

public AssetTagLocalServiceImpl()

Method Detail

addTag

public 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 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 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 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 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 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 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 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 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 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 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 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 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 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 List<AssetTag> getSocialActivityCounterOffsetTags(long groupId,
                                                         String socialActivityCounterName,
                                                         int startOffset,
                                                         int endOffset)
                                                  throws SystemException

Throws:

SystemException

getSocialActivityCounterPeriodTags

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

Throws:

SystemException

getTag

public 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 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 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 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 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 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 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 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 List<AssetTag> getTags()
                       throws SystemException

Returns all the asset tags.

Returns:

the asset tags

Throws:

SystemException - if a system exception occurred

getTags

public 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 List<AssetTag> getTags(long groupId,
                              long classNameId,
                              String name)
                       throws SystemException

Throws:

SystemException

getTags

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

Throws:

SystemException

getTags

@ThreadLocalCachable
public 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 int getTagsSize(long groupId,
                       long classNameId,
                       String name)
                throws SystemException

Throws:

SystemException

hasTag

public 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 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 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 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 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 AssetTag updateTag(long userId,
                          long tagId,
                          String name,
                          String[] tagProperties,
                          ServiceContext serviceContext)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

getTagNames

protected String[] getTagNames(List<AssetTag> tags)

validate

protected void validate(String name)
                 throws PortalException

Throws:

PortalException