public interface DocumentationItem extends Comparable<DocumentationItem>
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 |
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() |
compareTo
static final String TYPE_NAME
static final String PROP_TARGET
static final String PROP_TARGET_TYPE
static final String PROP_APPLICABLE_VERSIONS
static final String PROP_DOCUMENTATION_ID
static final String PROP_NUXEO_APPROVED
static final String PROP_TYPE
static final String PROP_RENDERING_TYPE
String getContent()
String getRenderingType()
String getTypeLabel()
List<String> getApplicableVersion()
String getTargetType()
boolean isApproved()
Map<String,String> getAttachments()
boolean isPlaceHolder()
String getEditId()
boolean isReadOnly()
Copyright © 2018 Nuxeo. All rights reserved.