com.jivesoftware.community
Interface Trackback

All Superinterfaces:

JiveContentObject, JiveObject, UserAuthoredObject

public interface Trackback
extends JiveContentObject

A container for jive trackback data.

TrackBacks, "...a framework for peer-to-peer communication and notifications between web sites", are defined here:

http://www.sixapart.com/pronet/docs/trackback_spec

In additon to the external trackback specification above, this class supports an internal trackback concept. An internal trackback is simply a trackback between JiveContentObjects.

Nested Class Summary

Nested classes/interfaces inherited from interface com.jivesoftware.community.JiveContentObject

JiveContentObject.Field, JiveContentObject.Status

Method Summary

Date	getCreationDate() Returns the date this trackback was created.
String	getExcerpt() Returns the excerpt of the trackback.
long	getID() Returns the id of this trackback, or -1 if this trackback hasn't been added to the database yet.
String	getIPAddress() Returns the IP address of the person that authored this comment.
JiveContentObject	getJiveContentObject() Returns the JiveContentObject this trackback belongs to.
Date	getModificationDate() Returns the date this trackback was last modified.
Map	getProperties() Retrieve a map of all the extended properties for the trackback.
String	getSenderName() Returns the sender name of the trackback.
JiveContentObject.Status	getStatus() Returns the visibility of the content object.
String	getTitle() Returns the title of the trackback.
String	getUnfilteredProperty(String name) Returns an extended property of the trackback, bypassing any filters.
String	getURL() Returns the URL of the trackback.
boolean	isModerated() Returns true if the trackbacks is moderated, false otherwise.
void	save() Saves the state of this trackback to the database
void	setCreationDate(Date creationDate) Sets the creation date of this trackback.
void	setExcerpt(String excerpt) Set the excerpt of the trackback.
void	setIPAddress(String ipaddress) Set the IP address of the person who authored this trackback.
void	setModerated(boolean moderated) Sets whether the trackbacks is moderated or not.
void	setModificationDate(Date modificationDate) Sets the date this trackback was last modified.
void	setSenderName(String senderName) Set the sender name of the trackback.
void	setStatus(JiveContentObject.Status status)
void	setTitle(String title) Set the title of the trackback.
void	setURL(String url) Set the URL of the trackback.

Methods inherited from interface com.jivesoftware.community.JiveContentObject

getBody, getContainerID, getContainerType, getJiveObjectType, getPlainBody, getPlainSubject, getSubject, getUnfilteredSubject

Methods inherited from interface com.jivesoftware.community.JiveObject

getObjectType

Methods inherited from interface com.jivesoftware.community.UserAuthoredObject

getAuthors, getUser

Method Detail

getID

long getID()

Returns the id of this trackback, or -1 if this trackback hasn't been added to the database yet.

Specified by:

getID in interface JiveObject

Returns:

the unique id of this trackback.

getJiveContentObject

JiveContentObject getJiveContentObject()

Returns the JiveContentObject this trackback belongs to.

Returns:

the JiveContentObject this trackback belongs to.

getTitle

String getTitle()

Returns the title of the trackback. The title field should only be used for an external trackback.

Returns:

the title of the trackback

setTitle

void setTitle(String title)
              throws UnauthorizedException

Set the title of the trackback. The title field should only be used for an external trackback.

Parameters:

title - the title of the trackback

Throws:

UnauthorizedException - if user is not allowed to edit the title

getExcerpt

String getExcerpt()

Returns the excerpt of the trackback. The excerpt field should only be used for an external trackback.

Returns:

the excerpt of the trackback

setExcerpt

void setExcerpt(String excerpt)
                throws UnauthorizedException

Set the excerpt of the trackback. The excerpt field should only be used for an external trackback.

Parameters:

excerpt - the excerpt of the trackback

Throws:

UnauthorizedException - if user is not allowed to edit the excerpt

getURL

String getURL()

Returns the URL of the trackback. The url field should only be used for an external trackback

Returns:

the url of the trackback

setURL

void setURL(String url)
            throws UnauthorizedException

Set the URL of the trackback. The url field should only be used for an external trackback

Parameters:

url - the url of the trackback

Throws:

UnauthorizedException - if user is not allowed to edit the url

getSenderName

String getSenderName()

Returns the sender name of the trackback. The sender name should only be used for an external trackback.

