Class AssetEntryLocalServiceUtil

Object
com.liferay.asset.kernel.service.AssetEntryLocalServiceUtil

public class AssetEntryLocalServiceUtil extends Object
Provides the local service utility for AssetEntry. This utility wraps com.liferay.portlet.asset.service.impl.AssetEntryLocalServiceImpl 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

    • AssetEntryLocalServiceUtil

      public AssetEntryLocalServiceUtil()
  • Method Details

    • addAssetEntry

      public static AssetEntry addAssetEntry(AssetEntry assetEntry)
      Adds the asset entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect AssetEntryLocalServiceImpl 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:
      assetEntry - the asset entry
      Returns:
      the asset entry that was added
    • addAssetTagAssetEntries

      public static boolean addAssetTagAssetEntries(long tagId, List<AssetEntry> assetEntries)
    • addAssetTagAssetEntries

      public static boolean addAssetTagAssetEntries(long tagId, long[] entryIds)
    • addAssetTagAssetEntry

      public static boolean addAssetTagAssetEntry(long tagId, AssetEntry assetEntry)
    • addAssetTagAssetEntry

      public static boolean addAssetTagAssetEntry(long tagId, long entryId)
    • clearAssetTagAssetEntries

      public static void clearAssetTagAssetEntries(long tagId)
    • createAssetEntry

      public static AssetEntry createAssetEntry(long entryId)
      Creates a new asset entry with the primary key. Does not add the asset entry to the database.
      Parameters:
      entryId - the primary key for the new asset entry
      Returns:
      the new asset entry
    • createPersistedModel

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

      public static AssetEntry deleteAssetEntry(AssetEntry assetEntry)
      Deletes the asset entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect AssetEntryLocalServiceImpl 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:
      assetEntry - the asset entry
      Returns:
      the asset entry that was removed
    • deleteAssetEntry

      public static AssetEntry deleteAssetEntry(long entryId) throws PortalException
      Deletes the asset entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect AssetEntryLocalServiceImpl 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:
      entryId - the primary key of the asset entry
      Returns:
      the asset entry that was removed
      Throws:
      PortalException - if a asset entry with the primary key could not be found
    • deleteAssetTagAssetEntries

      public static void deleteAssetTagAssetEntries(long tagId, List<AssetEntry> assetEntries)
    • deleteAssetTagAssetEntries

      public static void deleteAssetTagAssetEntries(long tagId, long[] entryIds)
    • deleteAssetTagAssetEntry

      public static void deleteAssetTagAssetEntry(long tagId, AssetEntry assetEntry)
    • deleteAssetTagAssetEntry

      public static void deleteAssetTagAssetEntry(long tagId, long entryId)
    • deleteEntries

      public static void deleteEntries(long companyId, String className) throws PortalException
      Throws:
      PortalException
    • deleteEntry

      public static AssetEntry deleteEntry(AssetEntry entry) throws PortalException
      Throws:
      PortalException
    • deleteEntry

      public static AssetEntry deleteEntry(long entryId) throws PortalException
      Throws:
      PortalException
    • deleteEntry

      public static AssetEntry deleteEntry(String className, long classPK) throws PortalException
      Throws:
      PortalException
    • deleteGroupEntries

      public static void deleteGroupEntries(long groupId) throws PortalException
      Throws:
      PortalException
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      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.AssetEntryModelImpl.

      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.AssetEntryModelImpl.

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

      public static AssetEntry fetchAssetEntry(long entryId)
    • fetchEntry

      public static AssetEntry fetchEntry(long entryId)
    • fetchEntry

      public static AssetEntry fetchEntry(long classNameId, long classPK)
    • fetchEntry

      public static AssetEntry fetchEntry(long groupId, String classUuid)
    • fetchEntry

      public static AssetEntry fetchEntry(String className, long classPK)
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getAssetEntries

      public static List<AssetEntry> getAssetEntries(int start, int end)
      Returns a range of all the asset entries.

      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.AssetEntryModelImpl.

      Parameters:
      start - the lower bound of the range of asset entries
      end - the upper bound of the range of asset entries (not inclusive)
      Returns:
      the range of asset entries
    • getAssetEntriesCount

      public static int getAssetEntriesCount()
      Returns the number of asset entries.
      Returns:
      the number of asset entries
    • getAssetEntry

      public static AssetEntry getAssetEntry(long entryId) throws PortalException
      Returns the asset entry with the primary key.
      Parameters:
      entryId - the primary key of the asset entry
      Returns:
      the asset entry
      Throws:
      PortalException - if a asset entry with the primary key could not be found
    • getAssetTagAssetEntries

      public static List<AssetEntry> getAssetTagAssetEntries(long tagId)
    • getAssetTagAssetEntries

      public static List<AssetEntry> getAssetTagAssetEntries(long tagId, int start, int end)
    • getAssetTagAssetEntries

      public static List<AssetEntry> getAssetTagAssetEntries(long tagId, int start, int end, OrderByComparator<AssetEntry> orderByComparator)
    • getAssetTagAssetEntriesCount

      public static int getAssetTagAssetEntriesCount(long tagId)
    • getAssetTagPrimaryKeys

      public static long[] getAssetTagPrimaryKeys(long entryId)
      Returns the tagIds of the asset tags associated with the asset entry.
      Parameters:
      entryId - the entryId of the asset entry
      Returns:
      long[] the tagIds of asset tags associated with the asset entry
    • getCompanyEntries

      public static List<AssetEntry> getCompanyEntries(long companyId, int start, int end)
    • getCompanyEntriesCount

      public static int getCompanyEntriesCount(long companyId)
    • getEntries

      public static List<AssetEntry> getEntries(AssetEntryQuery entryQuery)
    • getEntries

      public static List<AssetEntry> getEntries(long[] groupIds, long[] classNameIds, long[] classTypeIds, String keywords, String userName, String title, String description, Boolean listable, boolean advancedSearch, boolean andOperator, int start, int end, String orderByCol1, String orderByCol2, String orderByType1, String orderByType2)
    • getEntries

      public static List<AssetEntry> getEntries(long[] groupIds, long[] classNameIds, String keywords, String userName, String title, String description, Boolean listable, boolean advancedSearch, boolean andOperator, int start, int end, String orderByCol1, String orderByCol2, String orderByType1, String orderByType2)
    • getEntriesCount

      public static int getEntriesCount(AssetEntryQuery entryQuery)
    • getEntriesCount

      public static int getEntriesCount(long[] groupIds, long[] classNameIds, long[] classTypeIds, String keywords, String userName, String title, String description, Boolean listable, boolean advancedSearch, boolean andOperator)
    • getEntriesCount

      public static int getEntriesCount(long[] groupIds, long[] classNameIds, String keywords, String userName, String title, String description, Boolean listable, boolean advancedSearch, boolean andOperator)
    • getEntry

      public static AssetEntry getEntry(long entryId) throws PortalException
      Throws:
      PortalException
    • getEntry

      public static AssetEntry getEntry(long groupId, String classUuid) throws PortalException
      Throws:
      PortalException
    • getEntry

      public static AssetEntry getEntry(String className, long classPK) throws PortalException
      Throws:
      PortalException
    • getEntryPriority

      public static double getEntryPriority(long classNameId, long classPK)
    • getEntryPriority

      public static double getEntryPriority(String className, long classPK)
    • getGroupEntries

      public static List<AssetEntry> getGroupEntries(long groupId)
    • 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
    • getTopViewedEntries

      public static List<AssetEntry> getTopViewedEntries(String className, boolean asc, int start, int end)
    • getTopViewedEntries

      public static List<AssetEntry> getTopViewedEntries(String[] className, boolean asc, int start, int end)
    • hasAssetTagAssetEntries

      public static boolean hasAssetTagAssetEntries(long tagId)
    • hasAssetTagAssetEntry

      public static boolean hasAssetTagAssetEntry(long tagId, long entryId)
    • incrementViewCounter

      public static void incrementViewCounter(long userId, AssetEntry assetEntry) throws PortalException
      Throws:
      PortalException
    • incrementViewCounter

      public static AssetEntry incrementViewCounter(long companyId, long userId, String className, long classPK) throws PortalException
      Throws:
      PortalException
    • incrementViewCounter

      public static void incrementViewCounter(long companyId, long userId, String className, long classPK, int increment)
    • reindex

      public static void reindex(List<AssetEntry> entries) throws PortalException
      Throws:
      PortalException
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, long[] classNameIds, long classTypeId, String keywords, boolean showNonindexable, int[] statuses, int start, int end, Sort sort)
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, String className, long classTypeId, String keywords, boolean showNonindexable, int status, int start, int end)
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, String className, long classTypeId, String keywords, boolean showNonindexable, int[] statuses, int start, int end)
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, String className, long classTypeId, String keywords, boolean showNonindexable, int[] statuses, int start, int end, Sort sort)
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, String className, long classTypeId, String keywords, int status, int start, int end)
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, String className, long classTypeId, String userName, String title, String description, String assetCategoryIds, String assetTagNames, boolean showNonindexable, int status, boolean andSearch, int start, int end)
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, String className, long classTypeId, String userName, String title, String description, String assetCategoryIds, String assetTagNames, boolean showNonindexable, int[] statuses, boolean andSearch, int start, int end)
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, String className, long classTypeId, String userName, String title, String description, String assetCategoryIds, String assetTagNames, int status, boolean andSearch, int start, int end)
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, String className, String keywords, int status, int start, int end)
    • search

      public static Hits search(long companyId, long[] groupIds, long userId, String className, String userName, String title, String description, String assetCategoryIds, String assetTagNames, int status, boolean andSearch, int start, int end)
    • searchCount

      public static long searchCount(long companyId, long[] groupIds, long userId, long[] classNameIds, long classTypeId, String keywords, boolean showNonindexable, int[] statuses)
    • searchCount

      public static long searchCount(long companyId, long[] groupIds, long userId, String className, long classTypeId, String keywords, boolean showNonindexable, int[] statuses)
    • searchCount

      public static long searchCount(long companyId, long[] groupIds, long userId, String className, long classTypeId, String keywords, String assetCategoryIds, String assetTagNames, boolean showInvisible, boolean showNonindexable, int[] statuses, boolean andSearch)
    • searchCount

      public static long searchCount(long companyId, long[] groupIds, long userId, String className, long classTypeId, String userName, String title, String description, String assetCategoryIds, String assetTagNames, boolean showInvisible, boolean showNonindexable, int[] statuses, boolean andSearch)
    • searchCount

      public static long searchCount(long companyId, long[] groupIds, long userId, String className, long classTypeId, String userName, String title, String description, String assetCategoryIds, String assetTagNames, boolean showNonindexable, int[] statuses, boolean andSearch)
    • setAssetTagAssetEntries

      public static void setAssetTagAssetEntries(long tagId, long[] entryIds)
    • updateAssetEntry

      public static AssetEntry updateAssetEntry(AssetEntry assetEntry)
      Updates the asset entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect AssetEntryLocalServiceImpl 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:
      assetEntry - the asset entry
      Returns:
      the asset entry that was updated
    • updateEntry

      public static AssetEntry updateEntry(long userId, long groupId, Date createDate, Date modifiedDate, String className, long classPK, String classUuid, long classTypeId, long[] categoryIds, String[] tagNames, boolean listable, boolean visible, Date startDate, Date endDate, Date publishDate, Date expirationDate, String mimeType, String title, String description, String summary, String url, String layoutUuid, int height, int width, Double priority) throws PortalException
      Throws:
      PortalException
    • updateEntry

      public static AssetEntry updateEntry(long userId, long groupId, Date createDate, Date modifiedDate, String className, long classPK, String classUuid, long classTypeId, long[] categoryIds, String[] tagNames, boolean listable, boolean visible, Date startDate, Date endDate, Date publishDate, Date expirationDate, String mimeType, String title, String description, String summary, String url, String layoutUuid, int height, int width, Double priority, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • updateEntry

      public static AssetEntry updateEntry(long userId, long groupId, String className, long classPK, long[] categoryIds, String[] tagNames) throws PortalException
      Throws:
      PortalException
    • updateEntry

      public static AssetEntry updateEntry(String className, long classPK, Date publishDate, Date expirationDate, boolean listable, boolean visible) throws PortalException
      Throws:
      PortalException
    • updateVisible

      public static AssetEntry updateVisible(AssetEntry entry, boolean visible) throws PortalException
      Throws:
      PortalException
    • updateVisible

      public static AssetEntry updateVisible(String className, long classPK, boolean visible) throws PortalException
      Throws:
      PortalException
    • validate

      public static void validate(long groupId, String className, long classPK, long classTypePK, long[] categoryIds, String[] tagNames) throws PortalException
      Throws:
      PortalException
    • validate

      public static void validate(long groupId, String className, long classTypePK, long[] categoryIds, String[] tagNames) throws PortalException
      Throws:
      PortalException
    • getService

      public static AssetEntryLocalService getService()
    • setService

      public static void setService(AssetEntryLocalService service)