Liferay 6.1.2-ce-ga3

com.liferay.portlet.wiki.service
Interface WikiPageService

All Superinterfaces:
BaseService
All Known Implementing Classes:
WikiPageServiceWrapper

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

The interface for the wiki page remote service.

This is a remote service. 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, com.liferay.portlet.wiki.service.base.WikiPageServiceBaseImpl, com.liferay.portlet.wiki.service.impl.WikiPageServiceImpl

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)
           
 void addPageAttachment(long nodeId, String title, String fileName, InputStream inputStream)
           
 void addPageAttachments(long nodeId, String title, List<ObjectValuePair<String,InputStream>> inputStream)
           
 String addTempPageAttachment(long nodeId, String fileName, String tempFolderName, InputStream inputStream)
           
 void changeParent(long nodeId, String title, String newParentTitle, ServiceContext serviceContext)
           
 void deletePage(long nodeId, String title)
           
 void deletePage(long nodeId, String title, double version)
           
 void deletePageAttachment(long nodeId, String title, String fileName)
           
 void deleteTempPageAttachment(long nodeId, String fileName, String tempFolderName)
           
 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)
           
 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 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)
           
 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[] getTempPageAttachmentNames(long nodeId, String tempFolderName)
           
 void movePage(long nodeId, String title, String newTitle, ServiceContext serviceContext)
           
 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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addPage

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

addPage

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

addPageAttachment

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

addPageAttachment

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

addPageAttachments

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

addTempPageAttachment

String addTempPageAttachment(long nodeId,
                             String fileName,
                             String tempFolderName,
                             InputStream inputStream)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

changeParent

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

deletePage

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

deletePage

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

deletePageAttachment

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

deleteTempPageAttachment

void deleteTempPageAttachment(long nodeId,
                              String fileName,
                              String tempFolderName)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

getChildren

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

getDraftPage

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

getNodePages

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

getNodePagesRSS

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

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,
                              SystemException
Throws:
PortalException
SystemException

getOrphans

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

getPage

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

getPage

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

getPage

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

getPage

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

getPages

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

getPages

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

getPagesCount

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

getPagesCount

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

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,
                                                            Locale locale)
                   throws PortalException,
                          SystemException
Throws:
PortalException
SystemException

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,
                          SystemException
Throws:
PortalException
SystemException

getRecentChanges

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

getRecentChangesCount

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

getTempPageAttachmentNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
String[] getTempPageAttachmentNames(long nodeId,
                                                                             String tempFolderName)
                                    throws PortalException,
                                           SystemException
Throws:
PortalException
SystemException

movePage

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

revertPage

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

subscribePage

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

unsubscribePage

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

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,
                           SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3