Liferay 7.0-ce-m2

com.liferay.portlet.bookmarks.service
Class BookmarksEntryLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.bookmarks.service.BookmarksEntryLocalServiceUtil

@ProviderType
public class BookmarksEntryLocalServiceUtil
extends Object

Provides the local service utility for BookmarksEntry. This utility wraps 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.

See Also:
BookmarksEntryLocalService, BookmarksEntryLocalServiceBaseImpl, BookmarksEntryLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary
BookmarksEntryLocalServiceUtil()
           
 
Method Summary
static BookmarksEntry addBookmarksEntry(BookmarksEntry bookmarksEntry)
          Adds the bookmarks entry to the database.
static BookmarksEntry addEntry(long userId, long groupId, long folderId, String name, String url, 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 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<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.
static
<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.
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 fetchBookmarksEntryByUuidAndGroupId(String uuid, long groupId)
          Returns the bookmarks entry matching the UUID and group.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<BookmarksEntry> getBookmarksEntries(int start, int end)
          Returns a range of all the bookmarks entries.
static List<BookmarksEntry> getBookmarksEntriesByUuidAndCompanyId(String uuid, long companyId)
           
static List<BookmarksEntry> getBookmarksEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<BookmarksEntry> orderByComparator)
           
static int getBookmarksEntriesCount()
          Returns the number of bookmarks entries.
static BookmarksEntry getBookmarksEntry(long entryId)
          Returns the bookmarks entry with the primary key.
static BookmarksEntry getBookmarksEntryByUuidAndGroupId(String uuid, long groupId)
          Returns the bookmarks entry matching the UUID and group.
static List<BookmarksEntry> getEntries(long groupId, long folderId, int start, int end)
           
static List<BookmarksEntry> getEntries(long groupId, long folderId, int status, int start, int end)
           
static List<BookmarksEntry> getEntries(long groupId, long folderId, int status, int start, int end, OrderByComparator<BookmarksEntry> orderByComparator)
           
static List<BookmarksEntry> getEntries(long groupId, long folderId, int start, int end, OrderByComparator<BookmarksEntry> orderByComparator)
           
static int getEntriesCount(long groupId, long folderId)
           
static int getEntriesCount(long groupId, long folderId, int status)
           
static BookmarksEntry getEntry(long entryId)
           
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static int getFoldersEntriesCount(long groupId, List<Long> folderIds)
           
static List<BookmarksEntry> getGroupEntries(long groupId, int start, int end)
           
static List<BookmarksEntry> getGroupEntries(long groupId, long userId, int start, int end)
           
static int getGroupEntriesCount(long groupId)
           
static int getGroupEntriesCount(long groupId, long userId)
           
static List<BookmarksEntry> getNoAssetEntries()
           
static PersistedModel getPersistedModel(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(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(BookmarksEntryLocalService service)
          Deprecated. As of 6.2.0
static void setTreePaths(long folderId, String treePath, boolean reindex)
           
static void subscribeEntry(long userId, long entryId)
           
static void unsubscribeEntry(long userId, long entryId)
           
static void updateAsset(long userId, BookmarksEntry entry, long[] assetCategoryIds, 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, String name, String url, 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)
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

public static BookmarksEntry addEntry(long userId,
                                      long groupId,
                                      long folderId,
                                      String name,
                                      String url,
                                      String description,
                                      ServiceContext serviceContext)
                               throws PortalException
Throws:
PortalException

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

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

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

deleteEntries

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

deleteEntry

public static BookmarksEntry deleteEntry(BookmarksEntry entry)
                                  throws PortalException
Throws:
PortalException

deleteEntry

public static BookmarksEntry deleteEntry(long entryId)
                                  throws PortalException
Throws:
PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

public static BookmarksEntry fetchBookmarksEntry(long entryId)

fetchBookmarksEntryByUuidAndGroupId

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

public static ActionableDynamicQuery getActionableDynamicQuery()

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

getBookmarksEntries

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

public static List<BookmarksEntry> getBookmarksEntriesByUuidAndCompanyId(String uuid,
                                                                         long companyId)

getBookmarksEntriesByUuidAndCompanyId

public static List<BookmarksEntry> getBookmarksEntriesByUuidAndCompanyId(String uuid,
                                                                         long companyId,
                                                                         int start,
                                                                         int end,
                                                                         OrderByComparator<BookmarksEntry> orderByComparator)

getBookmarksEntriesCount

public static int getBookmarksEntriesCount()
Returns the number of bookmarks entries.

Returns:
the number of bookmarks entries

getBookmarksEntry

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

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

public static List<BookmarksEntry> getEntries(long groupId,
                                              long folderId,
                                              int start,
                                              int end)

getEntries

public static List<BookmarksEntry> getEntries(long groupId,
                                              long folderId,
                                              int start,
                                              int end,
                                              OrderByComparator<BookmarksEntry> orderByComparator)

getEntries

public static List<BookmarksEntry> getEntries(long groupId,
                                              long folderId,
                                              int status,
                                              int start,
                                              int end)

getEntries

public static List<BookmarksEntry> getEntries(long groupId,
                                              long folderId,
                                              int status,
                                              int start,
                                              int end,
                                              OrderByComparator<BookmarksEntry> orderByComparator)

getEntriesCount

public static int getEntriesCount(long groupId,
                                  long folderId)

getEntriesCount

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

getEntry

public static BookmarksEntry getEntry(long entryId)
                               throws PortalException
Throws:
PortalException

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getFoldersEntriesCount

public static int getFoldersEntriesCount(long groupId,
                                         List<Long> folderIds)

getGroupEntries

public static List<BookmarksEntry> getGroupEntries(long groupId,
                                                   int start,
                                                   int end)

getGroupEntries

public static List<BookmarksEntry> getGroupEntries(long groupId,
                                                   long userId,
                                                   int start,
                                                   int end)

getGroupEntriesCount

public static int getGroupEntriesCount(long groupId)

getGroupEntriesCount

public static int getGroupEntriesCount(long groupId,
                                       long userId)

getNoAssetEntries

public static List<BookmarksEntry> getNoAssetEntries()

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

moveEntry

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

moveEntryFromTrash

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

moveEntryToTrash

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

moveEntryToTrash

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

openEntry

public static BookmarksEntry openEntry(long userId,
                                       BookmarksEntry entry)

openEntry

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

rebuildTree

public static void rebuildTree(long companyId)
                        throws PortalException
Throws:
PortalException

restoreEntryFromTrash

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

search

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

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

setTreePaths

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

subscribeEntry

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

unsubscribeEntry

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

updateAsset

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

updateBookmarksEntry

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

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

updateStatus

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

getService

public static BookmarksEntryLocalService getService()

setService

@Deprecated
public void setService(BookmarksEntryLocalService service)
Deprecated. As of 6.2.0


Liferay 7.0-ce-m2