com.liferay.wiki.service

Class WikiPageLocalServiceUtil

java.lang.Object

com.liferay.wiki.service.WikiPageLocalServiceUtil

public class WikiPageLocalServiceUtil
extends java.lang.Object

Provides the local service utility for WikiPage. This utility wraps com.liferay.wiki.service.impl.WikiPageLocalServiceImpl and is an 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:

WikiPageLocalService

Constructor Summary

Constructors

Constructor and Description
WikiPageLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static WikiPage	addPage(long userId, long nodeId, java.lang.String title, double version, java.lang.String content, java.lang.String summary, boolean minorEdit, java.lang.String format, boolean head, java.lang.String parentTitle, java.lang.String redirectTitle, ServiceContext serviceContext)
static WikiPage	addPage(long userId, long nodeId, java.lang.String title, java.lang.String content, java.lang.String summary, boolean minorEdit, ServiceContext serviceContext)
static FileEntry	addPageAttachment(long userId, long nodeId, java.lang.String title, java.lang.String fileName, java.io.File file, java.lang.String mimeType)
static FileEntry	addPageAttachment(long userId, long nodeId, java.lang.String title, java.lang.String fileName, java.io.InputStream inputStream, java.lang.String mimeType)
static java.util.List<FileEntry>	addPageAttachments(long userId, long nodeId, java.lang.String title, java.util.List<ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs)
static void	addPageResources(long nodeId, java.lang.String title, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addPageResources(WikiPage page, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addPageResources(WikiPage page, ModelPermissions modelPermissions)
static FileEntry	addTempFileEntry(long groupId, long userId, java.lang.String folderName, java.lang.String fileName, java.io.InputStream inputStream, java.lang.String mimeType)
static WikiPage	addWikiPage(WikiPage wikiPage) Adds the wiki page to the database.
static WikiPage	changeParent(long userId, long nodeId, java.lang.String title, java.lang.String newParentTitle, ServiceContext serviceContext)
static void	copyPageAttachments(long userId, long templateNodeId, java.lang.String templateTitle, long nodeId, java.lang.String title)
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static WikiPage	createWikiPage(long pageId) Creates a new wiki page with the primary key.
static void	deletePage(long nodeId, java.lang.String title)
static void	deletePage(WikiPage page)
static void	deletePageAttachment(long nodeId, java.lang.String title, java.lang.String fileName)
static void	deletePageAttachments(long nodeId, java.lang.String title)
static void	deletePages(long nodeId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static void	deleteTempFileEntry(long groupId, long userId, java.lang.String folderName, java.lang.String fileName)
static void	deleteTrashPageAttachments(long nodeId, java.lang.String title)
static WikiPage	deleteWikiPage(long pageId) Deletes the wiki page with the primary key from the database.
static WikiPage	deleteWikiPage(WikiPage wikiPage) Deletes the wiki page from the database.
static void	discardDraft(long nodeId, java.lang.String title, double version)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.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> java.util.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 matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static WikiPage	fetchLatestPage(long resourcePrimKey, int status, boolean preferApproved)
static WikiPage	fetchLatestPage(long resourcePrimKey, long nodeId, int status, boolean preferApproved)
static WikiPage	fetchLatestPage(long nodeId, java.lang.String title, int status, boolean preferApproved)
static WikiPage	fetchPage(long resourcePrimKey)
static WikiPage	fetchPage(long nodeId, java.lang.String title)
static WikiPage	fetchPage(long nodeId, java.lang.String title, double version)
static WikiPage	fetchWikiPage(long pageId)
static WikiPage	fetchWikiPageByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the wiki page matching the UUID and group.
static ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<WikiPage>	getChildren(long nodeId, boolean head, java.lang.String parentTitle)
static java.util.List<WikiPage>	getChildren(long nodeId, boolean head, java.lang.String parentTitle, int status)
static java.util.List<WikiPage>	getChildren(long nodeId, boolean head, java.lang.String parentTitle, int start, int end)
static java.util.List<WikiPage>	getChildren(long nodeId, boolean head, java.lang.String parentTitle, int status, int start, int end, OrderByComparator<WikiPage> orderByComparator)
static int	getChildrenCount(long nodeId, boolean head, java.lang.String parentTitle)
static int	getChildrenCount(long nodeId, boolean head, java.lang.String parentTitle, int status)
static java.util.List<WikiPage>	getDependentPages(long nodeId, boolean head, java.lang.String title, int status)
static WikiPageDisplay	getDisplay(long nodeId, java.lang.String title, javax.portlet.PortletURL viewPageURL, java.util.function.Supplier<javax.portlet.PortletURL> editPageURLSupplier, java.lang.String attachmentURLPrefix)
static WikiPage	getDraftPage(long nodeId, java.lang.String title)
static ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
static java.util.List<WikiPage>	getIncomingLinks(long nodeId, java.lang.String title)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static WikiPage	getLatestPage(long resourcePrimKey, int status, boolean preferApproved)
static WikiPage	getLatestPage(long resourcePrimKey, long nodeId, int status, boolean preferApproved)
static WikiPage	getLatestPage(long nodeId, java.lang.String title, int status, boolean preferApproved)
static java.util.List<WikiPage>	getOrphans(java.util.List<WikiPage> pages)
static java.util.List<WikiPage>	getOrphans(long nodeId)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static java.util.List<WikiPage>	getOutgoingLinks(long nodeId, java.lang.String title)
static WikiPage	getPage(long resourcePrimKey)
static WikiPage	getPage(long resourcePrimKey, java.lang.Boolean head)
static WikiPage	getPage(long nodeId, java.lang.String title)
static WikiPage	getPage(long nodeId, java.lang.String title, java.lang.Boolean head)
static WikiPage	getPage(long nodeId, java.lang.String title, double version)
static WikiPage	getPageByPageId(long pageId)
static WikiPageDisplay	getPageDisplay(long nodeId, java.lang.String title, javax.portlet.PortletURL viewPageURL, javax.portlet.PortletURL editPageURL, java.lang.String attachmentURLPrefix)
static WikiPageDisplay	getPageDisplay(WikiPage page, javax.portlet.PortletURL viewPageURL, javax.portlet.PortletURL editPageURL, java.lang.String attachmentURLPrefix)
static WikiPageDisplay	getPageDisplay(WikiPage page, javax.portlet.PortletURL viewPageURL, javax.portlet.PortletURL editPageURL, java.lang.String attachmentURLPrefix, ServiceContext serviceContext)
static WikiPageDisplay	getPageDisplay(WikiPage page, javax.portlet.PortletURL viewPageURL, java.util.function.Supplier<javax.portlet.PortletURL> editPageURLSupplier, java.lang.String attachmentURLPrefix, ServiceContext serviceContext)
static java.util.List<WikiPage>	getPages(long nodeId, boolean head, int start, int end)
static java.util.List<WikiPage>	getPages(long nodeId, boolean head, int status, int start, int end)
static java.util.List<WikiPage>	getPages(long nodeId, boolean head, int status, int start, int end, OrderByComparator<WikiPage> orderByComparator)
static java.util.List<WikiPage>	getPages(long nodeId, boolean head, int start, int end, OrderByComparator<WikiPage> orderByComparator)
static java.util.List<WikiPage>	getPages(long nodeId, int start, int end)
static java.util.List<WikiPage>	getPages(long nodeId, int start, int end, OrderByComparator<WikiPage> orderByComparator)
static java.util.List<WikiPage>	getPages(long resourcePrimKey, long nodeId, int status)
static java.util.List<WikiPage>	getPages(long userId, long nodeId, int status, int start, int end)
static java.util.List<WikiPage>	getPages(long nodeId, java.lang.String title, boolean head, int start, int end)
static java.util.List<WikiPage>	getPages(long nodeId, java.lang.String title, int start, int end)
static java.util.List<WikiPage>	getPages(long nodeId, java.lang.String title, int start, int end, OrderByComparator<WikiPage> orderByComparator)
static java.util.List<WikiPage>	getPages(java.lang.String format)
static int	getPagesCount(long nodeId)
static int	getPagesCount(long nodeId, boolean head)
static int	getPagesCount(long nodeId, boolean head, int status)
static int	getPagesCount(long nodeId, int status)
static int	getPagesCount(long userId, long nodeId, int status)
static int	getPagesCount(long nodeId, java.lang.String title)
static int	getPagesCount(long nodeId, java.lang.String title, boolean head)
static int	getPagesCount(java.lang.String format)
static java.util.List<? extends PersistedModel>	getPersistedModel(long resourcePrimKey)
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static WikiPage	getPreviousVersionPage(WikiPage page)
static java.util.List<WikiPage>	getRecentChanges(long groupId, long nodeId, int start, int end)
static int	getRecentChangesCount(long groupId, long nodeId)
static java.util.List<WikiPage>	getRedirectorPages(long nodeId, boolean head, java.lang.String redirectTitle, int status)
static java.util.List<WikiPage>	getRedirectorPages(long nodeId, java.lang.String redirectTitle)
static WikiPageLocalService	getService()
static java.lang.String[]	getTempFileNames(long groupId, long userId, java.lang.String folderName)
static WikiPage	getWikiPage(long pageId) Returns the wiki page with the primary key.
static WikiPage	getWikiPageByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the wiki page matching the UUID and group.
static java.util.List<WikiPage>	getWikiPages(int start, int end) Returns a range of all the wiki pages.
static java.util.List<WikiPage>	getWikiPagesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the wiki pages matching the UUID and company.
static java.util.List<WikiPage>	getWikiPagesByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<WikiPage> orderByComparator) Returns a range of wiki pages matching the UUID and company.
static int	getWikiPagesCount() Returns the number of wiki pages.
static boolean	hasDraftPage(long nodeId, java.lang.String title)
static void	moveDependentToTrash(WikiPage page, long trashEntryId)
static FileEntry	movePageAttachmentToTrash(long userId, long nodeId, java.lang.String title, java.lang.String fileName)
static WikiPage	movePageFromTrash(long userId, long nodeId, java.lang.String title, long newNodeId, java.lang.String newParentTitle)
static WikiPage	movePageToTrash(long userId, long nodeId, java.lang.String title)
static WikiPage	movePageToTrash(long userId, long nodeId, java.lang.String title, double version)
static WikiPage	movePageToTrash(long userId, WikiPage page)
static void	renamePage(long userId, long nodeId, java.lang.String title, java.lang.String newTitle, boolean strict, ServiceContext serviceContext)
static void	renamePage(long userId, long nodeId, java.lang.String title, java.lang.String newTitle, ServiceContext serviceContext)
static void	restorePageAttachmentFromTrash(long userId, long nodeId, java.lang.String title, java.lang.String fileName)
static void	restorePageFromTrash(long userId, WikiPage page)
static WikiPage	revertPage(long userId, long nodeId, java.lang.String title, double version, ServiceContext serviceContext)
static void	subscribePage(long userId, long nodeId, java.lang.String title)
static void	unsubscribePage(long userId, long nodeId, java.lang.String title)
static void	updateAsset(long userId, WikiPage page, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds, java.lang.Double priority)
static void	updateLastPostDate(long nodeId, java.util.Date lastPostDate)
static WikiPage	updatePage(long userId, long nodeId, java.lang.String title, double version, java.lang.String content, java.lang.String summary, boolean minorEdit, java.lang.String format, java.lang.String parentTitle, java.lang.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, java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
static WikiPage	updateWikiPage(WikiPage wikiPage) Updates the wiki page in the database or adds it if it does not yet exist.
static WikiPage	updateWikiPage(WikiPage wikiPage, ServiceContext serviceContext)

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

addPage

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

Throws:

PortalException

addPage

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

Throws:

PortalException

addPageAttachment

public static FileEntry addPageAttachment(long userId,
                                          long nodeId,
                                          java.lang.String title,
                                          java.lang.String fileName,
                                          java.io.File file,
                                          java.lang.String mimeType)
                                   throws PortalException

Throws:

PortalException

addPageAttachment

public static FileEntry addPageAttachment(long userId,
                                          long nodeId,
                                          java.lang.String title,
                                          java.lang.String fileName,
                                          java.io.InputStream inputStream,
                                          java.lang.String mimeType)
                                   throws PortalException

Throws:

PortalException

addPageAttachments

public static java.util.List<FileEntry> addPageAttachments(long userId,
                                                           long nodeId,
                                                           java.lang.String title,
                                                           java.util.List<ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs)
                                                    throws PortalException

Throws:

PortalException

addPageResources

public static void addPageResources(long nodeId,
                                    java.lang.String title,
                                    boolean addGroupPermissions,
                                    boolean addGuestPermissions)
                             throws PortalException

Throws:

PortalException

addPageResources

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

Throws:

PortalException

addPageResources

public static void addPageResources(WikiPage page,
                                    ModelPermissions modelPermissions)
                             throws PortalException

Throws:

PortalException

addTempFileEntry

public static FileEntry addTempFileEntry(long groupId,
                                         long userId,
                                         java.lang.String folderName,
                                         java.lang.String fileName,
                                         java.io.InputStream inputStream,
                                         java.lang.String mimeType)
                                  throws PortalException

Throws:

PortalException

addWikiPage

public static WikiPage addWikiPage(WikiPage wikiPage)

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

Parameters:

wikiPage - the wiki page

Returns:

the wiki page that was added

changeParent

public static WikiPage changeParent(long userId,
                                    long nodeId,
                                    java.lang.String title,
                                    java.lang.String newParentTitle,
                                    ServiceContext serviceContext)
                             throws PortalException

Throws:

PortalException

copyPageAttachments

public static void copyPageAttachments(long userId,
                                       long templateNodeId,
                                       java.lang.String templateTitle,
                                       long nodeId,
                                       java.lang.String title)
                                throws PortalException

Throws:

PortalException

createPersistedModel

public static PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

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

deletePage

public static void deletePage(long nodeId,
                              java.lang.String title)
                       throws PortalException

Throws:

PortalException

deletePage

public static void deletePage(WikiPage page)
                       throws PortalException

Throws:

PortalException

deletePageAttachment

public static void deletePageAttachment(long nodeId,
                                        java.lang.String title,
                                        java.lang.String fileName)
                                 throws PortalException

Throws:

PortalException

deletePageAttachments

public static void deletePageAttachments(long nodeId,
                                         java.lang.String title)
                                  throws PortalException

Throws:

PortalException

deletePages

public static void deletePages(long nodeId)
                        throws PortalException

Throws:

PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

deleteTempFileEntry

public static void deleteTempFileEntry(long groupId,
                                       long userId,
                                       java.lang.String folderName,
                                       java.lang.String fileName)
                                throws PortalException

Throws:

PortalException

deleteTrashPageAttachments

public static void deleteTrashPageAttachments(long nodeId,
                                              java.lang.String title)
                                       throws PortalException

Throws:

PortalException

deleteWikiPage

public static WikiPage deleteWikiPage(long pageId)
                               throws PortalException

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

Returns:

the wiki page that was removed

Throws:

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

deleteWikiPage

public static WikiPage deleteWikiPage(WikiPage wikiPage)

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

Parameters:

wikiPage - the wiki page

Returns:

the wiki page that was removed

discardDraft

public static void discardDraft(long nodeId,
                                java.lang.String title,
                                double version)
                         throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.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> java.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.wiki.model.impl.WikiPageModelImpl.

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> java.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.wiki.model.impl.WikiPageModelImpl.

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 matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchLatestPage

public static WikiPage fetchLatestPage(long resourcePrimKey,
                                       int status,
                                       boolean preferApproved)

fetchLatestPage

public static WikiPage fetchLatestPage(long resourcePrimKey,
                                       long nodeId,
                                       int status,
                                       boolean preferApproved)

fetchLatestPage

public static WikiPage fetchLatestPage(long nodeId,
                                       java.lang.String title,
                                       int status,
                                       boolean preferApproved)

fetchPage

public static WikiPage fetchPage(long resourcePrimKey)

fetchPage

public static WikiPage fetchPage(long nodeId,
                                 java.lang.String title)

fetchPage

public static WikiPage fetchPage(long nodeId,
                                 java.lang.String title,
                                 double version)

fetchWikiPage

public static WikiPage fetchWikiPage(long pageId)

fetchWikiPageByUuidAndGroupId

public static WikiPage fetchWikiPageByUuidAndGroupId(java.lang.String uuid,
                                                     long groupId)

Returns the wiki page matching the UUID and group.

Parameters:

uuid - the wiki page's UUID

groupId - the primary key of the group

Returns:

the matching wiki page, or null if a matching wiki page could not be found

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getChildren

public static java.util.List<WikiPage> getChildren(long nodeId,
                                                   boolean head,
                                                   java.lang.String parentTitle)

getChildren

public static java.util.List<WikiPage> getChildren(long nodeId,
                                                   boolean head,
                                                   java.lang.String parentTitle,
                                                   int status)

getChildren

public static java.util.List<WikiPage> getChildren(long nodeId,
                                                   boolean head,
                                                   java.lang.String parentTitle,
                                                   int start,
                                                   int end)

getChildren

public static java.util.List<WikiPage> getChildren(long nodeId,
                                                   boolean head,
                                                   java.lang.String parentTitle,
                                                   int status,
                                                   int start,
                                                   int end,
                                                   OrderByComparator<WikiPage> orderByComparator)

getChildrenCount

public static int getChildrenCount(long nodeId,
                                   boolean head,
                                   java.lang.String parentTitle)

getChildrenCount

public static int getChildrenCount(long nodeId,
                                   boolean head,
                                   java.lang.String parentTitle,
                                   int status)

getDependentPages

public static java.util.List<WikiPage> getDependentPages(long nodeId,
                                                         boolean head,
                                                         java.lang.String title,
                                                         int status)

getDisplay

public static WikiPageDisplay getDisplay(long nodeId,
                                         java.lang.String title,
                                         javax.portlet.PortletURL viewPageURL,
                                         java.util.function.Supplier<javax.portlet.PortletURL> editPageURLSupplier,
                                         java.lang.String attachmentURLPrefix)
                                  throws PortalException

Throws:

PortalException

getDraftPage

public static WikiPage getDraftPage(long nodeId,
                                    java.lang.String title)
                             throws PortalException

Throws:

PortalException

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIncomingLinks

public static java.util.List<WikiPage> getIncomingLinks(long nodeId,
                                                        java.lang.String title)
                                                 throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getLatestPage

public static WikiPage getLatestPage(long resourcePrimKey,
                                     int status,
                                     boolean preferApproved)
                              throws PortalException

Throws:

PortalException

getLatestPage

public static WikiPage getLatestPage(long resourcePrimKey,
                                     long nodeId,
                                     int status,
                                     boolean preferApproved)
                              throws PortalException

Throws:

PortalException

getLatestPage

public static WikiPage getLatestPage(long nodeId,
                                     java.lang.String title,
                                     int status,
                                     boolean preferApproved)
                              throws PortalException

Throws:

PortalException

getOrphans

public static java.util.List<WikiPage> getOrphans(java.util.List<WikiPage> pages)
                                           throws PortalException

Throws:

PortalException

getOrphans

public static java.util.List<WikiPage> getOrphans(long nodeId)
                                           throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getOutgoingLinks

public static java.util.List<WikiPage> getOutgoingLinks(long nodeId,
                                                        java.lang.String title)
                                                 throws PortalException

Throws:

PortalException

getPage

public static WikiPage getPage(long resourcePrimKey)
                        throws PortalException

Throws:

PortalException

getPage

public static WikiPage getPage(long resourcePrimKey,
                               java.lang.Boolean head)
                        throws PortalException

Throws:

PortalException

getPage

public static WikiPage getPage(long nodeId,
                               java.lang.String title)
                        throws PortalException

Throws:

PortalException

getPage

public static WikiPage getPage(long nodeId,
                               java.lang.String title,
                               java.lang.Boolean head)
                        throws PortalException

Throws:

PortalException

getPage

public static WikiPage getPage(long nodeId,
                               java.lang.String title,
                               double version)
                        throws PortalException

Throws:

PortalException

getPageByPageId

public static WikiPage getPageByPageId(long pageId)
                                throws PortalException

Throws:

PortalException

getPageDisplay

public static WikiPageDisplay getPageDisplay(long nodeId,
                                             java.lang.String title,
                                             javax.portlet.PortletURL viewPageURL,
                                             javax.portlet.PortletURL editPageURL,
                                             java.lang.String attachmentURLPrefix)
                                      throws PortalException

Throws:

PortalException

getPageDisplay

public static WikiPageDisplay getPageDisplay(WikiPage page,
                                             javax.portlet.PortletURL viewPageURL,
                                             javax.portlet.PortletURL editPageURL,
                                             java.lang.String attachmentURLPrefix)
                                      throws PortalException

Throws:

PortalException

getPageDisplay

public static WikiPageDisplay getPageDisplay(WikiPage page,
                                             javax.portlet.PortletURL viewPageURL,
                                             javax.portlet.PortletURL editPageURL,
                                             java.lang.String attachmentURLPrefix,
                                             ServiceContext serviceContext)
                                      throws PortalException

Throws:

PortalException

getPageDisplay

public static WikiPageDisplay getPageDisplay(WikiPage page,
                                             javax.portlet.PortletURL viewPageURL,
                                             java.util.function.Supplier<javax.portlet.PortletURL> editPageURLSupplier,
                                             java.lang.String attachmentURLPrefix,
                                             ServiceContext serviceContext)
                                      throws PortalException

Throws:

PortalException

getPages

public static java.util.List<WikiPage> getPages(long nodeId,
                                                boolean head,
                                                int start,
                                                int end)

getPages

public static java.util.List<WikiPage> getPages(long nodeId,
                                                boolean head,
                                                int status,
                                                int start,
                                                int end)

getPages

public static java.util.List<WikiPage> getPages(long nodeId,
                                                boolean head,
                                                int status,
                                                int start,
                                                int end,
                                                OrderByComparator<WikiPage> orderByComparator)

getPages

public static java.util.List<WikiPage> getPages(long nodeId,
                                                boolean head,
                                                int start,
                                                int end,
                                                OrderByComparator<WikiPage> orderByComparator)

getPages

public static java.util.List<WikiPage> getPages(long nodeId,
                                                int start,
                                                int end)

getPages

public static java.util.List<WikiPage> getPages(long nodeId,
                                                int start,
                                                int end,
                                                OrderByComparator<WikiPage> orderByComparator)

getPages

public static java.util.List<WikiPage> getPages(long resourcePrimKey,
                                                long nodeId,
                                                int status)

getPages

public static java.util.List<WikiPage> getPages(long userId,
                                                long nodeId,
                                                int status,
                                                int start,
                                                int end)

getPages

public static java.util.List<WikiPage> getPages(long nodeId,
                                                java.lang.String title,
                                                boolean head,
                                                int start,
                                                int end)

getPages

public static java.util.List<WikiPage> getPages(long nodeId,
                                                java.lang.String title,
                                                int start,
                                                int end)

getPages

public static java.util.List<WikiPage> getPages(long nodeId,
                                                java.lang.String title,
                                                int start,
                                                int end,
                                                OrderByComparator<WikiPage> orderByComparator)

getPages

public static java.util.List<WikiPage> getPages(java.lang.String format)

getPagesCount

public static int getPagesCount(long nodeId)

getPagesCount

public static int getPagesCount(long nodeId,
                                boolean head)

getPagesCount

public static int getPagesCount(long nodeId,
                                boolean head,
                                int status)

getPagesCount

public static int getPagesCount(long nodeId,
                                int status)

getPagesCount

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

getPagesCount

public static int getPagesCount(long nodeId,
                                java.lang.String title)

getPagesCount

public static int getPagesCount(long nodeId,
                                java.lang.String title,
                                boolean head)

getPagesCount

public static int getPagesCount(java.lang.String format)

getPersistedModel

public static java.util.List<? extends PersistedModel> getPersistedModel(long resourcePrimKey)
                                                                  throws PortalException

Throws:

PortalException

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getPreviousVersionPage

public static WikiPage getPreviousVersionPage(WikiPage page)
                                       throws PortalException

Throws:

PortalException

getRecentChanges

public static java.util.List<WikiPage> getRecentChanges(long groupId,
                                                        long nodeId,
                                                        int start,
                                                        int end)

getRecentChangesCount

public static int getRecentChangesCount(long groupId,
                                        long nodeId)

getRedirectorPages

public static java.util.List<WikiPage> getRedirectorPages(long nodeId,
                                                          boolean head,
                                                          java.lang.String redirectTitle,
                                                          int status)

getRedirectorPages

public static java.util.List<WikiPage> getRedirectorPages(long nodeId,
                                                          java.lang.String redirectTitle)

getTempFileNames

public static java.lang.String[] getTempFileNames(long groupId,
                                                  long userId,
                                                  java.lang.String folderName)
                                           throws PortalException

Throws:

PortalException

getWikiPage

public static WikiPage getWikiPage(long pageId)
                            throws PortalException

Returns the wiki page with the primary key.

Parameters:

pageId - the primary key of the wiki page

Returns:

the wiki page

Throws:

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

getWikiPageByUuidAndGroupId

public static WikiPage getWikiPageByUuidAndGroupId(java.lang.String uuid,
                                                   long groupId)
                                            throws PortalException

Returns the wiki page matching the UUID and group.

Parameters:

uuid - the wiki page's UUID

groupId - the primary key of the group

Returns:

the matching wiki page

Throws:

PortalException - if a matching wiki page could not be found

getWikiPages

public static java.util.List<WikiPage> getWikiPages(int start,
                                                    int end)

Returns 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.wiki.model.impl.WikiPageModelImpl.

Parameters:

start - the lower bound of the range of wiki pages

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

Returns:

the range of wiki pages

getWikiPagesByUuidAndCompanyId

public static java.util.List<WikiPage> getWikiPagesByUuidAndCompanyId(java.lang.String uuid,
                                                                      long companyId)

Returns all the wiki pages matching the UUID and company.

Parameters:

uuid - the UUID of the wiki pages

companyId - the primary key of the company

Returns:

the matching wiki pages, or an empty list if no matches were found

getWikiPagesByUuidAndCompanyId

public static java.util.List<WikiPage> getWikiPagesByUuidAndCompanyId(java.lang.String uuid,
                                                                      long companyId,
                                                                      int start,
                                                                      int end,
                                                                      OrderByComparator<WikiPage> orderByComparator)

Returns a range of wiki pages matching the UUID and company.

Parameters:

uuid - the UUID of the wiki pages

companyId - the primary key of the company

start - the lower bound of the range of wiki pages

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

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching wiki pages, or an empty list if no matches were found

getWikiPagesCount

public static int getWikiPagesCount()

Returns the number of wiki pages.

Returns:

the number of wiki pages

hasDraftPage

public static boolean hasDraftPage(long nodeId,
                                   java.lang.String title)

moveDependentToTrash

public static void moveDependentToTrash(WikiPage page,
                                        long trashEntryId)
                                 throws PortalException

Throws:

PortalException

movePageAttachmentToTrash

public static FileEntry movePageAttachmentToTrash(long userId,
                                                  long nodeId,
                                                  java.lang.String title,
                                                  java.lang.String fileName)
                                           throws PortalException

Throws:

PortalException

movePageFromTrash

public static WikiPage movePageFromTrash(long userId,
                                         long nodeId,
                                         java.lang.String title,
                                         long newNodeId,
                                         java.lang.String newParentTitle)
                                  throws PortalException

Throws:

PortalException

movePageToTrash

public static WikiPage movePageToTrash(long userId,
                                       long nodeId,
                                       java.lang.String title)
                                throws PortalException

Throws:

PortalException

movePageToTrash

public static WikiPage movePageToTrash(long userId,
                                       long nodeId,
                                       java.lang.String title,
                                       double version)
                                throws PortalException

Throws:

PortalException

movePageToTrash

public static WikiPage movePageToTrash(long userId,
                                       WikiPage page)
                                throws PortalException

Throws:

PortalException

renamePage

public static void renamePage(long userId,
                              long nodeId,
                              java.lang.String title,
                              java.lang.String newTitle,
                              boolean strict,
                              ServiceContext serviceContext)
                       throws PortalException

Throws:

PortalException

renamePage

public static void renamePage(long userId,
                              long nodeId,
                              java.lang.String title,
                              java.lang.String newTitle,
                              ServiceContext serviceContext)
                       throws PortalException

Throws:

PortalException

restorePageAttachmentFromTrash

public static void restorePageAttachmentFromTrash(long userId,
                                                  long nodeId,
                                                  java.lang.String title,
                                                  java.lang.String fileName)
                                           throws PortalException

Throws:

PortalException

restorePageFromTrash

public static void restorePageFromTrash(long userId,
                                        WikiPage page)
                                 throws PortalException

Throws:

PortalException

revertPage

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

Throws:

PortalException

subscribePage

public static void subscribePage(long userId,
                                 long nodeId,
                                 java.lang.String title)
                          throws PortalException

Throws:

PortalException

unsubscribePage

public static void unsubscribePage(long userId,
                                   long nodeId,
                                   java.lang.String title)
                            throws PortalException

Throws:

PortalException

updateAsset

public static void updateAsset(long userId,
                               WikiPage page,
                               long[] assetCategoryIds,
                               java.lang.String[] assetTagNames,
                               long[] assetLinkEntryIds,
                               java.lang.Double priority)
                        throws PortalException

Throws:

PortalException

updateLastPostDate

public static void updateLastPostDate(long nodeId,
                                      java.util.Date lastPostDate)

updatePage

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

Throws:

PortalException

updateStatus

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

Throws:

PortalException

updateStatus

public static WikiPage updateStatus(long userId,
                                    WikiPage page,
                                    int status,
                                    ServiceContext serviceContext,
                                    java.util.Map<java.lang.String,java.io.Serializable> workflowContext)
                             throws PortalException

Throws:

PortalException

updateWikiPage

public static WikiPage updateWikiPage(WikiPage wikiPage)

Updates the wiki page in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

wikiPage - the wiki page

Returns:

the wiki page that was updated

updateWikiPage

public static WikiPage updateWikiPage(WikiPage wikiPage,
                                      ServiceContext serviceContext)

getService

public static WikiPageLocalService getService()