com.liferay.portlet.bookmarks.service

Class BookmarksEntryLocalServiceUtil

java.lang.Object

com.liferay.portlet.bookmarks.service.BookmarksEntryLocalServiceUtil

@ProviderType
public class BookmarksEntryLocalServiceUtil
extends java.lang.Object

Provides the local service utility for BookmarksEntry. This utility wraps com.liferay.portlet.bookmarks.service.impl.BookmarksEntryLocalServiceImpl and is the primary 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:

BookmarksEntryLocalService, com.liferay.portlet.bookmarks.service.base.BookmarksEntryLocalServiceBaseImpl, com.liferay.portlet.bookmarks.service.impl.BookmarksEntryLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
BookmarksEntryLocalServiceUtil()

Method Summary

Methods

Modifier and Type	Method and Description
static BookmarksEntry	addBookmarksEntry(BookmarksEntry bookmarksEntry) Adds the bookmarks entry to the database.
static BookmarksEntry	addEntry(long userId, long groupId, long folderId, java.lang.String name, java.lang.String url, java.lang.String description, ServiceContext serviceContext)
static BookmarksEntry	createBookmarksEntry(long entryId) Creates a new bookmarks entry with the primary key.
static BookmarksEntry	deleteBookmarksEntry(BookmarksEntry bookmarksEntry) Deletes the bookmarks entry from the database.
static BookmarksEntry	deleteBookmarksEntry(long entryId) Deletes the bookmarks entry with the primary key from the database.
static void	deleteEntries(long groupId, long folderId)
static void	deleteEntries(long groupId, long folderId, boolean includeTrashedEntries)
static BookmarksEntry	deleteEntry(BookmarksEntry entry)
static BookmarksEntry	deleteEntry(long entryId)
static DynamicQuery	dynamicQuery()
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static java.util.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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
static BookmarksEntry	fetchBookmarksEntry(long entryId)
static BookmarksEntry	fetchBookmarksEntryByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the bookmarks entry with the matching UUID and company.
static BookmarksEntry	fetchBookmarksEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the bookmarks entry matching the UUID and group.
static java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static java.util.List<BookmarksEntry>	getBookmarksEntries(int start, int end) Returns a range of all the bookmarks entries.
static int	getBookmarksEntriesCount() Returns the number of bookmarks entries.
static BookmarksEntry	getBookmarksEntry(long entryId) Returns the bookmarks entry with the primary key.
static BookmarksEntry	getBookmarksEntryByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the bookmarks entry with the matching UUID and company.
static BookmarksEntry	getBookmarksEntryByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the bookmarks entry matching the UUID and group.
static java.util.List<BookmarksEntry>	getEntries(long groupId, long folderId, int start, int end)
static java.util.List<BookmarksEntry>	getEntries(long groupId, long folderId, int status, int start, int end)
static java.util.List<BookmarksEntry>	getEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator orderByComparator)
static java.util.List<BookmarksEntry>	getEntries(long groupId, long folderId, int start, int end, OrderByComparator orderByComparator)
static int	getEntriesCount(long groupId, long folderId)
static int	getEntriesCount(long groupId, long folderId, int status)
static BookmarksEntry	getEntry(long entryId)
static int	getFoldersEntriesCount(long groupId, java.util.List<java.lang.Long> folderIds)
static java.util.List<BookmarksEntry>	getGroupEntries(long groupId, int start, int end)
static java.util.List<BookmarksEntry>	getGroupEntries(long groupId, long userId, int start, int end)
static int	getGroupEntriesCount(long groupId)
static int	getGroupEntriesCount(long groupId, long userId)
static java.util.List<BookmarksEntry>	getNoAssetEntries()
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static BookmarksEntryLocalService	getService()
static BookmarksEntry	moveEntry(long entryId, long parentFolderId)
static BookmarksEntry	moveEntryFromTrash(long userId, long entryId, long parentFolderId)
static BookmarksEntry	moveEntryToTrash(long userId, BookmarksEntry entry)
static BookmarksEntry	moveEntryToTrash(long userId, long entryId)
static BookmarksEntry	openEntry(long userId, BookmarksEntry entry)
static BookmarksEntry	openEntry(long userId, long entryId)
static void	rebuildTree(long companyId)
static BookmarksEntry	restoreEntryFromTrash(long userId, long entryId)
static Hits	search(long groupId, long userId, long creatorUserId, int status, int start, int end)
static void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(BookmarksEntryLocalService service) Deprecated. As of 6.2.0
static void	subscribeEntry(long userId, long entryId)
static void	unsubscribeEntry(long userId, long entryId)
static void	updateAsset(long userId, BookmarksEntry entry, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds)
static BookmarksEntry	updateBookmarksEntry(BookmarksEntry bookmarksEntry) Updates the bookmarks entry in the database or adds it if it does not yet exist.
static BookmarksEntry	updateEntry(long userId, long entryId, long groupId, long folderId, java.lang.String name, java.lang.String url, java.lang.String description, ServiceContext serviceContext)
static BookmarksEntry	updateStatus(long userId, BookmarksEntry entry, int status)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BookmarksEntryLocalServiceUtil

