|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Content
This represents some content in Confluence, this can be for example a wiki page, a comment on a page, a blog post, a discussion forum, etc...
Content have an associated ContentType
which allow customizing behavior, rendering, possible actions,
etc...
Method Summary | |
---|---|
Content |
getContainer()
Get the container for this content. |
ContentType |
getContentType()
Get the type of the content. |
java.util.List |
getLabels()
Get the Label s the content has been associated with. |
Content |
getParent()
Get the parent content of this content. |
Space |
getSpace()
Get the space that the content belongs to |
java.lang.String |
getStatus()
Get the status of the content, this can be used to allow/deny access/viewing of contents. |
java.lang.String |
getText()
Get the text data of this content. |
java.lang.String |
getTitle()
Get the title of this content. |
java.lang.String |
getType()
Get the name of the ContentType of this content. |
void |
setParent(Content parent)
Sets the parent of this content. |
void |
setSpace(Space space)
Set the space this content belongs to |
void |
setStatus(java.lang.String status)
Set ths status of this content. |
void |
setText(java.lang.String text)
Sets the text data of this content. |
void |
setTitle(java.lang.String title)
Sets the title of this content. |
Method Detail |
---|
java.util.List getLabels()
Label
s the content has been associated with.
Label
s associated to this content.Space getSpace()
Space
the space which the content belongs to.void setSpace(Space space)
space
- the new spaceContent getParent()
Get the parent content of this
content. If the content doesn't have any parent then
null
will be returned.
Examples of parent/child relationship can be a page and a comment, where the comment has the page as a parent, but if you reply to a comment then its 'direct' parent will be the comment it is replying to.
Content
of this
content. null
if this content doesn't have
a parent.void setParent(Content parent)
null
to indicate this content has no parent.
parent
- the new parent of this contentgetParent()
java.lang.String getStatus()
Get the status of the content, this can be used to allow/deny access/viewing of contents.
For example a page could be 'deleted' and therefore not be visible (except from the trash), a blogpost could have a status 'pending' and not be visible except by the author.
String
representation of the content's status.void setStatus(java.lang.String status)
status
- the new statusContent getContainer()
Get the container for this
content.
The container represents the closest parent that is of a different ContentType
. For example,
a comment, no matter how deeply threaded, has its page as a container.
Content
that 'contains' this
content. null
if this content has
no container.java.lang.String getTitle()
String
representation ot the content's title.void setTitle(java.lang.String title)
title
- the title of this contentjava.lang.String getType()
ContentType
of this
content.
ContentType
, this should return the same value as
getContentType().getName
ContentType getContentType()
Get the type of the content.
The ContentType
allow implementation of the strategy pattern. One can retrieve some (if not all) of
a specific content behavior through the ContentType
.
ContentType
of this content.java.lang.String getText()
Get the text data of this
content.
This should never return null
setText(String)
void setText(java.lang.String text)
Sets the text data of this
content.
text
- the text to set this content togetText()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |