Package com.polarion.alm.wiki

Interface IWikiService

public interface IWikiService

Since:

3.4.1

Version:

$Revision$ $Date$

Author:

Jiri Banszel

Method Summary

Modifier and Type	Method	Description
IWikiPage	getPage(String name, String spaceId, String projectId, String revision)
Collection<IWikiPage>	getPages(String projectId, String spaceId)
Collection<IWikiSpace>	getSpaces(String projectId)	Deprecated. use IFolderManager instead to get all spaces and their info.
IWikiPolicy	getWikiPolicy()
Map<String,Object>	getWikiRenderingContextMap()	Returns context map with values available to Wiki page during rendering.
Collection<IWikiPage>	searchPages(String searchString, String sort, String projectId, String spaceId)	Returns Wiki Pages from given project, searchString and optional spaceId

Method Details

getWikiPolicy

IWikiPolicy getWikiPolicy()

getSpaces

@Deprecated
@NotNull
Collection<IWikiSpace> getSpaces(@Nullable
 String projectId)

Deprecated.

use IFolderManager instead to get all spaces and their info.

getPages

Collection<IWikiPage> getPages(String projectId,
 String spaceId)

getPage

IWikiPage getPage(String name,
 String spaceId,
 String projectId,
 String revision)

searchPages

Collection<IWikiPage> searchPages(String searchString,
 String sort,
 String projectId,
 String spaceId)

Returns Wiki Pages from given project, searchString and optional spaceId

Parameters:

searchString - - not null

sort - - the format is same as for IIndexSearch.sort(String)

projectId - limit result to Wiki Pages from particular project - can be null - null = result is not limited by project

spaceId - limit result to Wiki Pages from particular spaceId - can be null - null = result is not limited by space

Returns:

sorted list of IWikiPage, never return the null

Since:

3.5.0

getWikiRenderingContextMap

Map<String,Object> getWikiRenderingContextMap()

Returns context map with values available to Wiki page during rendering.

Returns:

unmodifiable map with context mapping (not null)