Package org.alfresco.service.cmr.wiki

Interface WikiService

All Known Implementing Classes:

WikiServiceImpl

public interface WikiService

The Wiki service.

Since:

4.0

Author:

Nick Burch

Method Summary

Modifier and Type	Method	Description
WikiPageInfo	createWikiPage(String siteShortName, String title, String contents)	Creates a new WikiPageInfo in the given site, with the specified contents
void	deleteWikiPage(WikiPageInfo wikiPage)	Deletes an existing WikiPageInfo from the repository
WikiPageInfo	getWikiPage(String siteShortName, String pageName)	Retrieves an existing WikiPageInfo from the repository
PagingResults<WikiPageInfo>	listWikiPages(String siteShortName, String user, PagingRequest paging)	Retrieves all WikiPageInfo instances in the repository for the given site and the specified user.
PagingResults<WikiPageInfo>	listWikiPages(String siteShortName, PagingRequest paging)	Retrieves all WikiPageInfo instances in the repository for the given site.
PagingResults<WikiPageInfo>	listWikiPagesByCreated(String siteShortName, Date from, Date to, PagingRequest paging)	Retrieves all WikiPageInfo instances in the repository for the given site, created in the specified date range
PagingResults<WikiPageInfo>	listWikiPagesByModified(String siteShortName, Date from, Date to, PagingRequest paging)	Retrieves all WikiPageInfo instances in the repository for the given site, modified in the specified date range
WikiPageInfo	updateWikiPage(WikiPageInfo wikiPage)	Updates an existing WikiPageInfo in the repository.

Method Detail

createWikiPage

@NotAuditable
WikiPageInfo createWikiPage(String siteShortName,
                            String title,
                            String contents)

Creates a new WikiPageInfo in the given site, with the specified contents

Returns:

The newly created WikiPageInfo

updateWikiPage

@NotAuditable
WikiPageInfo updateWikiPage(WikiPageInfo wikiPage)

Updates an existing WikiPageInfo in the repository.

Returns:

The updated WikiPageInfo

deleteWikiPage

@NotAuditable
void deleteWikiPage(WikiPageInfo wikiPage)

Deletes an existing WikiPageInfo from the repository

getWikiPage

@NotAuditable
WikiPageInfo getWikiPage(String siteShortName,
                         String pageName)

Retrieves an existing WikiPageInfo from the repository

listWikiPages

@NotAuditable
PagingResults<WikiPageInfo> listWikiPages(String siteShortName,
                                          PagingRequest paging)

Retrieves all WikiPageInfo instances in the repository for the given site.

listWikiPages

@NotAuditable
PagingResults<WikiPageInfo> listWikiPages(String siteShortName,
                                          String user,
                                          PagingRequest paging)

Retrieves all WikiPageInfo instances in the repository for the given site and the specified user.

listWikiPagesByCreated

@NotAuditable
PagingResults<WikiPageInfo> listWikiPagesByCreated(String siteShortName,
                                                   Date from,
                                                   Date to,
                                                   PagingRequest paging)

Retrieves all WikiPageInfo instances in the repository for the given site, created in the specified date range

listWikiPagesByModified

@NotAuditable
PagingResults<WikiPageInfo> listWikiPagesByModified(String siteShortName,
                                                    Date from,
                                                    Date to,
                                                    PagingRequest paging)

Retrieves all WikiPageInfo instances in the repository for the given site, modified in the specified date range