Liferay 6.1.10-ee-ga1

com.liferay.portlet.asset.service
Interface AssetTagLocalService

All Superinterfaces:
PersistedModelLocalService
All Known Implementing Classes:
AssetTagLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AssetTagLocalService
extends PersistedModelLocalService

The interface for the asset tag local service.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
AssetTagLocalServiceUtil, com.liferay.portlet.asset.service.base.AssetTagLocalServiceBaseImpl, com.liferay.portlet.asset.service.impl.AssetTagLocalServiceImpl

Method Summary
 AssetTag addAssetTag(AssetTag assetTag)
          Adds the asset tag to the database.
 AssetTag addTag(long userId, String name, String[] tagProperties, ServiceContext serviceContext)
           
 void addTagResources(AssetTag tag, boolean addGroupPermissions, boolean addGuestPermissions)
           
 void addTagResources(AssetTag tag, String[] groupPermissions, String[] guestPermissions)
           
 void checkTags(long userId, long groupId, String[] names)
           
 AssetTag createAssetTag(long tagId)
          Creates a new asset tag with the primary key.
 AssetTag decrementAssetCount(long tagId, long classNameId)
           
 void deleteAssetTag(AssetTag assetTag)
          Deletes the asset tag from the database.
 void deleteAssetTag(long tagId)
          Deletes the asset tag with the primary key from the database.
 void deleteTag(AssetTag tag)
           
 void deleteTag(long tagId)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 AssetTag fetchAssetTag(long tagId)
           
 AssetTag getAssetTag(long tagId)
          Returns the asset tag with the primary key.
 List<AssetTag> getAssetTags(int start, int end)
          Returns a range of all the asset tags.
 int getAssetTagsCount()
          Returns the number of asset tags.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 List<AssetTag> getEntryTags(long entryId)
           
 List<AssetTag> getGroupsTags(long[] groupIds)
           
 List<AssetTag> getGroupTags(long groupId)
           
 List<AssetTag> getGroupTags(long groupId, int start, int end)
           
 int getGroupTagsCount(long groupId)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 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)
           
 AssetTag getTag(long groupId, String name)
           
 long[] getTagIds(long[] groupIds, String[] names)
           
 long[] getTagIds(long groupId, String[] names)
           
 String[] getTagNames()
           
 String[] getTagNames(long classNameId, long classPK)
           
 String[] getTagNames(String className, long classPK)
           
 List<AssetTag> getTags()
           
 List<AssetTag> getTags(long classNameId, long classPK)
           
 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)
           
 int getTagsSize(long groupId, long classNameId, String name)
           
 boolean hasTag(long groupId, String name)
           
 AssetTag incrementAssetCount(long tagId, long classNameId)
           
 void mergeTags(long fromTagId, long toTagId, boolean overrideProperties)
           
 List<AssetTag> search(long groupId, String name, String[] tagProperties, int start, int end)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 AssetTag updateAssetTag(AssetTag assetTag)
          Updates the asset tag in the database or adds it if it does not yet exist.
 AssetTag updateAssetTag(AssetTag assetTag, boolean merge)
          Updates the asset tag in the database or adds it if it does not yet exist.
 AssetTag updateTag(long userId, long tagId, String name, String[] tagProperties, ServiceContext serviceContext)
           
 

Method Detail

addAssetTag

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

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

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

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

deleteAssetTag

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

Parameters:
assetTag - the asset tag
Throws:
SystemException - if a system exception occurred

dynamicQuery

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

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query
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

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query
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

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

fetchAssetTag

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetTag fetchAssetTag(long tagId)
                       throws SystemException
Throws:
SystemException

getAssetTag

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getAssetTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAssetTagsCount()
                      throws SystemException
Returns the number of asset tags.

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

updateAssetTag

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

updateAssetTag

AssetTag updateAssetTag(AssetTag assetTag,
                        boolean merge)
                        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
merge - whether to merge the asset tag with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the asset tag that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addTag

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

addTagResources

void addTagResources(AssetTag tag,
                     boolean addGroupPermissions,
                     boolean addGuestPermissions)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

addTagResources

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

checkTags

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

decrementAssetCount

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

deleteTag

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

deleteTag

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

getEntryTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getEntryTags(long entryId)
                            throws SystemException
Throws:
SystemException

getGroupsTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getGroupsTags(long[] groupIds)
                             throws SystemException
Throws:
SystemException

getGroupTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getGroupTags(long groupId)
                            throws SystemException
Throws:
SystemException

getGroupTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getGroupTags(long groupId,
                                                                     int start,
                                                                     int end)
                            throws SystemException
Throws:
SystemException

getGroupTagsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupTagsCount(long groupId)
                      throws SystemException
Throws:
SystemException

getSocialActivityCounterOffsetTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getSocialActivityCounterOffsetTags(long groupId,
                                                                                           String socialActivityCounterName,
                                                                                           int startOffset,
                                                                                           int endOffset)
                                                  throws SystemException
Throws:
SystemException

getSocialActivityCounterPeriodTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getSocialActivityCounterPeriodTags(long groupId,
                                                                                           String socialActivityCounterName,
                                                                                           int startPeriod,
                                                                                           int endPeriod)
                                                  throws SystemException
Throws:
SystemException

getTag

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetTag getTag(long tagId)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

getTag

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AssetTag getTag(long groupId,
                                                         String name)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

getTagIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getTagIds(long groupId,
                                                          String[] names)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

getTagIds

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long[] getTagIds(long[] groupIds,
                                                          String[] names)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

getTagNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String[] getTagNames()
                     throws SystemException
Throws:
SystemException

getTagNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String[] getTagNames(long classNameId,
                                                              long classPK)
                     throws SystemException
Throws:
SystemException

getTagNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String[] getTagNames(String className,
                                                              long classPK)
                     throws SystemException
Throws:
SystemException

getTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getTags()
                       throws SystemException
Throws:
SystemException

getTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getTags(long classNameId,
                                                                long classPK)
                       throws SystemException
Throws:
SystemException

getTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getTags(long groupId,
                                                                long classNameId,
                                                                String name)
                       throws SystemException
Throws:
SystemException

getTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getTags(long groupId,
                                                                long classNameId,
                                                                String name,
                                                                int start,
                                                                int end)
                       throws SystemException
Throws:
SystemException

getTags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> getTags(String className,
                                                                long classPK)
                       throws SystemException
Throws:
SystemException

getTagsSize

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getTagsSize(long groupId,
                                                         long classNameId,
                                                         String name)
                throws SystemException
Throws:
SystemException

hasTag

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasTag(long groupId,
                                                        String name)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

incrementAssetCount

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

mergeTags

void mergeTags(long fromTagId,
               long toTagId,
               boolean overrideProperties)
               throws PortalException,
                      SystemException
Throws:
PortalException
SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AssetTag> search(long groupId,
                                                               String name,
                                                               String[] tagProperties,
                                                               int start,
                                                               int end)
                      throws SystemException
Throws:
SystemException

updateTag

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

Liferay 6.1.10-ee-ga1