public BookmarksEntryLocalServiceUtil()

Method Detail

addBookmarksEntry

public static BookmarksEntry addBookmarksEntry(BookmarksEntry bookmarksEntry)
                                        throws SystemException

Adds the bookmarks entry to the database. Also notifies the appropriate model listeners.

Parameters:

bookmarksEntry - the bookmarks entry

Returns:

the bookmarks entry that was added

Throws:

SystemException - if a system exception occurred

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

deleteBookmarksEntry

public static BookmarksEntry deleteBookmarksEntry(long entryId)
                                           throws PortalException,
                                                  SystemException

Deletes the bookmarks entry with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

entryId - the primary key of the bookmarks entry

Returns:

the bookmarks entry that was removed

Throws:

PortalException - if a bookmarks entry with the primary key could not be found

SystemException - if a system exception occurred

deleteBookmarksEntry

public static BookmarksEntry deleteBookmarksEntry(BookmarksEntry bookmarksEntry)
                                           throws SystemException

Deletes the bookmarks entry from the database. Also notifies the appropriate model listeners.

Parameters:

bookmarksEntry - the bookmarks entry

Returns:

the bookmarks entry that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static java.util.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

public static java.util.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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from BookmarksEntryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

public static java.util.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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from BookmarksEntryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

public static 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

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchBookmarksEntry

public static BookmarksEntry fetchBookmarksEntry(long entryId)
                                          throws SystemException

Throws:

SystemException

fetchBookmarksEntryByUuidAndCompanyId

public static BookmarksEntry fetchBookmarksEntryByUuidAndCompanyId(java.lang.String uuid,
                                                   long companyId)
                                                            throws SystemException

Returns the bookmarks entry with the matching UUID and company.

Parameters:

uuid - the bookmarks entry's UUID

companyId - the primary key of the company

Returns:

the matching bookmarks entry, or null if a matching bookmarks entry could not be found

Throws:

SystemException - if a system exception occurred

fetchBookmarksEntryByUuidAndGroupId

public static BookmarksEntry fetchBookmarksEntryByUuidAndGroupId(java.lang.String uuid,
                                                 long groupId)
                                                          throws SystemException

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

Throws:

SystemException - if a system exception occurred

getBookmarksEntry

public static BookmarksEntry getBookmarksEntry(long entryId)
                                        throws PortalException,
                                               SystemException

Returns the bookmarks entry with the primary key.

Parameters:

entryId - the primary key of the bookmarks entry

Returns:

the bookmarks entry

Throws:

PortalException - if a bookmarks entry with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getBookmarksEntryByUuidAndCompanyId

public static BookmarksEntry getBookmarksEntryByUuidAndCompanyId(java.lang.String uuid,
                                                 long companyId)
                                                          throws PortalException,
                                                                 SystemException

Returns the bookmarks entry with the matching UUID and company.

Parameters:

uuid - the bookmarks entry's UUID

companyId - the primary key of the company

Returns:

the matching bookmarks entry

Throws:

PortalException - if a matching bookmarks entry could not be found

SystemException - if a system exception occurred

getBookmarksEntryByUuidAndGroupId

public static BookmarksEntry getBookmarksEntryByUuidAndGroupId(java.lang.String uuid,
                                               long groupId)
                                                        throws PortalException,
                                                               SystemException

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:

PortalException - if a matching bookmarks entry could not be found

SystemException - if a system exception occurred

getBookmarksEntries

public static java.util.List<BookmarksEntry> getBookmarksEntries(int start,
                                                 int end)
                                                          throws SystemException

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 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 and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from BookmarksEntryModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

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

Throws:

SystemException - if a system exception occurred

getBookmarksEntriesCount

public static int getBookmarksEntriesCount()
                                    throws SystemException

Returns the number of bookmarks entries.

Returns:

the number of bookmarks entries

Throws:

SystemException - if a system exception occurred

updateBookmarksEntry

public static BookmarksEntry updateBookmarksEntry(BookmarksEntry bookmarksEntry)
                                           throws SystemException

Updates the bookmarks entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

bookmarksEntry - the bookmarks entry

Returns:

the bookmarks entry that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addEntry

public static BookmarksEntry addEntry(long userId,
                      long groupId,
                      long folderId,
                      java.lang.String name,
                      java.lang.String url,
                      java.lang.String description,
                      ServiceContext serviceContext)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

deleteEntries

public static void deleteEntries(long groupId,
                 long folderId)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deleteEntries

