Liferay 6.1.2-ce-ga3

com.liferay.portlet.bookmarks.service
Interface BookmarksEntryLocalService

All Superinterfaces:
BaseLocalService, PermissionedModelLocalService, PersistedModelLocalService
All Known Implementing Classes:
BookmarksEntryLocalServiceBaseImpl, BookmarksEntryLocalServiceImpl, BookmarksEntryLocalServiceWrapper

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

The interface for the bookmarks entry local service.

This is a local service. 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, BookmarksEntryLocalServiceBaseImpl, BookmarksEntryLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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 deleteEntry(BookmarksEntry entry)
           
 void 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.
 BookmarksEntry fetchBookmarksEntry(long entryId)
           
 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 getBookmarksEntryByUuidAndGroupId(String uuid, long groupId)
          Returns the bookmarks entry with the UUID in the group.
 List<BookmarksEntry> getEntries(long groupId, long folderId, int start, int end)
           
 List<BookmarksEntry> getEntries(long groupId, long folderId, int start, int end, OrderByComparator orderByComparator)
           
 int getEntriesCount(long groupId, long folderId)
           
 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()
           
 List<BookmarksEntry> getNoResourceBlockEntries()
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 BookmarksEntry openEntry(long userId, long entryId)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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 updateBookmarksEntry(BookmarksEntry bookmarksEntry, boolean merge)
          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)
           
 

Method Detail

addBookmarksEntry

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

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

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.

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.

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

fetchBookmarksEntry

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

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

getBookmarksEntryByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
BookmarksEntry getBookmarksEntryByUuidAndGroupId(String uuid,
                                                                                          long groupId)
                                                 throws PortalException,
                                                        SystemException
Returns the bookmarks entry with the UUID in the group.

Parameters:
uuid - the UUID of bookmarks entry
groupId - the group id of the bookmarks entry
Returns:
the bookmarks entry
Throws:
PortalException - if a bookmarks entry with the UUID in the group 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.

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

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

updateBookmarksEntry

BookmarksEntry updateBookmarksEntry(BookmarksEntry bookmarksEntry,
                                    boolean merge)
                                    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
merge - whether to merge the bookmarks entry with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
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

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

deleteEntry

void deleteEntry(BookmarksEntry entry)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteEntry

void 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 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

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

getNoResourceBlockEntries

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

openEntry

BookmarksEntry openEntry(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

BookmarksEntry updateEntry(long userId,
                           long entryId,
                           long groupId,
                           long folderId,
                           String name,
                           String url,
                           String description,
                           ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3