com.jivesoftware.community
Interface JiveContentObject

All Superinterfaces:

com.jivesoftware.community.ContainerAware, JiveObject

All Known Subinterfaces:

Announcement, BlogPost, Comment, Document, ForumMessage, ForumThread, Poll, PrivateMessage, Trackback, VersionableContentObject

public interface JiveContentObject
extends JiveObject, com.jivesoftware.community.ContainerAware

A base object that most content objects in Clearspace implement.

Nested Class Summary

static class	JiveContentObject.Field
static class	JiveContentObject.Status

Method Summary

Document	getBody() Return a summary of the jive object content.
long	getContainerID() Returns the system ID of the parent object.
int	getContainerType() Returns the type of the parent object.
Date	getCreationDate() Gets the creation date of the jive object
Map<com.jivesoftware.community.search.IndexField,String>	getIndexContent() Returns a collection of fields that can be used to index this content object.
Date	getModificationDate() Gets the modification date of the jive object
String	getPlainBody() Returns the body of the jive object content with no markup applied.
String	getPlainSubject() Returns the title of the jive object content with no markup applied
JiveContentObject.Status	getStatus() Returns the visibility of the content object.
String	getSubject() Return the title of the jive object content
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

Method Detail

getSubject

String getSubject()

Return the title of the jive object content

Returns:

the title of the jive object content

getPlainSubject

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

Document getBody()

Return a summary of the jive object content.

Returns:

a summary of the jive object content.

getPlainBody

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

Date getCreationDate()

Gets the creation date of the jive object

Returns:

the date the jive object was created

getModificationDate

Date getModificationDate()

Gets the modification date of the jive object

Returns:

the date the jive object was last modified

getUnfilteredSubject

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.

getIndexContent

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

Returns a collection of fields that can be used to index this content object. Used by the search/indexing services.

Returns:

map a map of IndexField and associated index-able text.

getStatus

JiveContentObject.Status getStatus()

Returns the visibility of the content object. Objects that are in a non published state (Draft,Awaiting moderation etc..) will have visiblity that will return false when visibility.isVisible() is called.

Returns:

visibility object containing the visibilty and name.

getContainerID

long getContainerID()

Returns the system ID of the parent object.

Specified by:

getContainerID in interface com.jivesoftware.community.ContainerAware

Returns:

The id of the parent container.

Since:

2.1

getContainerType

int getContainerType()

Returns the type of the parent object.

Specified by:

getContainerType in interface com.jivesoftware.community.ContainerAware

Returns:

The content type of the parent container.

Since:

2.1