com.liferay.portlet.bookmarks.service
Interface BookmarksEntryLocalService

All Superinterfaces:

BaseLocalService, PermissionedModelLocalService, PersistedModelLocalService

All Known Implementing Classes:

BookmarksEntryLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface BookmarksEntryLocalService
extends BaseLocalService, PermissionedModelLocalService

Provides the local service interface for BookmarksEntry. 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:

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

Method Summary

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

Method Detail

addBookmarksEntry

@Indexable(type=REINDEX)
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

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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksEntry fetchBookmarksEntry(long entryId)
                                   throws SystemException

Throws:

SystemException

fetchBookmarksEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksEntry fetchBookmarksEntryByUuidAndCompanyId(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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksEntry fetchBookmarksEntryByUuidAndGroupId(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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getBookmarksEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksEntry getBookmarksEntryByUuidAndCompanyId(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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksEntry getBookmarksEntryByUuidAndGroupId(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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBookmarksEntriesCount()
                             throws SystemException

Returns the number of bookmarks entries.

Returns:

the number of bookmarks entries

Throws:

SystemException - if a system exception occurred

updateBookmarksEntry

@Indexable(type=REINDEX)
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

String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addEntry

@Indexable(type=REINDEX)
BookmarksEntry addEntry(long userId,
                                             long groupId,
                                             long folderId,
                                             String name,
                                             String url,
                                             String description,
                                             ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

deleteEntries

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

Throws:

PortalException

SystemException

deleteEntries

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

Throws:

PortalException

SystemException

deleteEntry

@Indexable(type=DELETE)
BookmarksEntry deleteEntry(BookmarksEntry entry)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

deleteEntry

@Indexable(type=DELETE)
BookmarksEntry deleteEntry(long entryId)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksEntry> getEntries(long groupId,
                                                                         long folderId,
                                                                         int start,
                                                                         int end)
                                throws SystemException

Throws:

SystemException

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksEntry> getEntries(long groupId,
                                                                         long folderId,
                                                                         int status,
                                                                         int start,
                                                                         int end)
                                throws SystemException

Throws:

SystemException

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksEntry> getEntries(long groupId,
                                                                         long folderId,
                                                                         int status,
                                                                         int start,
                                                                         int end,
                                                                         OrderByComparator orderByComparator)
                                throws SystemException

Throws:

SystemException

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksEntry> getEntries(long groupId,
                                                                         long folderId,
                                                                         int start,
                                                                         int end,
                                                                         OrderByComparator orderByComparator)
                                throws SystemException

Throws:

SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long groupId,
                                                             long folderId)
                    throws SystemException

Throws:

SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long groupId,
                                                             long folderId,
                                                             int status)
                    throws SystemException

Throws:

SystemException

getEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksEntry getEntry(long entryId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getFoldersEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getFoldersEntriesCount(long groupId,
                                                                    List<Long> folderIds)
                           throws SystemException

Throws:

SystemException

getGroupEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksEntry> getGroupEntries(long groupId,
                                                                              int start,
                                                                              int end)
                                     throws SystemException

Throws:

SystemException

getGroupEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksEntry> getGroupEntries(long groupId,
                                                                              long userId,
                                                                              int start,
                                                                              int end)
                                     throws SystemException

Throws:

SystemException

getGroupEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupEntriesCount(long groupId)
                         throws SystemException

Throws:

SystemException

getGroupEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupEntriesCount(long groupId,
                                                                  long userId)
                         throws SystemException

Throws:

SystemException

getNoAssetEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksEntry> getNoAssetEntries()
                                       throws SystemException

Throws:

SystemException

moveEntry

@Indexable(type=REINDEX)
BookmarksEntry moveEntry(long entryId,
                                              long parentFolderId)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

moveEntryFromTrash

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

Throws:

PortalException

SystemException

moveEntryToTrash

@Indexable(type=REINDEX)
BookmarksEntry moveEntryToTrash(long userId,
                                                     BookmarksEntry entry)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

moveEntryToTrash

@Indexable(type=REINDEX)
BookmarksEntry moveEntryToTrash(long userId,
                                                     long entryId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

openEntry

BookmarksEntry openEntry(long userId,
                         BookmarksEntry entry)
                         throws SystemException

Throws:

SystemException

openEntry

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

Throws:

PortalException

SystemException

rebuildTree

void rebuildTree(long companyId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

restoreEntryFromTrash

@Indexable(type=REINDEX)
BookmarksEntry restoreEntryFromTrash(long userId,
                                                          long entryId)
                                     throws PortalException,
                                            SystemException

Throws:

PortalException

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long groupId,
                                                     long userId,
                                                     long creatorUserId,
                                                     int status,
                                                     int start,
                                                     int end)
            throws PortalException,
                   SystemException

Throws:

PortalException

SystemException

setTreePaths

void setTreePaths(long folderId,
                  String treePath,
                  boolean reindex)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

subscribeEntry

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

Throws:

PortalException

SystemException

unsubscribeEntry

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

Throws:

PortalException

SystemException

updateAsset

void updateAsset(long userId,
                 BookmarksEntry entry,
                 long[] assetCategoryIds,
                 String[] assetTagNames,
                 long[] assetLinkEntryIds)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

updateEntry

@Indexable(type=REINDEX)
BookmarksEntry updateEntry(long userId,
                                                long entryId,
                                                long groupId,
                                                long folderId,
                                                String name,
                                                String url,
                                                String description,
                                                ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateStatus

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

Throws:

PortalException

SystemException