com.liferay.wiki.service

Class WikiPageServiceUtil

java.lang.Object

com.liferay.wiki.service.WikiPageServiceUtil

public class WikiPageServiceUtil
extends java.lang.Object

Provides the remote service utility for WikiPage. This utility wraps com.liferay.wiki.service.impl.WikiPageServiceImpl and is an access point for service operations in application layer code running on a remote server. Methods of this service are expected to have security checks based on the propagated JAAS credentials because this service can be accessed remotely.

See Also:

WikiPageService

Generated:

Constructor Summary

Constructors

Constructor and Description
WikiPageServiceUtil()

Method Summary

Modifier and Type	Method and Description
static WikiPage	addPage(long nodeId, java.lang.String title, java.lang.String content, java.lang.String summary, boolean minorEdit, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static WikiPage	addPage(long nodeId, java.lang.String title, java.lang.String content, java.lang.String summary, boolean minorEdit, java.lang.String format, java.lang.String parentTitle, java.lang.String redirectTitle, com.liferay.portal.kernel.service.ServiceContext serviceContext) Deprecated. As of Cavanaugh (7.4.x), replaced by addPage(String, long, String, String, String, boolean, String, String, String, ServiceContext)
static WikiPage	addPage(java.lang.String externalReferenceCode, long nodeId, java.lang.String title, java.lang.String content, java.lang.String summary, boolean minorEdit, java.lang.String format, java.lang.String parentTitle, java.lang.String redirectTitle, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static com.liferay.portal.kernel.repository.model.FileEntry	addPageAttachment(long nodeId, java.lang.String title, java.lang.String fileName, java.io.File file, java.lang.String mimeType)
static com.liferay.portal.kernel.repository.model.FileEntry	addPageAttachment(long nodeId, java.lang.String title, java.lang.String fileName, java.io.InputStream inputStream, java.lang.String mimeType)
static java.util.List<com.liferay.portal.kernel.repository.model.FileEntry>	addPageAttachments(long nodeId, java.lang.String title, java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs)
static com.liferay.portal.kernel.repository.model.FileEntry	addTempFileEntry(long nodeId, java.lang.String folderName, java.lang.String fileName, java.io.InputStream inputStream, java.lang.String mimeType)
static void	changeParent(long nodeId, java.lang.String title, java.lang.String newParentTitle, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	copyPageAttachments(long templateNodeId, java.lang.String templateTitle, long nodeId, java.lang.String title)
static void	deletePage(long nodeId, java.lang.String title)
static void	deletePageAttachment(long nodeId, java.lang.String title, java.lang.String fileName)
static void	deletePageAttachments(long nodeId, java.lang.String title)
static void	deleteTempFileEntry(long nodeId, java.lang.String folderName, java.lang.String fileName)
static void	deleteTrashPageAttachments(long nodeId, java.lang.String title)
static void	discardDraft(long nodeId, java.lang.String title, double version)
static WikiPage	fetchLatestPageByExternalReferenceCode(long groupId, java.lang.String externalReferenceCode) Returns the latest wiki page matching the group and the external reference code
static WikiPage	fetchPage(long nodeId, java.lang.String title, double version)
static java.util.List<WikiPage>	getChildren(long groupId, long nodeId, boolean head, java.lang.String parentTitle)
static WikiPage	getDraftPage(long nodeId, java.lang.String title)
static WikiPage	getLatestPageByExternalReferenceCode(long groupId, java.lang.String externalReferenceCode) Returns the latest wiki page matching the group and the external reference code
static java.util.List<WikiPage>	getNodePages(long nodeId, int max)
static java.lang.String	getNodePagesRSS(long nodeId, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL, java.lang.String attachmentURLPrefix)
static java.util.List<WikiPage>	getOrphans(WikiNode node)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static WikiPage	getPage(long pageId)
static WikiPage	getPage(long groupId, long nodeId, java.lang.String title)
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 java.util.List<WikiPage>	getPages(long groupId, long nodeId, boolean head, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<WikiPage> orderByComparator)
static java.util.List<WikiPage>	getPages(long groupId, long nodeId, boolean head, long userId, boolean includeOwner, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<WikiPage> orderByComparator)
static java.util.List<WikiPage>	getPages(long groupId, long userId, long nodeId, int status, int start, int end)
static int	getPagesCount(long groupId, long nodeId, boolean head)
static int	getPagesCount(long groupId, long nodeId, boolean head, long userId, boolean includeOwner, int status)
static int	getPagesCount(long groupId, long userId, long nodeId, int status)
static java.lang.String	getPagesRSS(long nodeId, java.lang.String title, int max, java.lang.String type, double version, java.lang.String displayStyle, java.lang.String feedURL, java.lang.String entryURL, java.lang.String attachmentURLPrefix, java.util.Locale locale)
static java.util.List<WikiPage>	getRecentChanges(long groupId, long nodeId, int start, int end)
static int	getRecentChangesCount(long groupId, long nodeId)
static WikiPageService	getService()
static java.lang.String[]	getTempFileNames(long nodeId, java.lang.String folderName)
static com.liferay.portal.kernel.repository.model.FileEntry	movePageAttachmentToTrash(long nodeId, java.lang.String title, java.lang.String fileName)
static WikiPage	movePageToTrash(long nodeId, java.lang.String title)
static WikiPage	movePageToTrash(long nodeId, java.lang.String title, double version)
static void	renamePage(long nodeId, java.lang.String title, java.lang.String newTitle, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	restorePageAttachmentFromTrash(long nodeId, java.lang.String title, java.lang.String fileName)
static void	restorePageFromTrash(long resourcePrimKey)
static WikiPage	revertPage(long nodeId, java.lang.String title, double version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	subscribePage(long nodeId, java.lang.String title)
static void	unsubscribePage(long nodeId, java.lang.String title)
static WikiPage	updatePage(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, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

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

Constructor Detail

WikiPageServiceUtil

public WikiPageServiceUtil()

Method Detail

addPage

public static WikiPage addPage(long nodeId,
                               java.lang.String title,
                               java.lang.String content,
                               java.lang.String summary,
                               boolean minorEdit,
                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addPage

@Deprecated
public static WikiPage addPage(long nodeId,
                                           java.lang.String title,
                                           java.lang.String content,
                                           java.lang.String summary,
                                           boolean minorEdit,
                                           java.lang.String format,
                                           java.lang.String parentTitle,
                                           java.lang.String redirectTitle,
                                           com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                    throws com.liferay.portal.kernel.exception.PortalException

Deprecated. As of Cavanaugh (7.4.x), replaced by addPage(String, long, String, String, String, boolean, String, String, String, ServiceContext)

Throws:

com.liferay.portal.kernel.exception.PortalException

addPage

public static WikiPage addPage(java.lang.String externalReferenceCode,
                               long nodeId,
                               java.lang.String title,
                               java.lang.String content,
                               java.lang.String summary,
                               boolean minorEdit,
                               java.lang.String format,
                               java.lang.String parentTitle,
                               java.lang.String redirectTitle,
                               com.liferay.portal.kernel.service.ServiceContext serviceContext)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addPageAttachment

public static com.liferay.portal.kernel.repository.model.FileEntry addPageAttachment(long nodeId,
                                                                                     java.lang.String title,
                                                                                     java.lang.String fileName,
                                                                                     java.io.File file,
                                                                                     java.lang.String mimeType)
                                                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addPageAttachment

public static com.liferay.portal.kernel.repository.model.FileEntry addPageAttachment(long nodeId,
                                                                                     java.lang.String title,
                                                                                     java.lang.String fileName,
                                                                                     java.io.InputStream inputStream,
                                                                                     java.lang.String mimeType)
                                                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addPageAttachments

public static java.util.List<com.liferay.portal.kernel.repository.model.FileEntry> addPageAttachments(long nodeId,
                                                                                                      java.lang.String title,
                                                                                                      java.util.List<com.liferay.portal.kernel.util.ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs)
                                                                                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addTempFileEntry

public static com.liferay.portal.kernel.repository.model.FileEntry addTempFileEntry(long nodeId,
                                                                                    java.lang.String folderName,
                                                                                    java.lang.String fileName,
                                                                                    java.io.InputStream inputStream,
                                                                                    java.lang.String mimeType)
                                                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

changeParent

public static void changeParent(long nodeId,
                                java.lang.String title,
                                java.lang.String newParentTitle,
                                com.liferay.portal.kernel.service.ServiceContext serviceContext)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

copyPageAttachments

public static void copyPageAttachments(long templateNodeId,
                                       java.lang.String templateTitle,
                                       long nodeId,
                                       java.lang.String title)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePage

public static void deletePage(long nodeId,
                              java.lang.String title)
                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePageAttachment

public static void deletePageAttachment(long nodeId,
                                        java.lang.String title,
                                        java.lang.String fileName)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePageAttachments

public static void deletePageAttachments(long nodeId,
                                         java.lang.String title)
                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteTempFileEntry

public static void deleteTempFileEntry(long nodeId,
                                       java.lang.String folderName,
                                       java.lang.String fileName)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteTrashPageAttachments

public static void deleteTrashPageAttachments(long nodeId,
                                              java.lang.String title)
                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

discardDraft

public static void discardDraft(long nodeId,
                                java.lang.String title,
                                double version)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

fetchLatestPageByExternalReferenceCode

public static WikiPage fetchLatestPageByExternalReferenceCode(long groupId,
                                                              java.lang.String externalReferenceCode)
                                                       throws com.liferay.portal.kernel.exception.PortalException

Returns the latest wiki page matching the group and the external reference code

Parameters:

groupId - the primary key of the group

externalReferenceCode - the wiki page external reference code

Returns:

the latest matching wiki page, or null if no matching wiki page could be found

Throws:

com.liferay.portal.kernel.exception.PortalException

fetchPage

public static WikiPage fetchPage(long nodeId,
                                 java.lang.String title,
                                 double version)
                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getChildren

public static java.util.List<WikiPage> getChildren(long groupId,
                                                   long nodeId,
                                                   boolean head,
                                                   java.lang.String parentTitle)
                                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getDraftPage

public static WikiPage getDraftPage(long nodeId,
                                    java.lang.String title)
                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getLatestPageByExternalReferenceCode

public static WikiPage getLatestPageByExternalReferenceCode(long groupId,
                                                            java.lang.String externalReferenceCode)
                                                     throws com.liferay.portal.kernel.exception.PortalException

Returns the latest wiki page matching the group and the external reference code

Parameters:

groupId - the primary key of the group

externalReferenceCode - the wiki page external reference code

Returns:

the latest matching wiki page

Throws:

com.liferay.portal.kernel.exception.PortalException - if a portal exception occurred

getNodePages

public static java.util.List<WikiPage> getNodePages(long nodeId,
                                                    int max)
                                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getNodePagesRSS

public static java.lang.String getNodePagesRSS(long nodeId,
                                               int max,
                                               java.lang.String type,
                                               double version,
                                               java.lang.String displayStyle,
                                               java.lang.String feedURL,
                                               java.lang.String entryURL,
                                               java.lang.String attachmentURLPrefix)
                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getOrphans

public static java.util.List<WikiPage> getOrphans(WikiNode node)
                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPage

public static WikiPage getPage(long pageId)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPage

public static WikiPage getPage(long groupId,
                               long nodeId,
                               java.lang.String title)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPage

public static WikiPage getPage(long nodeId,
                               java.lang.String title)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPage

public static WikiPage getPage(long nodeId,
                               java.lang.String title,
                               java.lang.Boolean head)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPage

public static WikiPage getPage(long nodeId,
                               java.lang.String title,
                               double version)
                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPages

public static java.util.List<WikiPage> getPages(long groupId,
                                                long nodeId,
                                                boolean head,
                                                int status,
                                                int start,
                                                int end,
                                                com.liferay.portal.kernel.util.OrderByComparator<WikiPage> orderByComparator)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPages

public static java.util.List<WikiPage> getPages(long groupId,
                                                long nodeId,
                                                boolean head,
                                                long userId,
                                                boolean includeOwner,
                                                int status,
                                                int start,
                                                int end,
                                                com.liferay.portal.kernel.util.OrderByComparator<WikiPage> orderByComparator)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPages

public static java.util.List<WikiPage> getPages(long groupId,
                                                long userId,
                                                long nodeId,
                                                int status,
                                                int start,
                                                int end)
                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPagesCount

public static int getPagesCount(long groupId,
                                long nodeId,
                                boolean head)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPagesCount

public static int getPagesCount(long groupId,
                                long nodeId,
                                boolean head,
                                long userId,
                                boolean includeOwner,
                                int status)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPagesCount

public static int getPagesCount(long groupId,
                                long userId,
                                long nodeId,
                                int status)
                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPagesRSS

public static java.lang.String getPagesRSS(long nodeId,
                                           java.lang.String title,
                                           int max,
                                           java.lang.String type,
                                           double version,
                                           java.lang.String displayStyle,
                                           java.lang.String feedURL,
                                           java.lang.String entryURL,
                                           java.lang.String attachmentURLPrefix,
                                           java.util.Locale locale)
                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getRecentChanges

public static java.util.List<WikiPage> getRecentChanges(long groupId,
                                                        long nodeId,
                                                        int start,
                                                        int end)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getRecentChangesCount

public static int getRecentChangesCount(long groupId,
                                        long nodeId)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getTempFileNames

public static java.lang.String[] getTempFileNames(long nodeId,
                                                  java.lang.String folderName)
                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

movePageAttachmentToTrash

public static com.liferay.portal.kernel.repository.model.FileEntry movePageAttachmentToTrash(long nodeId,
                                                                                             java.lang.String title,
                                                                                             java.lang.String fileName)
                                                                                      throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

movePageToTrash

public static WikiPage movePageToTrash(long nodeId,
                                       java.lang.String title)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

movePageToTrash

public static WikiPage movePageToTrash(long nodeId,
                                       java.lang.String title,
                                       double version)
                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

renamePage

public static void renamePage(long nodeId,
                              java.lang.String title,
                              java.lang.String newTitle,
                              com.liferay.portal.kernel.service.ServiceContext serviceContext)
                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

restorePageAttachmentFromTrash

public static void restorePageAttachmentFromTrash(long nodeId,
                                                  java.lang.String title,
                                                  java.lang.String fileName)
                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

restorePageFromTrash

public static void restorePageFromTrash(long resourcePrimKey)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

revertPage

public static WikiPage revertPage(long nodeId,
                                  java.lang.String title,
                                  double version,
                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

subscribePage

public static void subscribePage(long nodeId,
                                 java.lang.String title)
                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

unsubscribePage

public static void unsubscribePage(long nodeId,
                                   java.lang.String title)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updatePage

public static WikiPage updatePage(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,
                                  com.liferay.portal.kernel.service.ServiceContext serviceContext)
                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static WikiPageService getService()