Liferay 7.0-ce-m2

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)
           
 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
 DynamicQuery dynamicQuery()
           
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
 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 fetchBookmarksEntryByUuidAndGroupId(String uuid, long groupId)
          Returns the bookmarks entry matching the UUID and group.
 ActionableDynamicQuery getActionableDynamicQuery()
           
 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.
 List<BookmarksEntry> getBookmarksEntriesByUuidAndCompanyId(String uuid, long companyId)
           
 List<BookmarksEntry> getBookmarksEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<BookmarksEntry> orderByComparator)
           
 int getBookmarksEntriesCount()
          Returns the number of bookmarks entries.
 BookmarksEntry getBookmarksEntry(long entryId)
          Returns the bookmarks entry with the primary key.
 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<BookmarksEntry> orderByComparator)
           
 List<BookmarksEntry> getEntries(long groupId, long folderId, int start, int end, OrderByComparator<BookmarksEntry> orderByComparator)
           
 int getEntriesCount(long groupId, long folderId)
           
 int getEntriesCount(long groupId, long folderId, int status)
           
 BookmarksEntry getEntry(long entryId)
           
 ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
 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)
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

addEntry

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

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(BookmarksEntry bookmarksEntry)
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

deleteBookmarksEntry

@Indexable(type=DELETE)
BookmarksEntry deleteBookmarksEntry(long entryId)
                                    throws PortalException
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

deleteEntries

void deleteEntries(long groupId,
                   long folderId)
                   throws PortalException
Throws:
PortalException

deleteEntries

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

deleteEntry

@Indexable(type=DELETE)
@SystemEvent(type=1)
BookmarksEntry deleteEntry(BookmarksEntry entry)
                           throws PortalException
Throws:
PortalException

deleteEntry

@Indexable(type=DELETE)
BookmarksEntry deleteEntry(long entryId)
                           throws PortalException
Throws:
PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException
Specified by:
deletePersistedModel in interface PersistedModelLocalService
Throws:
PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end)
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to 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 com.liferay.portlet.bookmarks.model.impl.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

dynamicQuery

<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                         int start,
                         int end,
                         OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to 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 com.liferay.portlet.bookmarks.model.impl.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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
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

fetchBookmarksEntry

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

fetchBookmarksEntryByUuidAndGroupId

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

getBookmarksEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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 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 com.liferay.portlet.bookmarks.model.impl.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

getBookmarksEntriesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksEntry> getBookmarksEntriesByUuidAndCompanyId(String uuid,
                                                                                                    long companyId)

getBookmarksEntriesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<BookmarksEntry> getBookmarksEntriesByUuidAndCompanyId(String uuid,
                                                                                                    long companyId,
                                                                                                    int start,
                                                                                                    int end,
                                                                                                    OrderByComparator<BookmarksEntry> orderByComparator)

getBookmarksEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBookmarksEntriesCount()
Returns the number of bookmarks entries.

Returns:
the number of bookmarks entries

getBookmarksEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksEntry getBookmarksEntry(long entryId)
                                 throws PortalException
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

getBookmarksEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksEntry getBookmarksEntryByUuidAndGroupId(String uuid,
                                                                                          long groupId)
                                                 throws 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:
PortalException - if a matching bookmarks entry could not be found

getEntries

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

getEntries

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

getEntries

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

getEntries

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

getEntriesCount

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

getEntriesCount

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

getEntry

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

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFoldersEntriesCount

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

getGroupEntries

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

getGroupEntries

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

getGroupEntriesCount

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

getGroupEntriesCount

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

getNoAssetEntries

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

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException

moveEntry

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

moveEntryFromTrash

BookmarksEntry moveEntryFromTrash(long userId,
                                  long entryId,
                                  long parentFolderId)
                                  throws PortalException
Throws:
PortalException

moveEntryToTrash

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

moveEntryToTrash

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

openEntry

BookmarksEntry openEntry(long userId,
                         BookmarksEntry entry)

openEntry

BookmarksEntry openEntry(long userId,
                         long entryId)
                         throws PortalException
Throws:
PortalException

rebuildTree

void rebuildTree(long companyId)
                 throws PortalException
Throws:
PortalException

restoreEntryFromTrash

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

search

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

setBeanIdentifier

void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

setTreePaths

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

subscribeEntry

void subscribeEntry(long userId,
                    long entryId)
                    throws PortalException
Throws:
PortalException

unsubscribeEntry

void unsubscribeEntry(long userId,
                      long entryId)
                      throws PortalException
Throws:
PortalException

updateAsset

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

updateBookmarksEntry

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

Parameters:
bookmarksEntry - the bookmarks entry
Returns:
the bookmarks entry that was updated

updateEntry

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

updateStatus

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

Liferay 7.0-ce-m2