org.alfresco.service.cmr.wiki
Interface WikiService

All Known Implementing Classes:
WikiServiceImpl

public interface WikiService

The Wiki service.

Since:
4.0

Method Summary
 WikiPageInfo createWikiPage(java.lang.String siteShortName, java.lang.String title, java.lang.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(java.lang.String siteShortName, java.lang.String pageName)
          Retrieves an existing WikiPageInfo from the repository
 org.alfresco.query.PagingResults listWikiPages(java.lang.String siteShortName, org.alfresco.query.PagingRequest paging)
          Retrieves all WikiPageInfo instances in the repository for the given site.
 org.alfresco.query.PagingResults listWikiPages(java.lang.String siteShortName, java.lang.String user, org.alfresco.query.PagingRequest paging)
          Retrieves all WikiPageInfo instances in the repository for the given site and the specified user.
 org.alfresco.query.PagingResults listWikiPagesByCreated(java.lang.String siteShortName, java.util.Date from, java.util.Date to, org.alfresco.query.PagingRequest paging)
          Retrieves all WikiPageInfo instances in the repository for the given site, created in the specified date range
 org.alfresco.query.PagingResults listWikiPagesByModified(java.lang.String siteShortName, java.util.Date from, java.util.Date to, org.alfresco.query.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(java.lang.String siteShortName,
                                         java.lang.String title,
                                         java.lang.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(java.lang.String siteShortName,
                                      java.lang.String pageName)
Retrieves an existing WikiPageInfo from the repository


listWikiPages

@NotAuditable
org.alfresco.query.PagingResults listWikiPages(java.lang.String siteShortName,
                                                            org.alfresco.query.PagingRequest paging)
Retrieves all WikiPageInfo instances in the repository for the given site.


listWikiPages

@NotAuditable
org.alfresco.query.PagingResults listWikiPages(java.lang.String siteShortName,
                                                            java.lang.String user,
                                                            org.alfresco.query.PagingRequest paging)
Retrieves all WikiPageInfo instances in the repository for the given site and the specified user.


listWikiPagesByCreated

@NotAuditable
org.alfresco.query.PagingResults listWikiPagesByCreated(java.lang.String siteShortName,
                                                                     java.util.Date from,
                                                                     java.util.Date to,
                                                                     org.alfresco.query.PagingRequest paging)
Retrieves all WikiPageInfo instances in the repository for the given site, created in the specified date range


listWikiPagesByModified

@NotAuditable
org.alfresco.query.PagingResults listWikiPagesByModified(java.lang.String siteShortName,
                                                                      java.util.Date from,
                                                                      java.util.Date to,
                                                                      org.alfresco.query.PagingRequest paging)
Retrieves all WikiPageInfo instances in the repository for the given site, modified in the specified date range



Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.