com.liferay.wiki.service

Interface WikiPageService

All Superinterfaces:

BaseService

All Known Implementing Classes:

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

Method Summary

Modifier and Type	Method and Description
WikiPage	addPage(long nodeId, java.lang.String title, java.lang.String content, java.lang.String summary, boolean minorEdit, ServiceContext serviceContext)
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, ServiceContext serviceContext)
FileEntry	addPageAttachment(long nodeId, java.lang.String title, java.lang.String fileName, java.io.File file, java.lang.String mimeType)
FileEntry	addPageAttachment(long nodeId, java.lang.String title, java.lang.String fileName, java.io.InputStream inputStream, java.lang.String mimeType)
java.util.List<FileEntry>	addPageAttachments(long nodeId, java.lang.String title, java.util.List<ObjectValuePair<java.lang.String,java.io.InputStream>> inputStreamOVPs)
FileEntry	addTempFileEntry(long nodeId, java.lang.String folderName, java.lang.String fileName, java.io.InputStream inputStream, java.lang.String mimeType)
void	changeParent(long nodeId, java.lang.String title, java.lang.String newParentTitle, ServiceContext serviceContext)
void	copyPageAttachments(long templateNodeId, java.lang.String templateTitle, long nodeId, java.lang.String title)
void	deletePage(long nodeId, java.lang.String title)
void	deletePageAttachment(long nodeId, java.lang.String title, java.lang.String fileName)
void	deletePageAttachments(long nodeId, java.lang.String title)
void	deleteTempFileEntry(long nodeId, java.lang.String folderName, java.lang.String fileName)
void	deleteTrashPageAttachments(long nodeId, java.lang.String title)
void	discardDraft(long nodeId, java.lang.String title, double version)
WikiPage	fetchPage(long nodeId, java.lang.String title, double version)
java.util.List<WikiPage>	getChildren(long groupId, long nodeId, boolean head, java.lang.String parentTitle)
WikiPage	getDraftPage(long nodeId, java.lang.String title)
java.util.List<WikiPage>	getNodePages(long nodeId, int max)
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)
java.util.List<WikiPage>	getOrphans(WikiNode node)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
WikiPage	getPage(long pageId)
WikiPage	getPage(long groupId, long nodeId, java.lang.String title)
WikiPage	getPage(long nodeId, java.lang.String title)
WikiPage	getPage(long nodeId, java.lang.String title, java.lang.Boolean head)
WikiPage	getPage(long nodeId, java.lang.String title, double version)
java.util.List<WikiPage>	getPages(long groupId, long nodeId, boolean head, int status, int start, int end, OrderByComparator<WikiPage> orderByComparator)
java.util.List<WikiPage>	getPages(long groupId, long nodeId, boolean head, long userId, boolean includeOwner, int status, int start, int end, OrderByComparator<WikiPage> orderByComparator)
java.util.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 nodeId, boolean head, long userId, boolean includeOwner, int status)
int	getPagesCount(long groupId, long userId, long nodeId, int status)
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)
java.util.List<WikiPage>	getRecentChanges(long groupId, long nodeId, int start, int end)
int	getRecentChangesCount(long groupId, long nodeId)
java.lang.String[]	getTempFileNames(long nodeId, java.lang.String folderName)
FileEntry	movePageAttachmentToTrash(long nodeId, java.lang.String title, java.lang.String fileName)
WikiPage	movePageToTrash(long nodeId, java.lang.String title)
WikiPage	movePageToTrash(long nodeId, java.lang.String title, double version)
void	renamePage(long nodeId, java.lang.String title, java.lang.String newTitle, ServiceContext serviceContext)
void	restorePageAttachmentFromTrash(long nodeId, java.lang.String title, java.lang.String fileName)
void	restorePageFromTrash(long resourcePrimKey)
WikiPage	revertPage(long nodeId, java.lang.String title, double version, ServiceContext serviceContext)
void	subscribePage(long nodeId, java.lang.String title)
void	unsubscribePage(long nodeId, java.lang.String title)
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, ServiceContext serviceContext)

Method Detail

addPage

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

Throws:

PortalException

