com.liferay.portlet.wiki.service
Interface WikiPageLocalService

All Known Implementing Classes:

WikiPageLocalServiceBaseImpl, WikiPageLocalServiceImpl, WikiPageLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface WikiPageLocalService

The interface for the wiki page local service.

Never modify or reference this interface directly. Always use WikiPageLocalServiceUtil to access the wiki page local service. Add custom service methods to WikiPageLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

WikiPageLocalServiceUtil, WikiPageLocalServiceBaseImpl, WikiPageLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary

WikiPage	addPage(long userId, long nodeId, String title, double version, String content, String summary, boolean minorEdit, String format, boolean head, String parentTitle, String redirectTitle, ServiceContext serviceContext)
WikiPage	addPage(long userId, long nodeId, String title, String content, String summary, boolean minorEdit, ServiceContext serviceContext)
void	addPageAttachment(long companyId, String dirName, Date modifiedDate, String fileName, InputStream inputStream)
void	addPageAttachments(long nodeId, String title, List<ObjectValuePair<String,byte[]>> files)
void	addPageResources(long nodeId, String title, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addPageResources(long nodeId, String title, String[] communityPermissions, String[] guestPermissions)
void	addPageResources(WikiPage page, boolean addCommunityPermissions, boolean addGuestPermissions)
void	addPageResources(WikiPage page, String[] communityPermissions, String[] guestPermissions)
WikiPage	addWikiPage(WikiPage wikiPage) Adds the wiki page to the database.
void	changeParent(long userId, long nodeId, String title, String newParentTitle, ServiceContext serviceContext)
WikiPage	createWikiPage(long pageId) Creates a new wiki page with the primary key.
void	deletePage(long nodeId, String title)
void	deletePage(long nodeId, String title, double version)
void	deletePage(WikiPage page)
void	deletePageAttachment(long nodeId, String title, String fileName)
void	deletePages(long nodeId)
void	deleteWikiPage(long pageId) Deletes the wiki page with the primary key from the database.
void	deleteWikiPage(WikiPage wikiPage) Deletes the wiki page from the database.
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
List<WikiPage>	getChildren(long nodeId, boolean head, String parentTitle)
WikiPage	getDraftPage(long nodeId, String title)
List<WikiPage>	getIncomingLinks(long nodeId, String title)
List<WikiPage>	getNoAssetPages()
List<WikiPage>	getOrphans(long nodeId)
List<WikiPage>	getOutgoingLinks(long nodeId, String title)
WikiPage	getPage(long resourcePrimKey)
WikiPage	getPage(long resourcePrimKey, Boolean head)
WikiPage	getPage(long nodeId, String title)
WikiPage	getPage(long nodeId, String title, Boolean head)
WikiPage	getPage(long nodeId, String title, double version)
WikiPageDisplay	getPageDisplay(long nodeId, String title, PortletURL viewPageURL, PortletURL editPageURL, String attachmentURLPrefix)
WikiPageDisplay	getPageDisplay(WikiPage page, PortletURL viewPageURL, PortletURL editPageURL, String attachmentURLPrefix)
List<WikiPage>	getPages(long nodeId, boolean head, int start, int end)
List<WikiPage>	getPages(long nodeId, boolean head, int start, int end, OrderByComparator obc)
List<WikiPage>	getPages(long nodeId, int start, int end)
List<WikiPage>	getPages(long nodeId, int start, int end, OrderByComparator obc)
List<WikiPage>	getPages(long resourcePrimKey, long nodeId, int status)
List<WikiPage>	getPages(long userId, long nodeId, int status, int start, int end)
List<WikiPage>	getPages(long nodeId, String title, boolean head, int start, int end)
List<WikiPage>	getPages(long nodeId, String title, int start, int end)
List<WikiPage>	getPages(long nodeId, String title, int start, int end, OrderByComparator obc)
List<WikiPage>	getPages(String format)
int	getPagesCount(long nodeId)
int	getPagesCount(long nodeId, boolean head)
int	getPagesCount(long userId, long nodeId, int status)
int	getPagesCount(long nodeId, String title)
int	getPagesCount(long nodeId, String title, boolean head)
int	getPagesCount(String format)
List<WikiPage>	getRecentChanges(long nodeId, int start, int end)
int	getRecentChangesCount(long nodeId)
WikiPage	getWikiPage(long pageId) Gets the wiki page with the primary key.
WikiPage	getWikiPageByUuidAndGroupId(String uuid, long groupId) Gets the wiki page with the UUID and group id.
List<WikiPage>	getWikiPages(int start, int end) Gets a range of all the wiki pages.
int	getWikiPagesCount() Gets the number of wiki pages.
boolean	hasDraftPage(long nodeId, String title)
void	movePage(long userId, long nodeId, String title, String newTitle, boolean strict, ServiceContext serviceContext)
void	movePage(long userId, long nodeId, String title, String newTitle, ServiceContext serviceContext)
WikiPage	revertPage(long userId, long nodeId, String title, double version, ServiceContext serviceContext)
void	subscribePage(long userId, long nodeId, String title)
void	unsubscribePage(long userId, long nodeId, String title)
void	updateAsset(long userId, WikiPage page, long[] assetCategoryIds, String[] assetTagNames)
WikiPage	updatePage(long userId, long nodeId, String title, double version, String content, String summary, boolean minorEdit, String format, String parentTitle, String redirectTitle, ServiceContext serviceContext)
WikiPage	updateStatus(long userId, long resourcePrimKey, int status, ServiceContext serviceContext)
WikiPage	updateStatus(long userId, WikiPage page, int status, ServiceContext serviceContext)
WikiPage	updateWikiPage(WikiPage wikiPage) Updates the wiki page in the database.
WikiPage	updateWikiPage(WikiPage wikiPage, boolean merge) Updates the wiki page in the database.
void	validateTitle(String title)

Method Detail

addWikiPage

WikiPage addWikiPage(WikiPage wikiPage)
                     throws SystemException

Adds the wiki page to the database. Also notifies the appropriate model listeners.

Parameters:

wikiPage - the wiki page to add

Returns:

the wiki page that was added

Throws:

SystemException - if a system exception occurred

createWikiPage

WikiPage createWikiPage(long pageId)

Creates a new wiki page with the primary key. Does not add the wiki page to the database.

Parameters:

pageId - the primary key for the new wiki page

Returns:

the new wiki page

deleteWikiPage

void deleteWikiPage(long pageId)
                    throws PortalException,
                           SystemException

Deletes the wiki page with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

pageId - the primary key of the wiki page to delete

Throws:

PortalException - if a wiki page with the primary key could not be found

SystemException - if a system exception occurred

deleteWikiPage

void deleteWikiPage(WikiPage wikiPage)
                    throws SystemException

Deletes the wiki page from the database. Also notifies the appropriate model listeners.

Parameters:

wikiPage - the wiki page to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end)
                  throws SystemException

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery,
                  int start,
                  int end,
                  OrderByComparator orderByComparator)
                  throws SystemException

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

