com.xpn.xwiki.plugin.activitystream.api
Interface ActivityStream

All Known Implementing Classes:

ActivityStreamImpl

public interface ActivityStream

Manages the activity stream

Version:

$Id: $

Method Summary

void	addActivityEvent(ActivityEvent event, com.xpn.xwiki.XWikiContext context) Adding and activity event.
void	addActivityEvent(java.lang.String streamName, java.lang.String type, java.lang.String title, java.util.List<java.lang.String> params, com.xpn.xwiki.XWikiContext context)
void	addActivityEvent(java.lang.String streamName, java.lang.String type, java.lang.String title, com.xpn.xwiki.XWikiContext context)
void	addDocumentActivityEvent(java.lang.String streamName, com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String type, int priority, java.lang.String title, java.util.List<java.lang.String> params, com.xpn.xwiki.XWikiContext context)
void	addDocumentActivityEvent(java.lang.String streamName, com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String type, int priority, java.lang.String title, com.xpn.xwiki.XWikiContext context)
void	addDocumentActivityEvent(java.lang.String streamName, com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String type, java.lang.String title, java.util.List<java.lang.String> params, com.xpn.xwiki.XWikiContext context)
void	addDocumentActivityEvent(java.lang.String streamName, com.xpn.xwiki.doc.XWikiDocument doc, java.lang.String type, java.lang.String title, com.xpn.xwiki.XWikiContext context)
void	deleteActivityEvent(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEvents(boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEvents(java.lang.String streamName, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEventsForSpace(java.lang.String space, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEventsForSpace(java.lang.String streamName, java.lang.String space, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEventsForUser(java.lang.String user, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	getEventsForUser(java.lang.String streamName, java.lang.String user, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(java.util.List<ActivityEvent> events, java.lang.String author, java.lang.String title, java.lang.String description, java.lang.String copyright, java.lang.String encoding, java.lang.String url, java.lang.String suffix, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(java.util.List<ActivityEvent> events, java.lang.String author, java.lang.String title, java.lang.String description, java.lang.String copyright, java.lang.String encoding, java.lang.String url, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(java.util.List<ActivityEvent> events, java.lang.String suffix, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndFeed	getFeed(java.util.List<ActivityEvent> events, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndEntry	getFeedEntry(ActivityEvent event, java.lang.String suffix, com.xpn.xwiki.XWikiContext context)
com.sun.syndication.feed.synd.SyndEntry	getFeedEntry(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
java.lang.String	getFeedOutput(java.util.List<ActivityEvent> events, java.lang.String author, java.lang.String title, java.lang.String description, java.lang.String copyright, java.lang.String encoding, java.lang.String url, java.lang.String type, java.lang.String suffix, com.xpn.xwiki.XWikiContext context)
java.lang.String	getFeedOutput(java.util.List<ActivityEvent> events, java.lang.String author, java.lang.String title, java.lang.String description, java.lang.String copyright, java.lang.String encoding, java.lang.String url, java.lang.String type, com.xpn.xwiki.XWikiContext context)
java.lang.String	getFeedOutput(com.sun.syndication.feed.synd.SyndFeed feed, java.lang.String type)
java.lang.String	getStreamName(java.lang.String space, com.xpn.xwiki.XWikiContext context) Tranforms space name into stream name
void	initClasses(com.xpn.xwiki.XWikiContext context) Creates the classes used by the activity stream when necessary
java.util.List<ActivityEvent>	searchEvents(java.lang.String hql, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	searchEvents(java.lang.String fromHql, java.lang.String hql, boolean filter, int nb, int start, java.util.List<java.lang.Object> parameterValues, com.xpn.xwiki.XWikiContext context)
java.util.List<ActivityEvent>	searchEvents(java.lang.String fromHql, java.lang.String hql, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)

Method Detail

initClasses

void initClasses(com.xpn.xwiki.XWikiContext context)
                 throws com.xpn.xwiki.XWikiException

Creates the classes used by the activity stream when necessary

Throws:

com.xpn.xwiki.XWikiException

getStreamName

java.lang.String getStreamName(java.lang.String space,
                               com.xpn.xwiki.XWikiContext context)

Tranforms space name into stream name

Parameters:

space -

context -

Returns:

addActivityEvent

void addActivityEvent(ActivityEvent event,
                      com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException

Adding and activity event. The Id does not need to be filled as it will be created. Date and Wiki are optional

Parameters:

event -

context -

Throws:

ActivityStreamException

addActivityEvent

void addActivityEvent(java.lang.String streamName,
                      java.lang.String type,
                      java.lang.String title,
                      com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException

Throws:

ActivityStreamException

addActivityEvent

void addActivityEvent(java.lang.String streamName,
                      java.lang.String type,
                      java.lang.String title,
                      java.util.List<java.lang.String> params,
                      com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException

Throws:

ActivityStreamException

addDocumentActivityEvent

void addDocumentActivityEvent(java.lang.String streamName,
                              com.xpn.xwiki.doc.XWikiDocument doc,
                              java.lang.String type,
                              java.lang.String title,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException

Throws:

ActivityStreamException

addDocumentActivityEvent

void addDocumentActivityEvent(java.lang.String streamName,
                              com.xpn.xwiki.doc.XWikiDocument doc,
                              java.lang.String type,
                              int priority,
                              java.lang.String title,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException

Throws:

ActivityStreamException

addDocumentActivityEvent

void addDocumentActivityEvent(java.lang.String streamName,
                              com.xpn.xwiki.doc.XWikiDocument doc,
                              java.lang.String type,
                              java.lang.String title,
                              java.util.List<java.lang.String> params,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException

Throws:

ActivityStreamException

addDocumentActivityEvent

void addDocumentActivityEvent(java.lang.String streamName,
                              com.xpn.xwiki.doc.XWikiDocument doc,
                              java.lang.String type,
                              int priority,
                              java.lang.String title,
                              java.util.List<java.lang.String> params,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException

Throws:

ActivityStreamException

deleteActivityEvent

void deleteActivityEvent(ActivityEvent event,
                         com.xpn.xwiki.XWikiContext context)
                         throws ActivityStreamException

Throws:

ActivityStreamException

searchEvents

java.util.List<ActivityEvent> searchEvents(java.lang.String hql,
                                           boolean filter,
                                           int nb,
                                           int start,
                                           com.xpn.xwiki.XWikiContext context)
                                           throws ActivityStreamException

Throws:

ActivityStreamException

searchEvents

java.util.List<ActivityEvent> searchEvents(java.lang.String fromHql,
                                           java.lang.String hql,
                                           boolean filter,
                                           int nb,
                                           int start,
                                           com.xpn.xwiki.XWikiContext context)
                                           throws ActivityStreamException

Throws:

ActivityStreamException

searchEvents

java.util.List<ActivityEvent> searchEvents(java.lang.String fromHql,
                                           java.lang.String hql,
                                           boolean filter,
                                           int nb,
                                           int start,
                                           java.util.List<java.lang.Object> parameterValues,
                                           com.xpn.xwiki.XWikiContext context)
                                           throws ActivityStreamException

Throws:

ActivityStreamException

getEvents

java.util.List<ActivityEvent> getEvents(boolean filter,
                                        int nb,
                                        int start,
                                        com.xpn.xwiki.XWikiContext context)
                                        throws ActivityStreamException

Throws:

ActivityStreamException

getEventsForSpace

java.util.List<ActivityEvent> getEventsForSpace(java.lang.String space,
                                                boolean filter,
                                                int nb,
                                                int start,
                                                com.xpn.xwiki.XWikiContext context)
                                                throws ActivityStreamException

Throws:

ActivityStreamException

getEventsForUser

java.util.List<ActivityEvent> getEventsForUser(java.lang.String user,
                                               boolean filter,
                                               int nb,
                                               int start,
                                               com.xpn.xwiki.XWikiContext context)
                                               throws ActivityStreamException

Throws:

ActivityStreamException

getEvents

java.util.List<ActivityEvent> getEvents(java.lang.String streamName,
                                        boolean filter,
                                        int nb,
                                        int start,
                                        com.xpn.xwiki.XWikiContext context)
                                        throws ActivityStreamException

Throws:

ActivityStreamException

getEventsForSpace

java.util.List<ActivityEvent> getEventsForSpace(java.lang.String streamName,
                                                java.lang.String space,
                                                boolean filter,
                                                int nb,
                                                int start,
                                                com.xpn.xwiki.XWikiContext context)
                                                throws ActivityStreamException

Throws:

ActivityStreamException

getEventsForUser

java.util.List<ActivityEvent> getEventsForUser(java.lang.String streamName,
                                               java.lang.String user,
                                               boolean filter,
                                               int nb,
                                               int start,
                                               com.xpn.xwiki.XWikiContext context)
                                               throws ActivityStreamException

Throws:

ActivityStreamException

getFeedEntry

com.sun.syndication.feed.synd.SyndEntry getFeedEntry(ActivityEvent event,
                                                     com.xpn.xwiki.XWikiContext context)

getFeedEntry

com.sun.syndication.feed.synd.SyndEntry getFeedEntry(ActivityEvent event,
                                                     java.lang.String suffix,
                                                     com.xpn.xwiki.XWikiContext context)

getFeed

com.sun.syndication.feed.synd.SyndFeed getFeed(java.util.List<ActivityEvent> events,
                                               com.xpn.xwiki.XWikiContext context)

getFeed

com.sun.syndication.feed.synd.SyndFeed getFeed(java.util.List<ActivityEvent> events,
                                               java.lang.String suffix,
                                               com.xpn.xwiki.XWikiContext context)

getFeed

com.sun.syndication.feed.synd.SyndFeed getFeed(java.util.List<ActivityEvent> events,
                                               java.lang.String author,
                                               java.lang.String title,
                                               java.lang.String description,
                                               java.lang.String copyright,
                                               java.lang.String encoding,
                                               java.lang.String url,
                                               com.xpn.xwiki.XWikiContext context)

getFeed

com.sun.syndication.feed.synd.SyndFeed getFeed(java.util.List<ActivityEvent> events,
                                               java.lang.String author,
                                               java.lang.String title,
                                               java.lang.String description,
                                               java.lang.String copyright,
                                               java.lang.String encoding,
                                               java.lang.String url,
                                               java.lang.String suffix,
                                               com.xpn.xwiki.XWikiContext context)

getFeedOutput

java.lang.String getFeedOutput(java.util.List<ActivityEvent> events,
                               java.lang.String author,
                               java.lang.String title,
                               java.lang.String description,
                               java.lang.String copyright,
                               java.lang.String encoding,
                               java.lang.String url,
                               java.lang.String type,
                               com.xpn.xwiki.XWikiContext context)

getFeedOutput

java.lang.String getFeedOutput(java.util.List<ActivityEvent> events,
                               java.lang.String author,
                               java.lang.String title,
                               java.lang.String description,
                               java.lang.String copyright,
                               java.lang.String encoding,
                               java.lang.String url,
                               java.lang.String type,
                               java.lang.String suffix,
                               com.xpn.xwiki.XWikiContext context)

getFeedOutput

java.lang.String getFeedOutput(com.sun.syndication.feed.synd.SyndFeed feed,
                               java.lang.String type)