com.jivesoftware.community
Interface TrackbackManager

public interface TrackbackManager

Manages the trackback feature within Clearspace

Method Summary

void	addTrackback(Trackback trackback) Adds a new trackback to this object When a trackback is being added, it is first run through all trackback interceptors that are installed.
Trackback	createTrackback() Factory method to create a trackback .
void	deleteAllTrackbacks() Deletes all trackbacks on the object.
void	deleteTrackback(Trackback trackback) Deletes a trackback on this object.
long	getObjectID() Returns the id of the object managed by this instance.
int	getObjectType() Returns the type (one of the values in JiveConstants) of the object managed by this instance.
Trackback	getTrackback(long trackbackID) Returns the Trackback with the supplied id.
int	getTrackbackCount() Returns the number of incoming trackbacks on this object.
int	getTrackbackCount(FeedbackResultFilter resultFilter) Returns the number of incoming trackbacks on this object that match the criteria specified by the ResultFilter.
JiveIterator<Trackback>	getTrackbacks() Return an Iterable for all the incoming trackbacks on this object.
JiveIterator<Trackback>	getTrackbacks(FeedbackResultFilter resultFilter) Returns a Iterable for all the incoming trackbacks on this object that match the criteria specified by the ResultFilter.

Method Detail

getObjectID

long getObjectID()

Returns the id of the object managed by this instance.

Returns:

the id of the object managed by this instance.

getObjectType

int getObjectType()

Returns the type (one of the values in JiveConstants) of the object managed by this instance.

Returns:

the type (one of the values in JiveConstants) of the object managed by this instance.

getTrackbackCount

int getTrackbackCount()

Returns the number of incoming trackbacks on this object.

Returns:

the number of incoming trackbacks on this object.

getTrackbackCount

int getTrackbackCount(FeedbackResultFilter resultFilter)

Returns the number of incoming trackbacks on this object that match the criteria specified by the ResultFilter.

Parameters:

resultFilter - a ResultFilter object to perform filtering and sorting with.

Returns:

the number of incoming trackbacks on this object.

createTrackback

Trackback createTrackback()

Factory method to create a trackback . After the trackback is created, all fields should be set and then the trackback can be added to the object. Trackbacks are inherently an anonymous process, so no UnauthorizedException is declared. Trackback security will instead be handled by interceptors that analyze the excerpt, URL, IP address and / or title.

Note: creating the Trackback object is only one step of the process. You must also add the trackback to the object before it is saved to the database.

Returns:

a new Trackback object.

getTrackback

Trackback getTrackback(long trackbackID)
                       throws com.jivesoftware.community.TrackbackNotFoundException

Returns the Trackback with the supplied id.

Parameters:

trackbackID - the id of the trackback to return;

Returns:

the Trackback with the supplied id.

Throws:

TrackbackNotFoundException - if no trackback with that id exists.

addTrackback

void addTrackback(Trackback trackback)
                  throws RejectedException

Adds a new trackback to this object

When a trackback is being added, it is first run through all trackback interceptors that are installed. Each interceptor has the option to reject the trackback by throwing a RejectedException. For example, an interceptor might reject all trackbacks coming from a certain IP.

Parameters:

trackback - trackback to add to this object

Throws:

RejectedException - if one of the installed interceptors prevents the trackback from being posted.

See Also:

JiveInterceptor

deleteTrackback

void deleteTrackback(Trackback trackback)

Deletes a trackback on this object.

Parameters:

trackback - the trackback to delete.

Throws:

java.lang.IllegalArgumentException - if the trackback does not belong to the object.

deleteAllTrackbacks

void deleteAllTrackbacks()

Deletes all trackbacks on the object.

getTrackbacks

JiveIterator<Trackback> getTrackbacks()

Return an Iterable for all the incoming trackbacks on this object.

Returns:

an Iterable for all incoming trackbacks on this object.

getTrackbacks

JiveIterator<Trackback> getTrackbacks(FeedbackResultFilter resultFilter)

Returns a Iterable for all the incoming trackbacks on this object that match the criteria specified by the ResultFilter.

Parameters:

resultFilter - a ResultFilter object to perform filtering and sorting with.

Returns:

an Iterable for the incoming trackbacks on this object that match the ResultFilter.