org.nuxeo.apidoc.documentation
Interface DocumentationService

All Known Implementing Classes:

DocumentationComponent

public interface DocumentationService

Method Summary

DocumentationItem	createDocumentationItem(CoreSession session, NuxeoArtifact item, String title, String content, String type, List<String> applicableVersions, boolean approved, String renderingType)
void	deleteDocumentationItem(CoreSession session, String uuid)
void	exportDocumentation(CoreSession session, OutputStream out)
List<DocumentationItem>	findDocumentationItemVariants(CoreSession session, DocumentationItem item)
List<DocumentationItem>	findDocumentItems(CoreSession session, NuxeoArtifact nxItem)
Map<String,DocumentationItem>	getAvailableDescriptions(CoreSession session, String targetType)
Map<String,String>	getCategories()
List<String>	getCategoryKeys()
String	getDocumentationStats(CoreSession session)
void	importDocumentation(CoreSession session, InputStream is)
Map<String,List<DocumentationItem>>	listDocumentationItems(CoreSession session, String category, String targetType)
DocumentationItem	updateDocumentationItem(CoreSession session, DocumentationItem docItem)

Method Detail

createDocumentationItem

DocumentationItem createDocumentationItem(CoreSession session,
                                          NuxeoArtifact item,
                                          String title,
                                          String content,
                                          String type,
                                          List<String> applicableVersions,
                                          boolean approved,
                                          String renderingType)
                                          throws ClientException

Throws:

ClientException

updateDocumentationItem

DocumentationItem updateDocumentationItem(CoreSession session,
                                          DocumentationItem docItem)
                                          throws ClientException

Throws:

ClientException

deleteDocumentationItem

void deleteDocumentationItem(CoreSession session,
                             String uuid)
                             throws ClientException

Throws:

ClientException

findDocumentItems

List<DocumentationItem> findDocumentItems(CoreSession session,
                                          NuxeoArtifact nxItem)
                                          throws ClientException

Throws:

ClientException

findDocumentationItemVariants

List<DocumentationItem> findDocumentationItemVariants(CoreSession session,
                                                      DocumentationItem item)
                                                      throws ClientException

Throws:

ClientException

getCategories

Map<String,String> getCategories()
                                 throws Exception

Throws:

Exception

getCategoryKeys

List<String> getCategoryKeys()
                             throws Exception

Throws:

Exception

exportDocumentation

void exportDocumentation(CoreSession session,
                         OutputStream out)

importDocumentation

void importDocumentation(CoreSession session,
                         InputStream is)

getDocumentationStats

String getDocumentationStats(CoreSession session)

listDocumentationItems

Map<String,List<DocumentationItem>> listDocumentationItems(CoreSession session,
                                                           String category,
                                                           String targetType)
                                                           throws Exception

Throws:

Exception

getAvailableDescriptions

Map<String,DocumentationItem> getAvailableDescriptions(CoreSession session,
                                                       String targetType)
                                                       throws Exception

Throws:

Exception