Class AssetTagLocalServiceUtil

Object
com.liferay.asset.kernel.service.AssetTagLocalServiceUtil

public class AssetTagLocalServiceUtil extends Object
Provides the local service utility for AssetTag. This utility wraps com.liferay.portlet.asset.service.impl.AssetTagLocalServiceImpl and is an 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:
{$generated.description}
  • Constructor Details

    • AssetTagLocalServiceUtil

      public AssetTagLocalServiceUtil()
  • Method Details

    • addAssetEntryAssetTag

      public static boolean addAssetEntryAssetTag(long entryId, AssetTag assetTag)
    • addAssetEntryAssetTag

      public static boolean addAssetEntryAssetTag(long entryId, long tagId)
    • addAssetEntryAssetTags

      public static boolean addAssetEntryAssetTags(long entryId, List<AssetTag> assetTags)
    • addAssetEntryAssetTags

      public static boolean addAssetEntryAssetTags(long entryId, long[] tagIds)
    • addAssetTag

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

      Important: Inspect AssetTagLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      assetTag - the asset tag
      Returns:
      the asset tag that was added
    • addTag

      public static AssetTag addTag(String externalReferenceCode, long userId, long groupId, String name, ServiceContext serviceContext) throws PortalException
      Adds an asset tag.
      Parameters:
      externalReferenceCode -
      userId - the primary key of the user adding the asset tag
      groupId - the primary key of the group in which the asset tag is to be added
      name - the asset tag's name
      serviceContext - the service context to be applied
      Returns:
      the asset tag that was added
      Throws:
      PortalException
    • checkTags

      public static List<AssetTag> checkTags(long userId, Group group, String[] names) throws PortalException
      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
    • checkTags

      public static List<AssetTag> checkTags(long userId, long groupId, String[] names) throws PortalException
      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
      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
    • clearAssetEntryAssetTags

      public static void clearAssetEntryAssetTags(long entryId)
    • 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
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • decrementAssetCount

      public static AssetTag decrementAssetCount(long tagId, long classNameId) throws PortalException
      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
    • deleteAssetEntryAssetTag

      public static void deleteAssetEntryAssetTag(long entryId, AssetTag assetTag)
    • deleteAssetEntryAssetTag

      public static void deleteAssetEntryAssetTag(long entryId, long tagId)
    • deleteAssetEntryAssetTags

      public static void deleteAssetEntryAssetTags(long entryId, List<AssetTag> assetTags)
    • deleteAssetEntryAssetTags

      public static void deleteAssetEntryAssetTags(long entryId, long[] tagIds)
    • deleteAssetTag

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

      Important: Inspect AssetTagLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      assetTag - the asset tag
      Returns:
      the asset tag that was removed
    • deleteAssetTag

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

      Important: Inspect AssetTagLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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
    • deleteGroupTags

      public static void deleteGroupTags(long groupId) throws PortalException
      Deletes all asset tags in the group.
      Parameters:
      groupId - the primary key of the group in which to delete all asset tags
      Throws:
      PortalException
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteTag

      public static void deleteTag(AssetTag tag) throws PortalException
      Deletes the asset tag.
      Parameters:
      tag - the asset tag to be deleted
      Throws:
      PortalException
    • deleteTag

      public static void deleteTag(long tagId) throws PortalException
      Deletes the asset tag.
      Parameters:
      tagId - the primary key of the asset tag
      Throws:
      PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.asset.model.impl.AssetTagModelImpl.

      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
    • dynamicQuery

      public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.asset.model.impl.AssetTagModelImpl.

      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
    • dynamicQueryCount

      public static long dynamicQueryCount(DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      public static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchAssetTag

      public static AssetTag fetchAssetTag(long tagId)
    • fetchAssetTagByExternalReferenceCode

      public static AssetTag fetchAssetTagByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchAssetTagByUuidAndGroupId

      public static AssetTag fetchAssetTagByUuidAndGroupId(String uuid, long groupId)
      Returns the asset tag matching the UUID and group.
      Parameters:
      uuid - the asset tag's UUID
      groupId - the primary key of the group
      Returns:
      the matching asset tag, or null if a matching asset tag could not be found
    • fetchTag

      public static AssetTag fetchTag(long groupId, String name)
      Returns the asset tag with the name in the group.
      Parameters:
      groupId - the primary key of the group
      name - the asset tag's name
      Returns:
      the asset tag with the name in the group or null if it could not be found
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getAssetEntryAssetTags

      public static List<AssetTag> getAssetEntryAssetTags(long entryId)
    • getAssetEntryAssetTags

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

      public static List<AssetTag> getAssetEntryAssetTags(long entryId, int start, int end, OrderByComparator<AssetTag> orderByComparator)
    • getAssetEntryAssetTagsCount

      public static int getAssetEntryAssetTagsCount(long entryId)
    • getAssetEntryPrimaryKeys

      public static long[] getAssetEntryPrimaryKeys(long tagId)
      Returns the entryIds of the asset entries associated with the asset tag.
      Parameters:
      tagId - the tagId of the asset tag
      Returns:
      long[] the entryIds of asset entries associated with the asset tag
    • getAssetTag

      public static AssetTag getAssetTag(long tagId) throws PortalException
      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
    • getAssetTagByExternalReferenceCode

      public static AssetTag getAssetTagByExternalReferenceCode(String externalReferenceCode, long groupId) throws PortalException
      Throws:
      PortalException
    • getAssetTagByUuidAndGroupId

      public static AssetTag getAssetTagByUuidAndGroupId(String uuid, long groupId) throws PortalException
      Returns the asset tag matching the UUID and group.
      Parameters:
      uuid - the asset tag's UUID
      groupId - the primary key of the group
      Returns:
      the matching asset tag
      Throws:
      PortalException - if a matching asset tag could not be found
    • getAssetTags

      public static List<AssetTag> getAssetTags(int start, int end)
      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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.asset.model.impl.AssetTagModelImpl.

      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
    • getAssetTagsByUuidAndCompanyId

      public static List<AssetTag> getAssetTagsByUuidAndCompanyId(String uuid, long companyId)
      Returns all the asset tags matching the UUID and company.
      Parameters:
      uuid - the UUID of the asset tags
      companyId - the primary key of the company
      Returns:
      the matching asset tags, or an empty list if no matches were found
    • getAssetTagsByUuidAndCompanyId

      public static List<AssetTag> getAssetTagsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<AssetTag> orderByComparator)
      Returns a range of asset tags matching the UUID and company.
      Parameters:
      uuid - the UUID of the asset tags
      companyId - the primary key of the company
      start - the lower bound of the range of asset tags
      end - the upper bound of the range of asset tags (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching asset tags, or an empty list if no matches were found
    • getAssetTagsCount

      public static int getAssetTagsCount()
      Returns the number of asset tags.
      Returns:
      the number of asset tags
    • getEntryTags

      public static List<AssetTag> getEntryTags(long entryId)
      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
    • getExportActionableDynamicQuery

      public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
    • getGroupsTags

      public static List<AssetTag> getGroupsTags(long[] groupIds)
      Returns the asset tags in the groups.
      Parameters:
      groupIds - the primary keys of the groups
      Returns:
      the asset tags in the groups
    • getGroupTags

      public static List<AssetTag> getGroupTags(long groupId)
      Returns the asset tags in the group.
      Parameters:
      groupId - the primary key of the group
      Returns:
      the asset tags in the group
    • getGroupTags

      public static List<AssetTag> getGroupTags(long groupId, int start, int end)
      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
    • getGroupTags

      public static List<AssetTag> getGroupTags(long groupId, int start, int end, OrderByComparator<AssetTag> orderByComparator)
      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)
      orderByComparator - the comparator to order the asset tags (optionally null)
      Returns:
      the range of matching asset tags
    • getGroupTagsCount

      public static int getGroupTagsCount(long groupId)
      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
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      public static String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getTag

      public static AssetTag getTag(long tagId) throws PortalException
      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
    • getTag

      public static AssetTag getTag(long groupId, String name) throws PortalException
      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
    • getTagIds

      public static long[] getTagIds(long groupId, String[] names)
      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
    • getTagIds

      public static long[] getTagIds(long[] groupIds, String name)
      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
    • getTagIds

      public static long[] getTagIds(long[] groupIds, String[] names)
      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
    • getTagIds

      public static long[] getTagIds(String name)
      Returns the primary keys of the asset tags with the names.
      Parameters:
      name - the name of the asset tags
      Returns:
      the primary keys of the asset tags with the names
    • getTagNames

      public static String[] getTagNames()
      Returns the names of all the asset tags.
      Returns:
      the names of all the asset tags
    • getTagNames

      public static String[] getTagNames(long classNameId, long classPK)
      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
    • getTagNames

      public static String[] getTagNames(String className, long classPK)
      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
    • getTags

      public static List<AssetTag> getTags()
      Returns all the asset tags.
      Returns:
      the asset tags
    • getTags

      public static List<AssetTag> getTags(long classNameId, long classPK)
      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
    • getTags

      public static List<AssetTag> getTags(long groupId, long classNameId, String name)
    • getTags

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

      public static List<AssetTag> getTags(String className, long classPK)
      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
    • getTagsSize

      public static int getTagsSize(long groupId, long classNameId, String name)
    • hasAssetEntryAssetTag

      public static boolean hasAssetEntryAssetTag(long entryId, long tagId)
    • hasAssetEntryAssetTags

      public static boolean hasAssetEntryAssetTags(long entryId)
    • hasTag

      public static boolean hasTag(long groupId, String name)
      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.
    • incrementAssetCount

      public static AssetTag incrementAssetCount(long tagId, long classNameId) throws PortalException
      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
    • mergeTags

      public static void mergeTags(long fromTagId, long toTagId) throws PortalException
      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
      Throws:
      PortalException
    • search

      public static List<AssetTag> search(long groupId, String name, int start, int end)
      Returns the asset tags in the group whose names match the pattern.
      Parameters:
      groupId - the primary key of the group
      name - the pattern 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
    • search

      public static List<AssetTag> search(long[] groupIds, String name, int start, int end)
      Returns the asset tags in the groups whose names match the pattern.
      Parameters:
      groupIds - the primary keys of the groups
      name - the pattern 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
    • searchTags

      public static BaseModelSearchResult<AssetTag> searchTags(long[] groupIds, String name, int start, int end, Sort sort) throws PortalException
      Throws:
      PortalException
    • setAssetEntryAssetTags

      public static void setAssetEntryAssetTags(long entryId, long[] tagIds)
    • subscribeTag

      public static void subscribeTag(long userId, long groupId, long tagId) throws PortalException
      Throws:
      PortalException
    • unsubscribeTag

      public static void unsubscribeTag(long userId, long tagId) throws PortalException
      Throws:
      PortalException
    • updateAssetTag

      public static AssetTag updateAssetTag(AssetTag assetTag)
      Updates the asset tag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AssetTagLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      assetTag - the asset tag
      Returns:
      the asset tag that was updated
    • updateTag

      public static AssetTag updateTag(String externalReferenceCode, long userId, long tagId, String name, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • getService

      public static AssetTagLocalService getService()
    • setService

      public static void setService(AssetTagLocalService service)