Class BookmarksEntryLocalServiceUtil

java.lang.Object
com.liferay.bookmarks.service.BookmarksEntryLocalServiceUtil

public class BookmarksEntryLocalServiceUtil extends Object
Provides the local service utility for BookmarksEntry. This utility wraps com.liferay.bookmarks.service.impl.BookmarksEntryLocalServiceImpl 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.
See Also:
Generated:
  • Constructor Details

    • BookmarksEntryLocalServiceUtil

      public BookmarksEntryLocalServiceUtil()
  • Method Details

    • addBookmarksEntry

      public static BookmarksEntry addBookmarksEntry(BookmarksEntry bookmarksEntry)
      Adds the bookmarks entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect BookmarksEntryLocalServiceImpl 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:
      bookmarksEntry - the bookmarks entry
      Returns:
      the bookmarks entry that was added
    • addEntry

      public static BookmarksEntry addEntry(long userId, long groupId, long folderId, String name, String url, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createBookmarksEntry

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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteBookmarksEntry

      public static BookmarksEntry deleteBookmarksEntry(BookmarksEntry bookmarksEntry)
      Deletes the bookmarks entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect BookmarksEntryLocalServiceImpl 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:
      bookmarksEntry - the bookmarks entry
      Returns:
      the bookmarks entry that was removed
    • deleteBookmarksEntry

      public static BookmarksEntry deleteBookmarksEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the bookmarks entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect BookmarksEntryLocalServiceImpl 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 bookmarks entry
      Returns:
      the bookmarks entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a bookmarks entry with the primary key could not be found
    • deleteEntries

      public static void deleteEntries(long groupId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteEntries

      public static void deleteEntries(long groupId, long folderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteEntry

      public static BookmarksEntry deleteEntry(BookmarksEntry entry) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteEntry

      public static BookmarksEntry deleteEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.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 com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.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.bookmarks.model.impl.BookmarksEntryModelImpl.

      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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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.bookmarks.model.impl.BookmarksEntryModelImpl.

      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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.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
    • fetchBookmarksEntry

      public static BookmarksEntry fetchBookmarksEntry(long entryId)
    • fetchBookmarksEntryByUuidAndGroupId

      public static BookmarksEntry fetchBookmarksEntryByUuidAndGroupId(String uuid, long groupId)
      Returns the bookmarks entry matching the UUID and group.
      Parameters:
      uuid - the bookmarks entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching bookmarks entry, or null if a matching bookmarks entry could not be found
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getBookmarksEntries

      public static List<BookmarksEntry> getBookmarksEntries(int start, int end)
      Returns a range of all the bookmarks 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.bookmarks.model.impl.BookmarksEntryModelImpl.

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

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

      public static List<BookmarksEntry> getBookmarksEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BookmarksEntry> orderByComparator)
      Returns a range of bookmarks entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the bookmarks entries
      companyId - the primary key of the company
      start - the lower bound of the range of bookmarks entries
      end - the upper bound of the range of bookmarks entries (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching bookmarks entries, or an empty list if no matches were found
    • getBookmarksEntriesCount

      public static int getBookmarksEntriesCount()
      Returns the number of bookmarks entries.
      Returns:
      the number of bookmarks entries
    • getBookmarksEntry

      public static BookmarksEntry getBookmarksEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the bookmarks entry with the primary key.
      Parameters:
      entryId - the primary key of the bookmarks entry
      Returns:
      the bookmarks entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a bookmarks entry with the primary key could not be found
    • getBookmarksEntryByUuidAndGroupId

      public static BookmarksEntry getBookmarksEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the bookmarks entry matching the UUID and group.
      Parameters:
      uuid - the bookmarks entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching bookmarks entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching bookmarks entry could not be found
    • getEntries

      public static List<BookmarksEntry> getEntries(long groupId, long folderId, int start, int end)
    • getEntries

      public static List<BookmarksEntry> getEntries(long groupId, long folderId, int status, int start, int end)
    • getEntries

      public static List<BookmarksEntry> getEntries(long groupId, long folderId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BookmarksEntry> orderByComparator)
    • getEntries

      public static List<BookmarksEntry> getEntries(long groupId, long folderId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<BookmarksEntry> orderByComparator)
    • getEntriesCount

      public static int getEntriesCount(long groupId, long folderId)
    • getEntriesCount

      public static int getEntriesCount(long groupId, long folderId, int status)
    • getEntry

      public static BookmarksEntry getEntry(long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getFoldersEntriesCount

      public static int getFoldersEntriesCount(long groupId, List<Long> folderIds)
    • getGroupEntries

      public static List<BookmarksEntry> getGroupEntries(long groupId, int start, int end)
    • getGroupEntries

      public static List<BookmarksEntry> getGroupEntries(long groupId, long userId, int start, int end)
    • getGroupEntriesCount

      public static int getGroupEntriesCount(long groupId)
    • getGroupEntriesCount

      public static int getGroupEntriesCount(long groupId, long userId)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveEntry

      public static BookmarksEntry moveEntry(long entryId, long parentFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveEntryFromTrash

      public static BookmarksEntry moveEntryFromTrash(long userId, long entryId, long parentFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveEntryToTrash

      public static BookmarksEntry moveEntryToTrash(long userId, BookmarksEntry entry) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveEntryToTrash

      public static BookmarksEntry moveEntryToTrash(long userId, long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • openEntry

      public static BookmarksEntry openEntry(long userId, BookmarksEntry entry)
    • openEntry

      public static BookmarksEntry openEntry(long userId, long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • restoreEntryFromTrash

      public static BookmarksEntry restoreEntryFromTrash(long userId, long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • search

      public static com.liferay.portal.kernel.search.Hits search(long groupId, long userId, long creatorUserId, int status, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • setTreePaths

      public static void setTreePaths(long folderId, String treePath, boolean reindex) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • subscribeEntry

      public static void subscribeEntry(long userId, long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • unsubscribeEntry

      public static void unsubscribeEntry(long userId, long entryId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateAsset

      public static void updateAsset(long userId, BookmarksEntry entry, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds, Double priority) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateBookmarksEntry

      public static BookmarksEntry updateBookmarksEntry(BookmarksEntry bookmarksEntry)
      Updates the bookmarks entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect BookmarksEntryLocalServiceImpl 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:
      bookmarksEntry - the bookmarks entry
      Returns:
      the bookmarks entry that was updated
    • updateEntry

      public static BookmarksEntry updateEntry(long userId, long entryId, long groupId, long folderId, String name, String url, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      public static BookmarksEntry updateStatus(long userId, BookmarksEntry entry, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static BookmarksEntryLocalService getService()