Liferay 7.0-ce-m3

com.liferay.portlet.wiki.service
Class WikiPageServiceUtil

java.lang.Object
  extended by com.liferay.portlet.wiki.service.WikiPageServiceUtil

@ProviderType
public class WikiPageServiceUtil
extends Object

Provides the remote service utility for WikiPage. This utility wraps com.liferay.portlet.wiki.service.impl.WikiPageServiceImpl and is the primary 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, com.liferay.portlet.wiki.service.base.WikiPageServiceBaseImpl, com.liferay.portlet.wiki.service.impl.WikiPageServiceImpl

Constructor Summary
WikiPageServiceUtil()
           
 
Method Summary
static WikiPage addPage(long nodeId, String title, String content, String summary, boolean minorEdit, ServiceContext serviceContext)
           
static WikiPage addPage(long nodeId, String title, String content, String summary, boolean minorEdit, String format, String parentTitle, String redirectTitle, ServiceContext serviceContext)
           
static void addPageAttachment(long nodeId, String title, String fileName, File file, String mimeType)
           
static void addPageAttachment(long nodeId, String title, String fileName, InputStream inputStream, String mimeType)
           
static void addPageAttachments(long nodeId, String title, List<ObjectValuePair<String,InputStream>> inputStreamOVPs)
           
static void addTempFileEntry(long nodeId, String folderName, String fileName, InputStream inputStream, String mimeType)
           
static void addTempPageAttachment(long nodeId, String fileName, String tempFolderName, InputStream inputStream, String mimeType)
          Deprecated. As of 7.0.0 replaced by addTempFileEntry(long, String, String, InputStream, String)
static void changeNode(long nodeId, String title, long newNodeId, ServiceContext serviceContext)
           
static void changeParent(long nodeId, String title, String newParentTitle, ServiceContext serviceContext)
           
static void copyPageAttachments(long templateNodeId, String templateTitle, long nodeId, String title)
           
static void deletePage(long nodeId, String title)
           
static void deletePage(long nodeId, String title, double version)
          Deprecated. As of 6.2.0 replaced by discardDraft(long, String, double)
static void deletePageAttachment(long nodeId, String title, String fileName)
           
static void deletePageAttachments(long nodeId, String title)
           
static void deleteTempFileEntry(long nodeId, String folderName, String fileName)
           
static void deleteTrashPageAttachments(long nodeId, String title)
           
static void discardDraft(long nodeId, String title, double version)
           
static WikiPage fetchPage(long nodeId, String title, double version)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static List<WikiPage> getChildren(long groupId, long nodeId, boolean head, String parentTitle)
           
static WikiPage getDraftPage(long nodeId, String title)
           
static List<WikiPage> getNodePages(long nodeId, int max)
           
static String getNodePagesRSS(long nodeId, int max, String type, double version, String displayStyle, String feedURL, String entryURL)
          Deprecated. As of 6.2.0, replaced by getNodePagesRSS(long, int, String, double, String, String, String, String)
static String getNodePagesRSS(long nodeId, int max, String type, double version, String displayStyle, String feedURL, String entryURL, String attachmentURLPrefix)
           
static List<WikiPage> getOrphans(long groupId, long nodeId)
           
static WikiPage getPage(long groupId, long nodeId, String title)
           
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 List<WikiPage> getPages(long groupId, long nodeId, boolean head, int status, int start, int end, OrderByComparator<WikiPage> obc)
           
static 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 userId, long nodeId, int status)
           
static String getPagesRSS(long companyId, long nodeId, String title, int max, String type, double version, String displayStyle, String feedURL, String entryURL, Locale locale)
          Deprecated. As of 6.2.0, replaced by getPagesRSS(long, long, String, int, String, double, String, String, String, String, java.util.Locale)
static String getPagesRSS(long companyId, long nodeId, String title, int max, String type, double version, String displayStyle, String feedURL, String entryURL, String attachmentURLPrefix, Locale locale)
           
static List<WikiPage> getRecentChanges(long groupId, long nodeId, int start, int end)
           
static int getRecentChangesCount(long groupId, long nodeId)
           
static WikiPageService getService()
           
static String[] getTempFileNames(long nodeId, String folderName)
           
static void movePage(long nodeId, String title, String newTitle, ServiceContext serviceContext)
          Deprecated. As of 6.2.0, replaced by renamePage(long, String, String, ServiceContext) *
