com.jivesoftware.community
Interface JiveContentObject

All Superinterfaces:

JiveObject

All Known Subinterfaces:

BlogPost, Comment, Document, ForumMessage, ForumThread, PrivateMessage

public interface JiveContentObject
extends JiveObject

A base container object that most content objects in Clearspace implement.

Field Summary

static java.lang.String	BODY_FIELD Constant used to indicate a body field.
static java.lang.String	SUBJECT_FIELD Constant used to indicate a subject field.

Method Summary

java.lang.String	getBody() Return a summary of the jive object content.
java.util.Date	getCreationDate() Gets the creation date of the jive object
java.util.Map<com.jivesoftware.community.search.IndexField,java.lang.String>	getIndexContent()
java.util.Date	getModificationDate() Gets the modification date of the jive object
java.lang.String	getPlainBody() Returns the body of the jive object content with no markup applied.
java.lang.String	getPlainSubject() Returns the title of the jive object content with no markup applied
java.lang.String	getSubject() Return the title of the jive object content
java.lang.String	getUnfilteredBody() Returns the body, bypassing any active filters.
java.lang.String	getUnfilteredSubject() Returns the subject, bypassing any active filters.
User	getUser() Returns the user who authored of the jive object.

Methods inherited from interface com.jivesoftware.community.JiveObject

getID, getObjectType

Field Detail

BODY_FIELD

static final java.lang.String BODY_FIELD

Constant used to indicate a body field.

See Also:

Constant Field Values

SUBJECT_FIELD

static final java.lang.String SUBJECT_FIELD

Constant used to indicate a subject field.

See Also:

Constant Field Values

Method Detail

getSubject

java.lang.String getSubject()

Return the title of the jive object content

Returns:

the title of the jive object content

getPlainSubject

java.lang.String getPlainSubject()

Returns the title of the jive object content with no markup applied

Returns:

the title of the jive object content with no markup applied

getBody

java.lang.String getBody()

Return a summary of the jive object content.

Returns:

a summary of the jive object content.

getPlainBody

java.lang.String getPlainBody()

Returns the body of the jive object content with no markup applied. In the case of a document with a binary body the text returned will be the document summary.

Returns:

the body of the jive object content with no markup applied

getUser

User getUser()

Returns the user who authored of the jive object.

Returns:

the author of the jive object.

getCreationDate

java.util.Date getCreationDate()

Gets the creation date of the jive object

Returns:

the date the jive object was created

getModificationDate

java.util.Date getModificationDate()

Gets the modification date of the jive object

Returns:

the date the jive object was last modified

getUnfilteredSubject

java.lang.String getUnfilteredSubject()

Returns the subject, bypassing any active filters. Because filters often provide security, this method should be used with caution. In particular, you should avoid showing unfiltered data in an environment where embedded HTML might be interpreted.

Unfiltered content is necessary for a few reasons. One is when saving Jive content to another persistence mechanism such as an XML format.

Returns:

the unfiltered subject of the object.

getUnfilteredBody

java.lang.String getUnfilteredBody()

Returns the body, bypassing any active filters. Because filters often provide security, this method should be used with caution. In particular, you should avoid showing unfiltered data in an environment where embedded HTML might be interpreted.

Unfiltered content is necessary for a few reasons. One is when saving Jive content to another persistence mechanism such as an XML format.

Returns:

the unfiltered body of this object.

getIndexContent

java.util.Map<com.jivesoftware.community.search.IndexField,java.lang.String> getIndexContent()