Returns:

the sender name of the trackback

setSenderName

void setSenderName(String senderName)
                   throws UnauthorizedException

Set the sender name of the trackback. The sender name should only be used for an external trackback.

Parameters:

senderName - the name of the sender

Throws:

UnauthorizedException - if user is not allowed to edit the sender name

getIPAddress

String getIPAddress()

Returns the IP address of the person that authored this comment.

Returns:

the IP address of the author of the comment

setIPAddress

void setIPAddress(String ipaddress)
                  throws UnauthorizedException

Set the IP address of the person who authored this trackback.

Parameters:

ipaddress - the IP address of the person who authored this trackback.

Throws:

UnauthorizedException - if user is not allowed to edit IP address

isModerated

boolean isModerated()

Returns true if the trackbacks is moderated, false otherwise. New trackbacks are not moderated by default.

If the trackbacks value is less than the blog's minimum, then the trackbacks will not be displayed by default.

Returns:

true if the trackbacks is moderated, false otherwise.

setModerated

void setModerated(boolean moderated)
                  throws UnauthorizedException

Sets whether the trackbacks is moderated or not. If the trackbacks is set to be moderated then a number of things will happen:

• The trackbacks will not be visible by default.
• Watch updates will not be triggered.

When calling this method results in a trackbacks become unmoderated, then the actions listed above will all be executed. Any change in moderation also results in the modified date of the trackbacks being updated.

Only administrators and moderators can call this method.

The authToken of the user must be passed into this method as a parameter for moderation auditing purposes.

Parameters:

moderated - true if the trackbacks is to be moderated, false otherwise.

Throws:

UnauthorizedException - if does not have Permissions.SYSTEM_ADMIN, BlogPermissions.BLOG_ADMIN or Permissions.MODERATOR permissions.

getCreationDate

Date getCreationDate()

Returns the date this trackback was created.

Specified by:

getCreationDate in interface JiveContentObject

Returns:

the date this trackback was created.

setCreationDate

void setCreationDate(Date creationDate)
                     throws UnauthorizedException

Sets the creation date of this trackback. In most cases, the creation date will default to when the trackback was entered into the system. However, the creation date needs to be set manually when importing trackbacks.

Parameters:

creationDate - the date this trackback was created.

Throws:

UnauthorizedException - if does not have ADMIN permissions.

getModificationDate

Date getModificationDate()

Returns the date this trackback was last modified. When a trackback is first created, the date returned by this method is identical to the creation date. The modified date is updated every time a trackback property is updated, such as the trackback body.

Specified by:

getModificationDate in interface JiveContentObject

Returns:

the date this trackback was last modified.

setModificationDate

void setModificationDate(Date modificationDate)
                         throws UnauthorizedException

Sets the date this trackback was last modified. In most cases, last modifed will default to when the trackback data was last changed. However, the last modified date needs to be set manually when importing trackbacks.

Parameters:

modificationDate - the date this trackback was modified.

Throws:

UnauthorizedException - if not allowed to edit the trackback.

getProperties

Map getProperties()

Retrieve a map of all the extended properties for the trackback. Each trackback can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface. The map is alterable if the user is authorized to modify the trackback, however only a mapping of key -> value is allowed. Null keys and values are not allowed.

Values returned from the map are filtered through the filter system. To retrieve unfiltered property values use the getUnfilteredProperty(String) method.

Returns:

a map of trackback extended properties.

getUnfilteredProperty

String getUnfilteredProperty(String name)

Returns an extended property of the trackback, bypassing any filters. Each trackback can have an arbitrary number of extended properties. This allows for enhanced functionality that is not part of the base interface.

Because properties are not filtered before being returned, this method should be used with caution. In particular, you should avoid showing unfiltered data in an environment where embedded HTML might be interpreted.

Parameters:

name - the name of the property to get.

Returns:

the value of the property.

save

void save()
          throws UnauthorizedException

Saves the state of this trackback to the database

Throws:

UnauthorizedException - If the user is not allowed to modify this trackback

getStatus

JiveContentObject.Status getStatus()

Description copied from interface: JiveContentObject

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.

Specified by:

getStatus in interface JiveContentObject

Returns:

visibility object containing the visibilty and name.

setStatus

void setStatus(JiveContentObject.Status status)