static FileEntry movePageAttachmentToTrash(long nodeId, String title, String fileName)
           
static WikiPage movePageToTrash(long nodeId, String title)
           
static WikiPage movePageToTrash(long nodeId, String title, double version)
           
static void renamePage(long nodeId, String title, String newTitle, ServiceContext serviceContext)
           
static void restorePageAttachmentFromTrash(long nodeId, String title, String fileName)
           
static void restorePageFromTrash(long resourcePrimKey)
           
static WikiPage revertPage(long nodeId, String title, double version, ServiceContext serviceContext)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(WikiPageService service)
          Deprecated. As of 6.2.0
static void subscribePage(long nodeId, String title)
           
static void unsubscribePage(long nodeId, String title)
           
static WikiPage updatePage(long nodeId, String title, double version, String content, String summary, boolean minorEdit, String format, String parentTitle, String redirectTitle, 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,
                               String title,
                               String content,
                               String summary,
                               boolean minorEdit,
                               String format,
                               String parentTitle,
                               String redirectTitle,
                               ServiceContext serviceContext)
                        throws PortalException
Throws:
PortalException

addPage

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

addPageAttachment

public static void addPageAttachment(long nodeId,
                                     String title,
                                     String fileName,
                                     File file,
                                     String mimeType)
                              throws PortalException
Throws:
PortalException

addPageAttachment

public static void addPageAttachment(long nodeId,
                                     String title,
                                     String fileName,
                                     InputStream inputStream,
                                     String mimeType)
                              throws PortalException
Throws:
PortalException

addPageAttachments

public static void addPageAttachments(long nodeId,
                                      String title,
                                      List<ObjectValuePair<String,InputStream>> inputStreamOVPs)
                               throws PortalException
Throws:
PortalException

addTempFileEntry

public static void addTempFileEntry(long nodeId,
                                    String folderName,
                                    String fileName,
                                    InputStream inputStream,
                                    String mimeType)
                             throws PortalException
Throws:
PortalException

addTempPageAttachment

@Deprecated
public static void addTempPageAttachment(long nodeId,
                                                    String fileName,
                                                    String tempFolderName,
                                                    InputStream inputStream,
                                                    String mimeType)
                                  throws PortalException
Deprecated. As of 7.0.0 replaced by addTempFileEntry(long, String, String, InputStream, String)

Throws:
PortalException

changeNode

public static void changeNode(long nodeId,
                              String title,
                              long newNodeId,
                              ServiceContext serviceContext)
                       throws PortalException
Throws:
PortalException

changeParent

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

copyPageAttachments

public static void copyPageAttachments(long templateNodeId,
                                       String templateTitle,
                                       long nodeId,
                                       String title)
                                throws PortalException
Throws:
PortalException

deletePage

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

deletePage

@Deprecated
public static void deletePage(long nodeId,
                                         String title,
                                         double version)
                       throws PortalException
Deprecated. As of 6.2.0 replaced by discardDraft(long, String, double)

Throws:
PortalException

deletePageAttachment

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

deletePageAttachments

public static void deletePageAttachments(long nodeId,
                                         String title)
                                  throws PortalException
Throws:
PortalException

deleteTempFileEntry

public static void deleteTempFileEntry(long nodeId,
                                       String folderName,
                                       String fileName)
                                throws PortalException
Throws:
PortalException

deleteTrashPageAttachments

public static void deleteTrashPageAttachments(long nodeId,
                                              String title)
                                       throws PortalException
Throws:
PortalException

discardDraft

public static void discardDraft(long nodeId,
                                String title,
                                double version)
                         throws PortalException
Throws:
PortalException

fetchPage

public static WikiPage fetchPage(long nodeId,
                                 String title,
                                 double version)
                          throws PortalException
Throws:
PortalException

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

getChildren

public static List<WikiPage> getChildren(long groupId,
                                         long nodeId,
                                         boolean head,
                                         String parentTitle)
                                  throws PortalException
Throws:
PortalException

getDraftPage

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

getNodePages

public static List<WikiPage> getNodePages(long nodeId,
                                          int max)
                                   throws PortalException
Throws:
PortalException

getNodePagesRSS

@Deprecated
public static String getNodePagesRSS(long nodeId,
                                                int max,
                                                String type,
                                                double version,
                                                String displayStyle,
                                                String feedURL,
                                                String entryURL)
                              throws PortalException
Deprecated. As of 6.2.0, replaced by getNodePagesRSS(long, int, String, double, String, String, String, String)

