org.nuxeo.apidoc.doc

Class SimpleDocumentationItem

java.lang.Object

org.nuxeo.apidoc.api.AbstractDocumentationItem

org.nuxeo.apidoc.doc.SimpleDocumentationItem

All Implemented Interfaces:

Comparable<DocumentationItem>, DocumentationItem

public class SimpleDocumentationItem
extends AbstractDocumentationItem
implements DocumentationItem

Field Summary

Fields

Modifier and Type	Field and Description
protected List<String>	applicableVersion
protected boolean	approved
protected Map<String,String>	attachments
protected String	content
protected String	id
protected String	renderingType
protected String	target
protected String	targetType
protected String	title
protected String	type
protected String	uuid

Fields inherited from class org.nuxeo.apidoc.api.AbstractDocumentationItem

log

Fields inherited from interface org.nuxeo.apidoc.api.DocumentationItem

PROP_APPLICABLE_VERSIONS, PROP_DOCUMENTATION_ID, PROP_NUXEO_APPROVED, PROP_RENDERING_TYPE, PROP_TARGET, PROP_TARGET_TYPE, PROP_TYPE, TYPE_NAME

Constructor Summary

Constructors

Constructor and Description
SimpleDocumentationItem()
SimpleDocumentationItem(NuxeoArtifact nxItem)

Method Summary

Modifier and Type	Method and Description
List<String>	getApplicableVersion()
Map<String,String>	getAttachments()
String	getContent()
String	getEditId()
String	getId()
String	getRenderingType()
String	getTarget()
String	getTargetType()
String	getTitle()
String	getType()
String	getTypeLabel()
String	getUUID()
boolean	isApproved()
boolean	isPlaceHolder()
boolean	isReadOnly()

Methods inherited from class org.nuxeo.apidoc.api.AbstractDocumentationItem

compareTo

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

applicableVersion

protected final List<String> applicableVersion

content

protected String content

id

protected String id

renderingType

protected String renderingType

target

protected String target

targetType

protected String targetType

title

protected String title

type

protected String type

uuid

protected String uuid

approved

protected boolean approved

attachments

protected Map<String,String> attachments

Constructor Detail

SimpleDocumentationItem

public SimpleDocumentationItem()

SimpleDocumentationItem

public SimpleDocumentationItem(NuxeoArtifact nxItem)

Method Detail

getApplicableVersion

public List<String> getApplicableVersion()

Specified by:

getApplicableVersion in interface DocumentationItem

getContent

public String getContent()

Specified by:

getContent in interface DocumentationItem

getId

public String getId()

Specified by:

getId in interface DocumentationItem

getRenderingType

public String getRenderingType()

Specified by:

getRenderingType in interface DocumentationItem

getTarget

public String getTarget()

Specified by:

getTarget in interface DocumentationItem

getTargetType

public String getTargetType()

Specified by:

getTargetType in interface DocumentationItem

getTitle

public String getTitle()

Specified by:

getTitle in interface DocumentationItem

getType

public String getType()

Specified by:

getType in interface DocumentationItem

getTypeLabel

public String getTypeLabel()

Specified by:

getTypeLabel in interface DocumentationItem

Overrides:

getTypeLabel in class AbstractDocumentationItem

getUUID

public String getUUID()

Specified by:

getUUID in interface DocumentationItem

isApproved

public boolean isApproved()

Specified by:

isApproved in interface DocumentationItem

getAttachments

public Map<String,String> getAttachments()

Specified by:

getAttachments in interface DocumentationItem

isPlaceHolder

public boolean isPlaceHolder()

Specified by:

isPlaceHolder in interface DocumentationItem

getEditId

public String getEditId()

Specified by:

getEditId in interface DocumentationItem

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface DocumentationItem