dynamicQuery - the dynamic query to search with

start - the lower bound of the range of model instances to return

end - the upper bound of the range of model instances to return (not inclusive)

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getWikiPage

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

Gets the wiki page with the primary key.

Parameters:

pageId - the primary key of the wiki page to get

Returns:

the wiki page

Throws:

PortalException - if a wiki page with the primary key could not be found

SystemException - if a system exception occurred

getWikiPageByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPage getWikiPageByUuidAndGroupId(String uuid,
                                                                              long groupId)
                                     throws PortalException,
                                            SystemException

Gets the wiki page with the UUID and group id.

Parameters:

uuid - the UUID of wiki page to get

groupId - the group id of the wiki page to get

Returns:

the wiki page

Throws:

PortalException - if a wiki page with the UUID and group id could not be found

SystemException - if a system exception occurred

getWikiPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getWikiPages(int start,
                                                                     int end)
                            throws SystemException

Gets a range of all the wiki pages.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:

start - the lower bound of the range of wiki pages to return

end - the upper bound of the range of wiki pages to return (not inclusive)

Returns:

the range of wiki pages

Throws:

SystemException - if a system exception occurred

getWikiPagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getWikiPagesCount()
                      throws SystemException

Gets the number of wiki pages.

Returns:

the number of wiki pages

Throws:

SystemException - if a system exception occurred

updateWikiPage

WikiPage updateWikiPage(WikiPage wikiPage)
                        throws SystemException

Updates the wiki page in the database. Also notifies the appropriate model listeners.

Parameters:

wikiPage - the wiki page to update

Returns:

the wiki page that was updated

Throws:

SystemException - if a system exception occurred

updateWikiPage

WikiPage updateWikiPage(WikiPage wikiPage,
                        boolean merge)
                        throws SystemException

Updates the wiki page in the database. Also notifies the appropriate model listeners.

Parameters:

wikiPage - the wiki page to update

merge - whether to merge the wiki page with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the wiki page that was updated

Throws:

SystemException - if a system exception occurred

addPage

WikiPage addPage(long userId,
                 long nodeId,
                 String title,
                 double version,
                 String content,
                 String summary,
                 boolean minorEdit,
                 String format,
                 boolean head,
                 String parentTitle,
                 String redirectTitle,
                 ServiceContext serviceContext)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

addPage

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

Throws:

PortalException

SystemException

addPageAttachment

void addPageAttachment(long companyId,
                       String dirName,
                       Date modifiedDate,
                       String fileName,
                       InputStream inputStream)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

addPageAttachments

void addPageAttachments(long nodeId,
                        String title,
                        List<ObjectValuePair<String,byte[]>> files)
                        throws PortalException,
                               SystemException

Throws:

PortalException

SystemException

addPageResources

