org.nuxeo.apidoc.documentation

Class DocumentationComponent

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.apidoc.documentation.DocumentationComponent

All Implemented Interfaces:

DocumentationService, Adaptable, Component, Extensible, TimestampedService

public class DocumentationComponent
extends DefaultComponent
implements DocumentationService

Field Summary

Fields

Modifier and Type	Field and Description
static String	DIRECTORY_NAME
static String	Read_Grp
static String	Root_NAME
static String	Root_PATH
static String	Write_Grp

Constructor Summary

Constructors

Constructor and Description
DocumentationComponent()

Method Summary

Methods

Modifier and Type	Method and Description
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)
List<DocumentModel>	findDocumentModelVariants(CoreSession session, DocumentationItem item)
<T> T	getAdapter(Class<T> adapter) Returns an object which is an instance of the given class associated with this object.
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)

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getApplicationStartedOrder, getLastModified, registerContribution, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DIRECTORY_NAME

public static final String DIRECTORY_NAME

See Also:

Constant Field Values

Root_PATH

public static final String Root_PATH

See Also:

Constant Field Values

Root_NAME

public static final String Root_NAME

See Also:

Constant Field Values

Read_Grp

public static final String Read_Grp

See Also:

Constant Field Values

Write_Grp

public static final String Write_Grp

See Also:

Constant Field Values

Constructor Detail

DocumentationComponent

public DocumentationComponent()

Method Detail

getAdapter

public <T> T getAdapter(Class<T> adapter)

Description copied from interface: Adaptable

Returns an object which is an instance of the given class associated with this object. Returns null if no such object can be found.

Specified by:

getAdapter in interface Adaptable

Overrides:

getAdapter in class DefaultComponent

Parameters:

adapter - the adapter class to look up

Returns:

a object castable to the given class, or null if this object does not have an adapter for the given class

listDocumentationItems

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

Specified by:

listDocumentationItems in interface DocumentationService

Throws:

Exception

findDocumentItems

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

Specified by:

findDocumentItems in interface DocumentationService

Throws:

ClientException

findDocumentationItemVariants

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

Specified by:

findDocumentationItemVariants in interface DocumentationService

Throws:

ClientException

findDocumentModelVariants

public List<DocumentModel> findDocumentModelVariants(CoreSession session,
                                            DocumentationItem item)
                                              throws ClientException

Throws:

ClientException

createDocumentationItem

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

Specified by:

createDocumentationItem in interface DocumentationService

Throws:

ClientException

deleteDocumentationItem

public void deleteDocumentationItem(CoreSession session,
                           String uuid)
                             throws ClientException

Specified by:

deleteDocumentationItem in interface DocumentationService

Throws:

ClientException

updateDocumentationItem

public DocumentationItem updateDocumentationItem(CoreSession session,
                                        DocumentationItem docItem)
                                          throws ClientException

Specified by:

updateDocumentationItem in interface DocumentationService

Throws:

ClientException

getCategoryKeys

public List<String> getCategoryKeys()
                             throws Exception

Specified by:

getCategoryKeys in interface DocumentationService

Throws:

Exception

getCategories

public Map<String,String> getCategories()
                                 throws Exception

Specified by:

getCategories in interface DocumentationService

Throws:

Exception

exportDocumentation

public void exportDocumentation(CoreSession session,
                       OutputStream out)

Specified by:

exportDocumentation in interface DocumentationService

importDocumentation

public void importDocumentation(CoreSession session,
                       InputStream is)

Specified by:

importDocumentation in interface DocumentationService

getDocumentationStats

public String getDocumentationStats(CoreSession session)

Specified by:

getDocumentationStats in interface DocumentationService

getAvailableDescriptions

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

Specified by:

getAvailableDescriptions in interface DocumentationService

Throws:

Exception