Liferay 7.0-ce-m3

com.liferay.portlet.wiki.service
Interface WikiPageService

All Superinterfaces:
BaseService
All Known Implementing Classes:
WikiPageServiceBaseImpl, WikiPageServiceImpl, WikiPageServiceWrapper

@AccessControlled
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface WikiPageService
extends BaseService

Provides the remote service interface for WikiPage. 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:
WikiPageServiceUtil, WikiPageServiceBaseImpl, WikiPageServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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

Method Detail

addPage

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

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

addPageAttachment

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

addPageAttachment

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

addPageAttachments

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

addTempFileEntry

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

addTempPageAttachment

@Deprecated
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

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

changeParent

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

copyPageAttachments

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

deletePage

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

deletePage

@Deprecated
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

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

deletePageAttachments

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

deleteTempFileEntry

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

deleteTrashPageAttachments

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

discardDraft

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

fetchPage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPage fetchPage(long nodeId,
                                                            String title,
                                                            double version)
                   throws PortalException
Throws:
PortalException

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

getChildren

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getChildren(long groupId,
                                                                    long nodeId,
                                                                    boolean head,
                                                                    String parentTitle)
                           throws PortalException
Throws:
PortalException

getDraftPage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPage getDraftPage(long nodeId,
                                                               String title)
                      throws PortalException
Throws:
PortalException

getNodePages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getNodePages(long nodeId,
                                                                     int max)
                            throws PortalException
Throws:
PortalException

getNodePagesRSS

@Deprecated
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String getNodePagesRSS(long nodeId,
                                                                int max,
                                                                String type,
                                                                double version,
                                                                String displayStyle,
                                                                String feedURL,
                                                                String entryURL,
                                                                String attachmentURLPrefix)
                       throws PortalException
Throws:
PortalException

getOrphans

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getOrphans(long groupId,
                                                                   long nodeId)
                          throws PortalException
Throws:
PortalException

getPage

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

getPage

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

getPage

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

getPage

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

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(long groupId,
                                                                 long nodeId,
                                                                 boolean head,
                                                                 int status,
                                                                 int start,
                                                                 int end,
                                                                 OrderByComparator<WikiPage> obc)
                        throws PortalException
Throws:
PortalException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(long groupId,
                                                                 long userId,
                                                                 long nodeId,
                                                                 int status,
                                                                 int start,
                                                                 int end)
                        throws PortalException
Throws:
PortalException

getPagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPagesCount(long groupId,
                                                           long nodeId,
                                                           boolean head)
                  throws PortalException
Throws:
PortalException

getPagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPagesCount(long groupId,
                                                           long userId,
                                                           long nodeId,
                                                           int status)
                  throws PortalException
Throws:
PortalException

getPagesRSS

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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
@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getRecentChanges(long groupId,
                                                                         long nodeId,
                                                                         int start,
                                                                         int end)
                                throws PortalException
Throws:
PortalException

getRecentChangesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getRecentChangesCount(long groupId,
                                                                   long nodeId)
                          throws PortalException
Throws:
PortalException

getTempFileNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String[] getTempFileNames(long nodeId,
                                                                   String folderName)
                          throws PortalException
Throws:
PortalException

movePage

@Deprecated
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

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

movePageToTrash

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

movePageToTrash

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

renamePage

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

restorePageAttachmentFromTrash

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

restorePageFromTrash

void restorePageFromTrash(long resourcePrimKey)
                          throws PortalException
Throws:
PortalException

revertPage

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

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

subscribePage

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

unsubscribePage

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

updatePage

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

Liferay 7.0-ce-m3