Throws:
PortalException

getNodePagesRSS

public static String getNodePagesRSS(long nodeId,
                                     int max,
                                     String type,
                                     double version,
                                     String displayStyle,
                                     String feedURL,
                                     String entryURL,
                                     String attachmentURLPrefix)
                              throws PortalException
Throws:
PortalException

getOrphans

public static List<WikiPage> getOrphans(long groupId,
                                        long nodeId)
                                 throws PortalException
Throws:
PortalException

getPage

public static WikiPage getPage(long groupId,
                               long nodeId,
                               String title)
                        throws PortalException
Throws:
PortalException

getPage

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

getPage

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

getPage

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

getPages

public static List<WikiPage> getPages(long groupId,
                                      long nodeId,
                                      boolean head,
                                      int status,
                                      int start,
                                      int end,
                                      OrderByComparator<WikiPage> obc)
                               throws PortalException
Throws:
PortalException

getPages

public static List<WikiPage> getPages(long groupId,
                                      long userId,
                                      long nodeId,
                                      int status,
                                      int start,
                                      int end)
                               throws PortalException
Throws:
PortalException

getPagesCount

public static int getPagesCount(long groupId,
                                long nodeId,
                                boolean head)
                         throws PortalException
Throws:
PortalException

getPagesCount

public static int getPagesCount(long groupId,
                                long userId,
                                long nodeId,
                                int status)
                         throws PortalException
Throws:
PortalException

getPagesRSS

public static String getPagesRSS(long companyId,
                                 long nodeId,
                                 String title,
                                 int max,
                                 String type,
                                 double version,
                                 String displayStyle,
                                 String feedURL,
                                 String entryURL,
                                 String attachmentURLPrefix,
                                 Locale locale)
                          throws PortalException
Throws:
PortalException

getPagesRSS

@Deprecated
public static String getPagesRSS(long companyId,
                                            long nodeId,
                                            String title,
                                            int max,
                                            String type,
                                            double version,
                                            String displayStyle,
                                            String feedURL,
                                            String entryURL,
                                            Locale locale)
                          throws PortalException
Deprecated. As of 6.2.0, replaced by getPagesRSS(long, long, String, int, String, double, String, String, String, String, java.util.Locale)

Throws:
PortalException

getRecentChanges

public static List<WikiPage> getRecentChanges(long groupId,
                                              long nodeId,
                                              int start,
                                              int end)
                                       throws PortalException
Throws:
PortalException

getRecentChangesCount

public static int getRecentChangesCount(long groupId,
                                        long nodeId)
                                 throws PortalException
Throws:
PortalException

getTempFileNames

public static String[] getTempFileNames(long nodeId,
                                        String folderName)
                                 throws PortalException
Throws:
PortalException

movePage

@Deprecated
public static void movePage(long nodeId,
                                       String title,
                                       String newTitle,
                                       ServiceContext serviceContext)
                     throws PortalException
Deprecated. As of 6.2.0, replaced by renamePage(long, String, String, ServiceContext) *

Throws:
PortalException

movePageAttachmentToTrash

public static FileEntry movePageAttachmentToTrash(long nodeId,
                                                  String title,
                                                  String fileName)
                                           throws PortalException
Throws:
PortalException

movePageToTrash

public static WikiPage movePageToTrash(long nodeId,
                                       String title)
                                throws PortalException
Throws:
PortalException

movePageToTrash

public static WikiPage movePageToTrash(long nodeId,
                                       String title,
                                       double version)
                                throws PortalException
Throws:
PortalException

renamePage

public static void renamePage(long nodeId,
                              String title,
                              String newTitle,
                              ServiceContext serviceContext)
                       throws PortalException
Throws:
PortalException

restorePageAttachmentFromTrash

public static void restorePageAttachmentFromTrash(long nodeId,
                                                  String title,
                                                  String fileName)
                                           throws PortalException
Throws:
PortalException

restorePageFromTrash

public static void restorePageFromTrash(long resourcePrimKey)
                                 throws PortalException
Throws:
PortalException

revertPage

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

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

subscribePage

public static void subscribePage(long nodeId,
                                 String title)
                          throws PortalException
Throws:
PortalException

unsubscribePage

public static void unsubscribePage(long nodeId,
                                   String title)
                            throws PortalException
Throws:
PortalException

updatePage

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

getService

public static WikiPageService getService()

setService

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


Liferay 7.0-ce-m3