void addPageResources(long nodeId,
                      String title,
                      boolean addCommunityPermissions,
                      boolean addGuestPermissions)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

addPageResources

void addPageResources(long nodeId,
                      String title,
                      String[] communityPermissions,
                      String[] guestPermissions)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

addPageResources

void addPageResources(WikiPage page,
                      boolean addCommunityPermissions,
                      boolean addGuestPermissions)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

addPageResources

void addPageResources(WikiPage page,
                      String[] communityPermissions,
                      String[] guestPermissions)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

changeParent

void changeParent(long userId,
                  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

deletePage

void deletePage(WikiPage page)
                throws PortalException,
                       SystemException

Throws:

PortalException

SystemException

deletePageAttachment

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

Throws:

PortalException

SystemException

deletePages

void deletePages(long nodeId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

getChildren

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

Throws:

SystemException

getDraftPage

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

Throws:

PortalException

SystemException

getIncomingLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getIncomingLinks(long nodeId,
                                                                         String title)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getNoAssetPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getNoAssetPages()
                               throws SystemException

Throws:

SystemException

getOrphans

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

Throws:

PortalException

SystemException

getOutgoingLinks

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getOutgoingLinks(long nodeId,
                                                                         String title)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

getPage

WikiPage getPage(long resourcePrimKey)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

getPage

WikiPage getPage(long resourcePrimKey,
                 Boolean head)
                 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

getPageDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageDisplay getPageDisplay(long nodeId,
                                                                        String title,
                                                                        PortletURL viewPageURL,
                                                                        PortletURL editPageURL,
                                                                        String attachmentURLPrefix)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getPageDisplay

@Transactional(propagation=SUPPORTS,
               readOnly=true)
WikiPageDisplay getPageDisplay(WikiPage page,
                                                                        PortletURL viewPageURL,
                                                                        PortletURL editPageURL,
                                                                        String attachmentURLPrefix)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(long nodeId,
                                                                 boolean head,
                                                                 int start,
                                                                 int end)
                        throws SystemException

Throws:

SystemException

getPages

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

Throws:

SystemException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(long nodeId,
                                                                 int start,
                                                                 int end)
                        throws SystemException

Throws:

SystemException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(long nodeId,
                                                                 int start,
                                                                 int end,
                                                                 OrderByComparator obc)
                        throws SystemException

Throws:

SystemException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(long resourcePrimKey,
                                                                 long nodeId,
                                                                 int status)
                        throws SystemException

Throws:

SystemException

getPages

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

Throws:

SystemException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(long nodeId,
                                                                 String title,
                                                                 boolean head,
                                                                 int start,
                                                                 int end)
                        throws SystemException

Throws:

SystemException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(long nodeId,
                                                                 String title,
                                                                 int start,
                                                                 int end)
                        throws SystemException

Throws:

SystemException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(long nodeId,
                                                                 String title,
                                                                 int start,
                                                                 int end,
                                                                 OrderByComparator obc)
                        throws SystemException

Throws:

SystemException

getPages

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<WikiPage> getPages(String format)
                        throws SystemException

Throws:

SystemException

getPagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPagesCount(long nodeId)
                  throws SystemException

Throws:

SystemException

getPagesCount

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

Throws:

SystemException

getPagesCount

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

Throws:

SystemException

getPagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPagesCount(long nodeId,
                                                           String title)
                  throws SystemException

Throws:

SystemException

getPagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPagesCount(long nodeId,
                                                           String title,
                                                           boolean head)
                  throws SystemException

Throws:

SystemException

getPagesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPagesCount(String format)
                  throws SystemException

Throws:

SystemException

getRecentChanges

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

Throws:

SystemException

getRecentChangesCount

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

Throws:

SystemException

hasDraftPage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasDraftPage(long nodeId,
                                                              String title)
                     throws SystemException

Throws:

SystemException

movePage

void movePage(long userId,
              long nodeId,
              String title,
              String newTitle,
              boolean strict,
              ServiceContext serviceContext)
              throws PortalException,
                     SystemException

Throws:

PortalException

SystemException

movePage

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

Throws:

PortalException

SystemException

revertPage

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

Throws:

PortalException

SystemException

subscribePage

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

Throws:

PortalException

SystemException

unsubscribePage

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

Throws:

PortalException

SystemException

updateAsset

void updateAsset(long userId,
                 WikiPage page,
                 long[] assetCategoryIds,
                 String[] assetTagNames)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

updatePage

WikiPage updatePage(long userId,
                    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

updateStatus

WikiPage updateStatus(long userId,
                      long resourcePrimKey,
                      int status,
                      ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

updateStatus

WikiPage updateStatus(long userId,
                      WikiPage page,
                      int status,
                      ServiceContext serviceContext)
                      throws PortalException,
                             SystemException

Throws:

PortalException

SystemException

validateTitle

void validateTitle(String title)
                   throws PortalException

Throws:

PortalException