public static void deleteEntries(long groupId,
                 long folderId,
                 boolean includeTrashedEntries)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

deleteEntry

public static BookmarksEntry deleteEntry(BookmarksEntry entry)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

deleteEntry

public static BookmarksEntry deleteEntry(long entryId)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

getEntries

public static java.util.List<BookmarksEntry> getEntries(long groupId,
                                        long folderId,
                                        int start,
                                        int end)
                                                 throws SystemException

Throws:

SystemException

getEntries

public static java.util.List<BookmarksEntry> getEntries(long groupId,
                                        long folderId,
                                        int status,
                                        int start,
                                        int end)
                                                 throws SystemException

Throws:

SystemException

getEntries

public static java.util.List<BookmarksEntry> getEntries(long groupId,
                                        long folderId,
                                        int status,
                                        int start,
                                        int end,
                                        OrderByComparator orderByComparator)
                                                 throws SystemException

Throws:

SystemException

getEntries

public static java.util.List<BookmarksEntry> getEntries(long groupId,
                                        long folderId,
                                        int start,
                                        int end,
                                        OrderByComparator orderByComparator)
                                                 throws SystemException

Throws:

SystemException

getEntriesCount

public static int getEntriesCount(long groupId,
                  long folderId)
                           throws SystemException

Throws:

SystemException

getEntriesCount

public static int getEntriesCount(long groupId,
                  long folderId,
                  int status)
                           throws SystemException

Throws:

SystemException

getEntry

public static BookmarksEntry getEntry(long entryId)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getFoldersEntriesCount

public static int getFoldersEntriesCount(long groupId,
                         java.util.List<java.lang.Long> folderIds)
                                  throws SystemException

Throws:

SystemException

getGroupEntries

public static java.util.List<BookmarksEntry> getGroupEntries(long groupId,
                                             int start,
                                             int end)
                                                      throws SystemException

Throws:

SystemException

getGroupEntries

public static java.util.List<BookmarksEntry> getGroupEntries(long groupId,
                                             long userId,
                                             int start,
                                             int end)
                                                      throws SystemException

Throws:

SystemException

getGroupEntriesCount

public static int getGroupEntriesCount(long groupId)
                                throws SystemException

Throws:

SystemException

getGroupEntriesCount

public static int getGroupEntriesCount(long groupId,
                       long userId)
                                throws SystemException

Throws:

SystemException

getNoAssetEntries

public static java.util.List<BookmarksEntry> getNoAssetEntries()
                                                        throws SystemException

Throws:

SystemException

moveEntry

public static BookmarksEntry moveEntry(long entryId,
                       long parentFolderId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

moveEntryFromTrash

public static BookmarksEntry moveEntryFromTrash(long userId,
                                long entryId,
                                long parentFolderId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

moveEntryToTrash

public static BookmarksEntry moveEntryToTrash(long userId,
                              BookmarksEntry entry)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

moveEntryToTrash

public static BookmarksEntry moveEntryToTrash(long userId,
                              long entryId)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

openEntry

public static BookmarksEntry openEntry(long userId,
                       BookmarksEntry entry)
                                throws SystemException

Throws:

SystemException

openEntry

public static BookmarksEntry openEntry(long userId,
                       long entryId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

rebuildTree

public static void rebuildTree(long companyId)
                        throws SystemException

Throws:

SystemException

restoreEntryFromTrash

public static BookmarksEntry restoreEntryFromTrash(long userId,
                                   long entryId)
                                            throws PortalException,
                                                   SystemException

Throws:

PortalException

SystemException

search

public static Hits search(long groupId,
          long userId,
          long creatorUserId,
          int status,
          int start,
          int end)
                   throws PortalException,
                          SystemException

Throws:

PortalException

SystemException

subscribeEntry

public static void subscribeEntry(long userId,
                  long entryId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

unsubscribeEntry

public static void unsubscribeEntry(long userId,
                    long entryId)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

updateAsset

public static void updateAsset(long userId,
               BookmarksEntry entry,
               long[] assetCategoryIds,
               java.lang.String[] assetTagNames,
               long[] assetLinkEntryIds)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

updateEntry

public static BookmarksEntry updateEntry(long userId,
                         long entryId,
                         long groupId,
                         long folderId,
                         java.lang.String name,
                         java.lang.String url,
                         java.lang.String description,
                         ServiceContext serviceContext)
                                  throws PortalException,
                                         SystemException

Throws:

PortalException

SystemException

updateStatus

public static BookmarksEntry updateStatus(long userId,
                          BookmarksEntry entry,
                          int status)
                                   throws PortalException,
                                          SystemException

Throws:

PortalException

SystemException

getService

public static BookmarksEntryLocalService getService()

setService

public void setService(BookmarksEntryLocalService service)

Deprecated. As of 6.2.0