addPage

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,
                 ServiceContext serviceContext)
          throws PortalException

Throws:

PortalException

addPageAttachment

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

Throws:

PortalException

addPageAttachment

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

Throws:

PortalException

addPageAttachments

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

Throws:

PortalException

addTempFileEntry

FileEntry addTempFileEntry(long nodeId,
                           java.lang.String folderName,
                           java.lang.String fileName,
                           java.io.InputStream inputStream,
                           java.lang.String mimeType)
                    throws PortalException

Throws:

PortalException

changeParent

void changeParent(long nodeId,
                  java.lang.String title,
                  java.lang.String newParentTitle,
                  ServiceContext serviceContext)
           throws PortalException

Throws:

PortalException

copyPageAttachments

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

Throws:

PortalException

deletePage

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

Throws:

PortalException

deletePageAttachment

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

Throws:

PortalException

deletePageAttachments

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

Throws:

PortalException

deleteTempFileEntry

void deleteTempFileEntry(long nodeId,
                         java.lang.String folderName,
                         java.lang.String fileName)
                  throws PortalException

Throws:

PortalException

deleteTrashPageAttachments

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

Throws:

PortalException

discardDraft

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

Throws:

PortalException

fetchPage

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

Throws:

PortalException

getChildren

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

Throws:

PortalException

getDraftPage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPage getDraftPage(long nodeId,
                                                                                         java.lang.String title)
                                                                                  throws PortalException

Throws:

PortalException

getNodePages

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

Throws:

PortalException

getNodePagesRSS

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

Throws:

PortalException

getOrphans

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiPage> getOrphans(WikiNode node)
                                                                                                throws PortalException

Throws:

PortalException

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPage getPage(long pageId)
                                                                             throws PortalException

Throws:

PortalException

getPage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPage getPage(long groupId,
                                                                                    long nodeId,
                                                                                    java.lang.String title)
                                                                             throws PortalException

Throws:

PortalException

getPage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPage getPage(long nodeId,
                                                                                    java.lang.String title)
                                                                             throws PortalException

Throws:

PortalException

getPage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPage getPage(long nodeId,
                                                                                    java.lang.String title,
                                                                                    java.lang.Boolean head)
                                                                             throws PortalException

Throws:

PortalException

getPage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPage getPage(long nodeId,
                                                                                    java.lang.String title,
                                                                                    double version)
                                                                             throws PortalException

Throws:

PortalException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiPage> getPages(long groupId,
                                                                                                     long nodeId,
                                                                                                     boolean head,
                                                                                                     int status,
                                                                                                     int start,
                                                                                                     int end,
                                                                                                     OrderByComparator<WikiPage> orderByComparator)
                                                                                              throws PortalException

Throws:

PortalException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<WikiPage> getPages(long groupId,
                                                                                                     long nodeId,
                                                                                                     boolean head,
                                                                                                     long userId,
                                                                                                     boolean includeOwner,
                                                                                                     int status,
                                                                                                     int start,
                                                                                                     int end,
                                                                                                     OrderByComparator<WikiPage> orderByComparator)
                                                                                              throws PortalException

Throws:

PortalException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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 nodeId,
                                                                                     boolean head,
                                                                                     long userId,
                                                                                     boolean includeOwner,
                                                                                     int status)
                                                                              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)
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 PortalException

Throws:

PortalException

getRecentChanges

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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)
java.lang.String[] getTempFileNames(long nodeId,
                                                                                                       java.lang.String folderName)
                                                                                                throws PortalException

Throws:

PortalException

movePageAttachmentToTrash

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

Throws:

PortalException

movePageToTrash

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

Throws:

PortalException

movePageToTrash

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

Throws:

PortalException

renamePage

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

Throws:

PortalException

restorePageAttachmentFromTrash

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

Throws:

PortalException

restorePageFromTrash

void restorePageFromTrash(long resourcePrimKey)
                   throws PortalException

Throws:

PortalException

revertPage

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

Throws:

PortalException

subscribePage

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

Throws:

PortalException

unsubscribePage

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

Throws:

PortalException

updatePage

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,
                    ServiceContext serviceContext)
             throws PortalException

Throws:

PortalException