Jive API (5.0.0.0) Core Javadocs

com.jivesoftware.community
Interface JiveContentObject

All Superinterfaces:
com.jivesoftware.community.ContainerAware, com.jivesoftware.community.DatedObject, JiveObject, com.jivesoftware.community.objecttype.SubjectAware, UserAuthoredObject
All Known Subinterfaces:
Announcement, BlogPost, Comment, Document, ForumMessage, ForumThread, Poll, PollOption, PrivateMessage, VersionableContentObject

public interface JiveContentObject
extends JiveObject, UserAuthoredObject, com.jivesoftware.community.ContainerAware, com.jivesoftware.community.DatedObject, com.jivesoftware.community.objecttype.SubjectAware

A base object that most content objects in Jive SBS 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
 com.jivesoftware.community.objecttype.JiveObjectType getJiveObjectType()
          Gets the object type object linking this object to the various subsystems.
 Date getModificationDate()
          Gets the modification date of the jive object
 String getPlainBody()
          Returns the body of the jive object content with no markup applied.
 JiveContentObject.Status getStatus()
          Returns the visibility of the content object.
 String getUnfilteredSubject()
          Returns the subject, bypassing any active filters.
 
Methods inherited from interface com.jivesoftware.community.UserAuthoredObject
getAuthorIDs, getAuthors, getUser, getUserID
 
Methods inherited from interface com.jivesoftware.community.objecttype.SubjectAware
getPlainSubject, getSubject
 
Methods inherited from interface com.jivesoftware.community.JiveObject
getID, getObjectType
 

Method Detail

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. Note: If you want wiki content, use WikiContentHelper#contentBodyToWikiText

Returns:
the body of the jive object content with no markup applied

getCreationDate

Date getCreationDate()
Gets the creation date of the jive object

Specified by:
getCreationDate in interface com.jivesoftware.community.DatedObject
Returns:
the date the jive object was created

getModificationDate

Date getModificationDate()
Gets the modification date of the jive object

Specified by:
getModificationDate in interface com.jivesoftware.community.DatedObject
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.

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

getJiveObjectType

com.jivesoftware.community.objecttype.JiveObjectType getJiveObjectType()
Gets the object type object linking this object to the various subsystems.

Returns:
the JiveObjectType for the object.

Jive Product Page

Copyright © 1999-2007 Jive Software.