public class ResourceDocumentationItem extends AbstractDocumentationItem implements DocumentationItem
Modifier and Type | Field and Description |
---|---|
protected List<String> |
applicableVersion |
protected String |
content |
protected String |
filename |
protected String |
target |
protected String |
targetType |
protected String |
type |
log
PROP_APPLICABLE_VERSIONS, PROP_DOCUMENTATION_ID, PROP_NUXEO_APPROVED, PROP_RENDERING_TYPE, PROP_TARGET, PROP_TARGET_TYPE, PROP_TYPE, TYPE_NAME
Constructor and Description |
---|
ResourceDocumentationItem(ResourceDocumentationItem other,
NuxeoArtifact target) |
ResourceDocumentationItem(String filename,
String content,
String type,
NuxeoArtifact target) |
ResourceDocumentationItem(String filename,
String content,
String type,
String target,
String targetType,
List<String> applicableVersion,
String typeLabel) |
Modifier and Type | Method and Description |
---|---|
List<String> |
getApplicableVersion()
Gets versions.
|
Map<String,String> |
getAttachments()
Returns attachments.
|
protected String |
getCleanName() |
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 |
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, getTypeLabel, typeLabelOf
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getTypeLabel
compareTo
protected final String targetType
protected final List<String> applicableVersion
public ResourceDocumentationItem(String filename, String content, String type, String target, String targetType, List<String> applicableVersion, String typeLabel)
public ResourceDocumentationItem(String filename, String content, String type, NuxeoArtifact target)
public ResourceDocumentationItem(ResourceDocumentationItem other, NuxeoArtifact target)
public String getTitle()
DocumentationItem
getTitle
in interface DocumentationItem
protected String getCleanName()
public String getContent()
DocumentationItem
getContent
in interface DocumentationItem
public String getType()
DocumentationItem
getType
in interface DocumentationItem
public String getRenderingType()
DocumentationItem
getRenderingType
in interface DocumentationItem
public List<String> getApplicableVersion()
DocumentationItem
getApplicableVersion
in interface DocumentationItem
public String getTarget()
DocumentationItem
getTarget
in interface DocumentationItem
public String getTargetType()
DocumentationItem
getTargetType
in interface DocumentationItem
public boolean isApproved()
DocumentationItem
isApproved
in interface DocumentationItem
public String getId()
DocumentationItem
getId
in interface DocumentationItem
public String getUUID()
DocumentationItem
getUUID
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
public boolean isReadOnly()
isReadOnly
in interface DocumentationItem
Copyright © 2017 Nuxeo. All rights reserved.