Class BookmarksFolderLocalServiceUtil

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

public class BookmarksFolderLocalServiceUtil extends Object
Provides the local service utility for BookmarksFolder. This utility wraps com.liferay.bookmarks.service.impl.BookmarksFolderLocalServiceImpl 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

    • BookmarksFolderLocalServiceUtil

      public BookmarksFolderLocalServiceUtil()
  • Method Details

    • addBookmarksFolder

      public static BookmarksFolder addBookmarksFolder(BookmarksFolder bookmarksFolder)
      Adds the bookmarks folder to the database. Also notifies the appropriate model listeners.

      Important: Inspect BookmarksFolderLocalServiceImpl 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:
      bookmarksFolder - the bookmarks folder
      Returns:
      the bookmarks folder that was added
    • addFolder

      public static BookmarksFolder addFolder(long userId, long parentFolderId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createBookmarksFolder

      public static BookmarksFolder createBookmarksFolder(long folderId)
      Creates a new bookmarks folder with the primary key. Does not add the bookmarks folder to the database.
      Parameters:
      folderId - the primary key for the new bookmarks folder
      Returns:
      the new bookmarks folder
    • 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
    • deleteBookmarksFolder

      public static BookmarksFolder deleteBookmarksFolder(BookmarksFolder bookmarksFolder)
      Deletes the bookmarks folder from the database. Also notifies the appropriate model listeners.

      Important: Inspect BookmarksFolderLocalServiceImpl 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:
      bookmarksFolder - the bookmarks folder
      Returns:
      the bookmarks folder that was removed
    • deleteBookmarksFolder

      public static BookmarksFolder deleteBookmarksFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the bookmarks folder with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static BookmarksFolder deleteFolder(BookmarksFolder folder) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFolder

      public static BookmarksFolder deleteFolder(BookmarksFolder folder, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFolder

      public static BookmarksFolder deleteFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFolder

      public static BookmarksFolder deleteFolder(long folderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteFolders

      public static void deleteFolders(long groupId) 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.BookmarksFolderModelImpl.

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

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

      public static BookmarksFolder fetchBookmarksFolder(long folderId)
    • fetchBookmarksFolderByUuidAndGroupId

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

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

      public static BookmarksFolder getBookmarksFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the bookmarks folder with the primary key.
      Parameters:
      folderId - the primary key of the bookmarks folder
      Returns:
      the bookmarks folder
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a bookmarks folder with the primary key could not be found
    • getBookmarksFolderByUuidAndGroupId

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

      public static List<BookmarksFolder> getBookmarksFolders(int start, int end)
      Returns a range of all the bookmarks folders.

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

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

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

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

      public static int getBookmarksFoldersCount()
      Returns the number of bookmarks folders.
      Returns:
      the number of bookmarks folders
    • getCompanyFolders

      public static List<BookmarksFolder> getCompanyFolders(long companyId, int start, int end)
    • getCompanyFoldersCount

      public static int getCompanyFoldersCount(long companyId)
    • getExportActionableDynamicQuery

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

      public static BookmarksFolder getFolder(long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getFolders

      public static List<BookmarksFolder> getFolders(long groupId)
    • getFolders

      public static List<BookmarksFolder> getFolders(long groupId, long parentFolderId)
    • getFolders

      public static List<BookmarksFolder> getFolders(long groupId, long parentFolderId, int start, int end)
    • getFolders

      public static List<BookmarksFolder> getFolders(long groupId, long parentFolderId, int status, int start, int end)
    • getFoldersAndEntries

      public static List<Object> getFoldersAndEntries(long groupId, long folderId)
    • getFoldersAndEntries

      public static List<Object> getFoldersAndEntries(long groupId, long folderId, int status)
    • getFoldersAndEntries

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

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

      public static int getFoldersAndEntriesCount(long groupId, long folderId, int status)
    • getFoldersCount

      public static int getFoldersCount(long groupId, long parentFolderId)
    • getFoldersCount

      public static int getFoldersCount(long groupId, long parentFolderId, int status)
    • getIndexableActionableDynamicQuery

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

      public static List<BookmarksFolder> getNoAssetFolders()
    • 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
    • getSubfolderIds

      public static void getSubfolderIds(List<Long> folderIds, long groupId, long folderId)
    • mergeFolders

      public static void mergeFolders(long folderId, long parentFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveFolder

      public static BookmarksFolder moveFolder(long folderId, long parentFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveFolderFromTrash

      public static BookmarksFolder moveFolderFromTrash(long userId, long folderId, long parentFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveFolderToTrash

      public static BookmarksFolder moveFolderToTrash(long userId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • rebuildTree

      public static void rebuildTree(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • rebuildTree

      public static void rebuildTree(long companyId, long parentFolderId, String parentTreePath, boolean reindex) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • restoreFolderFromTrash

      public static BookmarksFolder restoreFolderFromTrash(long userId, long folderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • subscribeFolder

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

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

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

      public static BookmarksFolder updateBookmarksFolder(BookmarksFolder bookmarksFolder)
      Updates the bookmarks folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect BookmarksFolderLocalServiceImpl 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:
      bookmarksFolder - the bookmarks folder
      Returns:
      the bookmarks folder that was updated
    • updateFolder

      public static BookmarksFolder updateFolder(long userId, long folderId, long parentFolderId, String name, 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 BookmarksFolder updateStatus(long userId, BookmarksFolder folder, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static BookmarksFolderLocalService getService()