com.liferay.portlet.wiki.service
Class WikiPageLocalServiceUtil

java.lang.Object
  com.liferay.portlet.wiki.service.WikiPageLocalServiceUtil

public class WikiPageLocalServiceUtil
extends Object

The utility for the wiki page local service. This utility wraps WikiPageLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to WikiPageLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

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:

WikiPageLocalService, WikiPageLocalServiceBaseImpl, WikiPageLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary

WikiPageLocalServiceUtil()

Method Summary

static WikiPage	addPage(long userId, long nodeId, String title, double version, String content, String summary, boolean minorEdit, String format, boolean head, String parentTitle, String redirectTitle, ServiceContext serviceContext)
static WikiPage	addPage(long userId, long nodeId, String title, String content, String summary, boolean minorEdit, ServiceContext serviceContext)
static void	addPageAttachment(long companyId, String dirName, Date modifiedDate, String fileName, InputStream inputStream)
static void	addPageAttachments(long nodeId, String title, List<ObjectValuePair<String,byte[]>> files)
static void	addPageResources(long nodeId, String title, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addPageResources(long nodeId, String title, String[] communityPermissions, String[] guestPermissions)
static void	addPageResources(WikiPage page, boolean addCommunityPermissions, boolean addGuestPermissions)
static void	addPageResources(WikiPage page, String[] communityPermissions, String[] guestPermissions)
static WikiPage	addWikiPage(WikiPage wikiPage) Adds the wiki page to the database.
static void	changeParent(long userId, long nodeId, String title, String newParentTitle, ServiceContext serviceContext)
static WikiPage	createWikiPage(long pageId) Creates a new wiki page with the primary key.
static void	deletePage(long nodeId, String title)
static void	deletePage(long nodeId, String title, double version)
static void	deletePage(WikiPage page)
static void	deletePageAttachment(long nodeId, String title, String fileName)
static void	deletePages(long nodeId)
static void	deleteWikiPage(long pageId) Deletes the wiki page with the primary key from the database.
static void	deleteWikiPage(WikiPage wikiPage) Deletes the wiki page from the database.
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
static List<WikiPage>	getChildren(long nodeId, boolean head, String parentTitle)
static WikiPage	getDraftPage(long nodeId, String title)
static List<WikiPage>	getIncomingLinks(long nodeId, String title)
static List<WikiPage>	getNoAssetPages()
static List<WikiPage>	getOrphans(long nodeId)
static List<WikiPage>	getOutgoingLinks(long nodeId, String title)
static WikiPage	getPage(long resourcePrimKey)
static WikiPage	getPage(long resourcePrimKey, Boolean head)
static WikiPage	getPage(long nodeId, String title)
static WikiPage	getPage(long nodeId, String title, Boolean head)
static WikiPage	getPage(long nodeId, String title, double version)
static WikiPageDisplay	getPageDisplay(long nodeId, String title, PortletURL viewPageURL, PortletURL editPageURL, String attachmentURLPrefix)
static WikiPageDisplay	getPageDisplay(WikiPage page, PortletURL viewPageURL, PortletURL editPageURL, String attachmentURLPrefix)
static List<WikiPage>	getPages(long nodeId, boolean head, int start, int end)
static List<WikiPage>	getPages(long nodeId, boolean head, int start, int end, OrderByComparator obc)
static List<WikiPage>	getPages(long nodeId, int start, int end)
static List<WikiPage>	getPages(long nodeId, int start, int end, OrderByComparator obc)
static List<WikiPage>	getPages(long resourcePrimKey, long nodeId, int status)
static List<WikiPage>	getPages(long userId, long nodeId, int status, int start, int end)
static List<WikiPage>	getPages(long nodeId, String title, boolean head, int start, int end)
static List<WikiPage>	getPages(long nodeId, String title, int start, int end)
static List<WikiPage>	getPages(long nodeId, String title, int start, int end, OrderByComparator obc)
static List<WikiPage>	getPages(String format)
static int	getPagesCount(long nodeId)
static int	getPagesCount(long nodeId, boolean head)
static int	getPagesCount(long userId, long nodeId, int status)
static int	getPagesCount(long nodeId, String title)
static int	getPagesCount(long nodeId, String title, boolean head)
static int	getPagesCount(String format)
static List<WikiPage>	getRecentChanges(long nodeId, int start, int end)
static int	getRecentChangesCount(long nodeId)
static WikiPageLocalService	getService()
static WikiPage	getWikiPage(long pageId) Gets the wiki page with the primary key.
static WikiPage	getWikiPageByUuidAndGroupId(String uuid, long groupId) Gets the wiki page with the UUID and group id.
static List<WikiPage>	getWikiPages(int start, int end) Gets a range of all the wiki pages.
static int	getWikiPagesCount() Gets the number of wiki pages.
static boolean	hasDraftPage(long nodeId, String title)
static void	movePage(long userId, long nodeId, String title, String newTitle, boolean strict, ServiceContext serviceContext)
static void	movePage(long userId, long nodeId, String title, String newTitle, ServiceContext serviceContext)
static WikiPage	revertPage(long userId, long nodeId, String title, double version, ServiceContext serviceContext)
void	setService(WikiPageLocalService service)
static void	subscribePage(long userId, long nodeId, String title)
static void	unsubscribePage(long userId, long nodeId, String title)
static void	updateAsset(long userId, WikiPage page, long[] assetCategoryIds, String[] assetTagNames)
static WikiPage	updatePage(long userId, long nodeId, String title, double version, String content, String summary, boolean minorEdit, String format, String parentTitle, String redirectTitle, ServiceContext serviceContext)
static WikiPage	updateStatus(long userId, long resourcePrimKey, int status, ServiceContext serviceContext)
static WikiPage	updateStatus(long userId, WikiPage page, int status, ServiceContext serviceContext)
static WikiPage	updateWikiPage(WikiPage wikiPage) Updates the wiki page in the database.
static WikiPage	updateWikiPage(WikiPage wikiPage, boolean merge) Updates the wiki page in the database.
static void	validateTitle(String title)

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiPageLocalServiceUtil

public WikiPageLocalServiceUtil()

Method Detail

addWikiPage

public static WikiPage addWikiPage(WikiPage wikiPage)
                            throws SystemException

Adds the wiki page to the database. Also notifies the appropriate model listeners.

Parameters:

wikiPage - the wiki page to add

Returns:

the wiki page that was added

Throws:

SystemException - if a system exception occurred

createWikiPage

public static WikiPage createWikiPage(long pageId)

Creates a new wiki page with the primary key. Does not add the wiki page to the database.

Parameters:

pageId - the primary key for the new wiki page

Returns:

the new wiki page

deleteWikiPage

public static void deleteWikiPage(long pageId)
                           throws PortalException,
                                  SystemException

Deletes the wiki page with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

pageId - the primary key of the wiki page to delete

Throws:

PortalException - if a wiki page with the primary key could not be found

SystemException - if a system exception occurred

deleteWikiPage

public static void deleteWikiPage(WikiPage wikiPage)
                           throws SystemException

Deletes the wiki page from the database. Also notifies the appropriate model listeners.

Parameters:

wikiPage - the wiki page to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static 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 to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static 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 to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getWikiPage

public static WikiPage getWikiPage(long pageId)
                            throws PortalException,
                                   SystemException

Gets the wiki page with the primary key.

Parameters:

pageId - the primary key of the wiki page to get

Returns:

the wiki page

Throws:

PortalException - if a wiki page with the primary key could not be found

SystemException - if a system exception occurred

getWikiPageByUuidAndGroupId

public static WikiPage getWikiPageByUuidAndGroupId(String uuid,
                                                   long groupId)
                                            throws PortalException,
                                                   SystemException

Gets the wiki page with the UUID and group id.

Parameters:

uuid - the UUID of wiki page to get

groupId - the group id of the wiki page to get

Returns:

the wiki page

Throws:

PortalException - if a wiki page with the UUID and group id could not be found

SystemException - if a system exception occurred

getWikiPages

public static List<WikiPage> getWikiPages(int start,
                                          int end)
                                   throws SystemException

Gets a range of all the wiki pages.

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 wiki pages to return

end - the upper bound of the range of wiki pages to return (not inclusive)

Returns:

the range of wiki pages

Throws:

SystemException - if a system exception occurred

getWikiPagesCount

public static int getWikiPagesCount()
                             throws SystemException

Gets the number of wiki pages.

Returns:

the number of wiki pages

Throws:

SystemException - if a system exception occurred

updateWikiPage

public static WikiPage updateWikiPage(WikiPage wikiPage)
                               throws SystemException

Updates the wiki page in the database. Also notifies the appropriate model listeners.

Parameters:

wikiPage - the wiki page to update

Returns:

the wiki page that was updated

Throws:

SystemException - if a system exception occurred

updateWikiPage

public static WikiPage updateWikiPage(WikiPage wikiPage,
                                      boolean merge)
                               throws SystemException

Updates the wiki page in the database. Also notifies the appropriate model listeners.

Parameters:

wikiPage - the wiki page to update

merge - whether to merge the wiki page 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 wiki page that was updated

Throws:

SystemException - if a system exception occurred

addPage

public static WikiPage addPage(long userId,
                               long nodeId,
                               String title,
                               double version,
                               String content,
                               String summary,
                               boolean minorEdit,
                               String format,
                               boolean head,
                               String parentTitle,
                               String redirectTitle,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addPage

public static WikiPage addPage(long userId,
                               long nodeId,
                               String title,
                               String content,
                               String summary,
                               boolean minorEdit,
                               ServiceContext serviceContext)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addPageAttachment

public static void addPageAttachment(long companyId,
                                     String dirName,
                                     Date modifiedDate,
                                     String fileName,
                                     InputStream inputStream)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

addPageAttachments

public static void addPageAttachments(long nodeId,
                                      String title,
                                      List<ObjectValuePair<String,byte[]>> files)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

addPageResources

public static void addPageResources(long nodeId,
                                    String title,
                                    boolean addCommunityPermissions,
                                    boolean addGuestPermissions)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addPageResources

public static void addPageResources(long nodeId,
                                    String title,
                                    String[] communityPermissions,
                                    String[] guestPermissions)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addPageResources

public static void addPageResources(WikiPage page,
                                    boolean addCommunityPermissions,
                                    boolean addGuestPermissions)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

addPageResources

public static void addPageResources(WikiPage page,
                                    String[] communityPermissions,
                                    String[] guestPermissions)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

changeParent

public static void changeParent(long userId,
                                long nodeId,
                                String title,
                                String newParentTitle,
                                ServiceContext serviceContext)
                         throws PortalException,
                                SystemException

Throws:

PortalException

SystemException

deletePage

public static void deletePage(long nodeId,
                              String title)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

deletePage

public static void deletePage(long nodeId,
                              String title,
                              double version)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

deletePage

public static void deletePage(WikiPage page)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

deletePageAttachment

public static void deletePageAttachment(long nodeId,
                                        String title,
                                        String fileName)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

deletePages

public static void deletePages(long nodeId)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getChildren

public static List<WikiPage> getChildren(long nodeId,
                                         boolean head,
                                         String parentTitle)
                                  throws SystemException

Throws:

SystemException

getDraftPage

public static WikiPage getDraftPage(long nodeId,
                                    String title)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

getIncomingLinks

public static List<WikiPage> getIncomingLinks(long nodeId,
                                              String title)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

getNoAssetPages

public static List<WikiPage> getNoAssetPages()
                                      throws SystemException

Throws:

SystemException

getOrphans

public static List<WikiPage> getOrphans(long nodeId)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getOutgoingLinks

public static List<WikiPage> getOutgoingLinks(long nodeId,
                                              String title)
                                       throws PortalException,
                                              SystemException

Throws:

PortalException

SystemException

getPage

public static WikiPage getPage(long resourcePrimKey)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getPage

public static WikiPage getPage(long resourcePrimKey,
                               Boolean head)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getPage

public static WikiPage getPage(long nodeId,
                               String title)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getPage

public static WikiPage getPage(long nodeId,
                               String title,
                               Boolean head)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getPage

public static WikiPage getPage(long nodeId,
                               String title,
                               double version)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

getPageDisplay

public static WikiPageDisplay getPageDisplay(long nodeId,
                                             String title,
                                             PortletURL viewPageURL,
                                             PortletURL editPageURL,
                                             String attachmentURLPrefix)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getPageDisplay

public static WikiPageDisplay getPageDisplay(WikiPage page,
                                             PortletURL viewPageURL,
                                             PortletURL editPageURL,
                                             String attachmentURLPrefix)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

getPages

public static List<WikiPage> getPages(long nodeId,
                                      boolean head,
                                      int start,
                                      int end)
                               throws SystemException

Throws:

SystemException

getPages

public static List<WikiPage> getPages(long nodeId,
                                      boolean head,
                                      int start,
                                      int end,
                                      OrderByComparator obc)
                               throws SystemException

Throws:

SystemException

getPages

public static List<WikiPage> getPages(long nodeId,
                                      int start,
                                      int end)
                               throws SystemException

Throws:

SystemException

getPages

public static List<WikiPage> getPages(long nodeId,
                                      int start,
                                      int end,
                                      OrderByComparator obc)
                               throws SystemException

Throws:

SystemException

getPages

public static List<WikiPage> getPages(long resourcePrimKey,
                                      long nodeId,
                                      int status)
                               throws SystemException

Throws:

SystemException

getPages

public static List<WikiPage> getPages(long userId,
                                      long nodeId,
                                      int status,
                                      int start,
                                      int end)
                               throws SystemException

Throws:

SystemException

getPages

public static List<WikiPage> getPages(long nodeId,
                                      String title,
                                      boolean head,
                                      int start,
                                      int end)
                               throws SystemException

Throws:

SystemException

getPages

public static List<WikiPage> getPages(long nodeId,
                                      String title,
                                      int start,
                                      int end)
                               throws SystemException

Throws:

SystemException

getPages

public static List<WikiPage> getPages(long nodeId,
                                      String title,
                                      int start,
                                      int end,
                                      OrderByComparator obc)
                               throws SystemException

Throws:

SystemException

getPages

public static List<WikiPage> getPages(String format)
                               throws SystemException

Throws:

SystemException

getPagesCount

public static int getPagesCount(long nodeId)
                         throws SystemException

Throws:

SystemException

getPagesCount

public static int getPagesCount(long nodeId,
                                boolean head)
                         throws SystemException

Throws:

SystemException

getPagesCount

public static int getPagesCount(long userId,
                                long nodeId,
                                int status)
                         throws SystemException

Throws:

SystemException

getPagesCount

public static int getPagesCount(long nodeId,
                                String title)
                         throws SystemException

Throws:

SystemException

getPagesCount

public static int getPagesCount(long nodeId,
                                String title,
                                boolean head)
                         throws SystemException

Throws:

SystemException

getPagesCount

public static int getPagesCount(String format)
                         throws SystemException

Throws:

SystemException

getRecentChanges

public static List<WikiPage> getRecentChanges(long nodeId,
                                              int start,
                                              int end)
                                       throws SystemException

Throws:

SystemException

getRecentChangesCount

public static int getRecentChangesCount(long nodeId)
                                 throws SystemException

Throws:

SystemException

hasDraftPage

public static boolean hasDraftPage(long nodeId,
                                   String title)
                            throws SystemException

Throws:

SystemException

movePage

public static void movePage(long userId,
                            long nodeId,
                            String title,
                            String newTitle,
                            boolean strict,
                            ServiceContext serviceContext)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

movePage

public static void movePage(long userId,
                            long nodeId,
                            String title,
                            String newTitle,
                            ServiceContext serviceContext)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

revertPage

public static WikiPage revertPage(long userId,
                                  long nodeId,
                                  String title,
                                  double version,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

subscribePage

public static void subscribePage(long userId,
                                 long nodeId,
                                 String title)
                          throws PortalException,
                                 SystemException

Throws:

PortalException

SystemException

unsubscribePage

public static void unsubscribePage(long userId,
                                   long nodeId,
                                   String title)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

updateAsset

public static void updateAsset(long userId,
                               WikiPage page,
                               long[] assetCategoryIds,
                               String[] assetTagNames)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

updatePage

public static WikiPage updatePage(long userId,
                                  long nodeId,
                                  String title,
                                  double version,
                                  String content,
                                  String summary,
                                  boolean minorEdit,
                                  String format,
                                  String parentTitle,
                                  String redirectTitle,
                                  ServiceContext serviceContext)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

updateStatus

public static WikiPage updateStatus(long userId,
                                    long resourcePrimKey,
                                    int status,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

updateStatus

public static WikiPage updateStatus(long userId,
                                    WikiPage page,
                                    int status,
                                    ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException

Throws:

PortalException

SystemException

validateTitle

public static void validateTitle(String title)
                          throws PortalException

Throws:

PortalException

getService

public static WikiPageLocalService getService()

setService

public void setService(WikiPageLocalService service)