org.nuxeo.apidoc.api

Interface DocumentationItem

All Superinterfaces:

Comparable<DocumentationItem>

All Known Implementing Classes:

AbstractDocumentationItem, DocumentationItemDocAdapter, ResourceDocumentationItem, SimpleDocumentationItem

public interface DocumentationItem
extends Comparable<DocumentationItem>

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROP_APPLICABLE_VERSIONS
static String	PROP_DOCUMENTATION_ID
static String	PROP_NUXEO_APPROVED
static String	PROP_RENDERING_TYPE
static String	PROP_TARGET
static String	PROP_TARGET_TYPE
static String	PROP_TYPE
static String	TYPE_NAME

Method Summary

Methods

Modifier and Type	Method and Description
List<String>	getApplicableVersion() Gets versions.
Map<String,String>	getAttachments() Returns attachments.
String	getContent() Gets the main content of the Documentation
String	getEditId() Return the id used by quick editor (can contains a real UUID for existing doc or an artifact id for new one).
String	getId() Local documentation identifier.
String	getRenderingType() Gets the output rendering format for the content (wiki, html ...)
String	getTarget() Gets identifier of the target documented artifact
String	getTargetType() Gets the Type of the target documented artifact (NXBundle, NXComponent ...).
String	getTitle() Gets Title of the Documentation
String	getType() Gets the type of the documentation (description, how-to, samples ...)
String	getTypeLabel() Gets label for the documentation type
String	getUUID() UUID of the underlying DocumentModel.
boolean	isApproved() Indicates if documentation has been validated by Nuxeo.
boolean	isPlaceHolder() Return true if item is a placeholder automatically generated.
boolean	isReadOnly()

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

TYPE_NAME

static final String TYPE_NAME

See Also:

Constant Field Values

PROP_TARGET

static final String PROP_TARGET

See Also:

Constant Field Values

PROP_TARGET_TYPE

static final String PROP_TARGET_TYPE

See Also:

Constant Field Values

PROP_APPLICABLE_VERSIONS

static final String PROP_APPLICABLE_VERSIONS

See Also:

Constant Field Values

PROP_DOCUMENTATION_ID

static final String PROP_DOCUMENTATION_ID

See Also:

Constant Field Values

PROP_NUXEO_APPROVED

static final String PROP_NUXEO_APPROVED

See Also:

Constant Field Values

PROP_TYPE

static final String PROP_TYPE

See Also:

Constant Field Values

PROP_RENDERING_TYPE

static final String PROP_RENDERING_TYPE

See Also:

Constant Field Values

Method Detail

getTitle

String getTitle()

Gets Title of the Documentation

getContent

String getContent()

Gets the main content of the Documentation

getType

String getType()

Gets the type of the documentation (description, how-to, samples ...)

getRenderingType

String getRenderingType()

Gets the output rendering format for the content (wiki, html ...)

getTypeLabel

String getTypeLabel()

Gets label for the documentation type

getApplicableVersion

List<String> getApplicableVersion()

Gets versions.

getTarget

String getTarget()

Gets identifier of the target documented artifact

getTargetType

String getTargetType()

Gets the Type of the target documented artifact (NXBundle, NXComponent ...).

isApproved

boolean isApproved()

Indicates if documentation has been validated by Nuxeo.

getId

String getId()

Local documentation identifier.

getUUID

String getUUID()

UUID of the underlying DocumentModel.

getAttachments

Map<String,String> getAttachments()

Returns attachments.

isPlaceHolder

boolean isPlaceHolder()

Return true if item is a placeholder automatically generated.

getEditId

String getEditId()

Return the id used by quick editor (can contains a real UUID for existing doc or an artifact id for new one).

isReadOnly

boolean isReadOnly()