public class SimpleDocumentationItem extends AbstractDocumentationItem implements DocumentationItem
PROP_APPLICABLE_VERSIONS, PROP_DOCUMENTATION_ID, PROP_NUXEO_APPROVED, PROP_RENDERING_TYPE, PROP_TARGET, PROP_TARGET_TYPE, PROP_TYPE, TYPE_NAME
Constructor and Description |
---|
SimpleDocumentationItem() |
SimpleDocumentationItem(NuxeoArtifact nxItem) |
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.
|
compareTo
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
compareTo
public SimpleDocumentationItem()
public SimpleDocumentationItem(NuxeoArtifact nxItem)
public List<String> getApplicableVersion()
DocumentationItem
getApplicableVersion
in interface DocumentationItem
public String getContent()
DocumentationItem
getContent
in interface DocumentationItem
public String getId()
DocumentationItem
getId
in interface DocumentationItem
public String getRenderingType()
DocumentationItem
getRenderingType
in interface DocumentationItem
public String getTarget()
DocumentationItem
getTarget
in interface DocumentationItem
public String getTargetType()
DocumentationItem
getTargetType
in interface DocumentationItem
public String getTitle()
DocumentationItem
getTitle
in interface DocumentationItem
public String getType()
DocumentationItem
getType
in interface DocumentationItem
public String getTypeLabel()
DocumentationItem
getTypeLabel
in interface DocumentationItem
public String getUUID()
DocumentationItem
getUUID
in interface DocumentationItem
public boolean isApproved()
DocumentationItem
isApproved
in interface DocumentationItem
public Map<String,String> getAttachments()
DocumentationItem
getAttachments
in interface DocumentationItem
public boolean isPlaceHolder()
DocumentationItem
isPlaceHolder
in interface DocumentationItem
public String getEditId()
DocumentationItem
getEditId
in interface DocumentationItem
Copyright © 2011 Nuxeo SA. All Rights Reserved.