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

All Known Implementing Classes:
ActivityStreamImpl

public interface ActivityStream

Manages the activity stream.

Version:
$Id: 8785269c79d7d1035f45b3db8e4714b79112cefe $

Method Summary
 void addActivityEvent(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
          Adding an activity event.
 void addActivityEvent(String streamName, String type, String title, List<String> params, com.xpn.xwiki.XWikiContext context)
          Adding an activity event.
 void addActivityEvent(String streamName, String type, String title, com.xpn.xwiki.XWikiContext context)
          Adding an activity event.
 void addDocumentActivityEvent(String streamName, com.xpn.xwiki.doc.XWikiDocument doc, String type, int priority, String title, List<String> params, com.xpn.xwiki.XWikiContext context)
          Adding an activity event.
 void addDocumentActivityEvent(String streamName, com.xpn.xwiki.doc.XWikiDocument doc, String type, int priority, String title, com.xpn.xwiki.XWikiContext context)
          Adding an activity event.
 void addDocumentActivityEvent(String streamName, com.xpn.xwiki.doc.XWikiDocument doc, String type, String title, List<String> params, com.xpn.xwiki.XWikiContext context)
          Adding an activity event.
 void addDocumentActivityEvent(String streamName, com.xpn.xwiki.doc.XWikiDocument doc, String type, String title, com.xpn.xwiki.XWikiContext context)
          Adding an activity event.
 void deleteActivityEvent(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
          Delete the given event from the database.
 List<ActivityEvent> getEvents(boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Get events from the activity stream.
 List<ActivityEvent> getEvents(String streamName, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Get events from a particular activity stream.
 List<ActivityEvent> getEventsForSpace(String space, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Get events from the activity stream of a space.
 List<ActivityEvent> getEventsForSpace(String streamName, String space, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Get events from the given activity stream which happened in a particular space.
 List<ActivityEvent> getEventsForUser(String user, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Get events from the activity stream of a user.
 List<ActivityEvent> getEventsForUser(String streamName, String user, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Get events from the given activity stream which have been fired by a particular user.
 com.sun.syndication.feed.synd.SyndFeed getFeed(List<ActivityEvent> events, String author, String title, String description, String copyright, String encoding, String url, String suffix, com.xpn.xwiki.XWikiContext context)
          Get a feed from the given events.
 com.sun.syndication.feed.synd.SyndFeed getFeed(List<ActivityEvent> events, String author, String title, String description, String copyright, String encoding, String url, com.xpn.xwiki.XWikiContext context)
          Get a feed from the given events.
 com.sun.syndication.feed.synd.SyndFeed getFeed(List<ActivityEvent> events, String suffix, com.xpn.xwiki.XWikiContext context)
          Get a feed from the given events.
 com.sun.syndication.feed.synd.SyndFeed getFeed(List<ActivityEvent> events, com.xpn.xwiki.XWikiContext context)
          Get a feed from the given events.
 com.sun.syndication.feed.synd.SyndEntry getFeedEntry(ActivityEvent event, String suffix, com.xpn.xwiki.XWikiContext context)
          Get the feed entry for the given event.
 com.sun.syndication.feed.synd.SyndEntry getFeedEntry(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
          Get the feed entry for the given event.
 String getFeedOutput(List<ActivityEvent> events, String author, String title, String description, String copyright, String encoding, String url, String type, String suffix, com.xpn.xwiki.XWikiContext context)
          Get the string representation of a feed from the given events.
 String getFeedOutput(List<ActivityEvent> events, String author, String title, String description, String copyright, String encoding, String url, String type, com.xpn.xwiki.XWikiContext context)
          Get the string representation of a feed from the given events.
 String getFeedOutput(com.sun.syndication.feed.synd.SyndFeed feed, String type)
           
 List<ActivityEvent> getRelatedEvents(ActivityEvent event, com.xpn.xwiki.XWikiContext context)
          Get events that have the same requestId as the event passed as parameter.
 String getStreamName(String space, com.xpn.xwiki.XWikiContext context)
          Tranforms space name into stream name.
 void init(com.xpn.xwiki.XWikiContext context)
          Init method, must be called on plugin init.
 List<Object[]> searchDailyPages(String optionalWhereClause, int maxItems, int startAt, com.xpn.xwiki.XWikiContext context)
          Get unique pages with events sorted by date, grouped by days.
 List<Object[]> searchDailyPages(String optionalWhereClause, List<Object> parametersValues, int maxItems, int startAt, com.xpn.xwiki.XWikiContext context)
          Get unique pages with events sorted by date, grouped by days.
 List<ActivityEvent> searchEvents(String hql, boolean filter, boolean globalSearch, int nb, int start, List<Object> parameterValues, com.xpn.xwiki.XWikiContext context)
          Search events.
 List<ActivityEvent> searchEvents(String hql, boolean filter, boolean globalSearch, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Search events.
 List<ActivityEvent> searchEvents(String hql, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Search events.
 List<ActivityEvent> searchEvents(String fromHql, String hql, boolean filter, boolean globalSearch, int nb, int start, List<Object> parameterValues, com.xpn.xwiki.XWikiContext context)
          Search events.
 List<ActivityEvent> searchEvents(String fromHql, String hql, boolean filter, boolean globalSearch, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Search events.
 List<ActivityEvent> searchEvents(String fromHql, String hql, boolean filter, int nb, int start, List<Object> parameterValues, com.xpn.xwiki.XWikiContext context)
          Search events.
 List<ActivityEvent> searchEvents(String fromHql, String hql, boolean filter, int nb, int start, com.xpn.xwiki.XWikiContext context)
          Search events.
 List<Object[]> searchUniquePages(String optionalWhereClause, int maxItems, int startAt, com.xpn.xwiki.XWikiContext context)
          Get unique pages with events sorted by date.
 List<Object[]> searchUniquePages(String optionalWhereClause, List<Object> parametersValues, int maxItems, int startAt, com.xpn.xwiki.XWikiContext context)
          Get unique pages with events sorted by date.
 

Method Detail

init

void init(com.xpn.xwiki.XWikiContext context)
          throws com.xpn.xwiki.XWikiException
Init method, must be called on plugin init.

Parameters:
context - the XWiki context
Throws:
com.xpn.xwiki.XWikiException - if the init of the activity stream failed

getStreamName

String getStreamName(String space,
                     com.xpn.xwiki.XWikiContext context)
Tranforms space name into stream name.

Parameters:
space - space to transform
context - the XWiki context
Returns:
the name of the stream for the given space

addActivityEvent

void addActivityEvent(ActivityEvent event,
                      com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException
Adding an activity event. The Id does not need to be filled as it will be created. Date and Wiki are optional.

Parameters:
event - event to add to the stream
context - the XWiki context
Throws:
ActivityStreamException - if the addition to the stream fails

addActivityEvent

void addActivityEvent(String streamName,
                      String type,
                      String title,
                      com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException
Adding an activity event. The Id does not need to be filled as it will be created. Date and Wiki are optional.

Parameters:
streamName - name of the stream to use for the addition
type - type of the event
title - title of the event
context - the XWiki context
Throws:
ActivityStreamException - if the addition to the stream fails

addActivityEvent

void addActivityEvent(String streamName,
                      String type,
                      String title,
                      List<String> params,
                      com.xpn.xwiki.XWikiContext context)
                      throws ActivityStreamException
Adding an activity event. The Id does not need to be filled as it will be created. Date and Wiki are optional.

Parameters:
streamName - name of the stream to use for the addition
type - type of the event
title - title of the event
params - parameters of the event
context - the XWiki context
Throws:
ActivityStreamException - if the addition to the stream fails

addDocumentActivityEvent

void addDocumentActivityEvent(String streamName,
                              com.xpn.xwiki.doc.XWikiDocument doc,
                              String type,
                              String title,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException
Adding an activity event. The Id does not need to be filled as it will be created. Date and Wiki are optional.

Parameters:
streamName - name of the stream to use for the addition
doc - which fired the event
type - type of the event
title - title of the event
context - the XWiki context
Throws:
ActivityStreamException - if the addition to the stream fails

addDocumentActivityEvent

void addDocumentActivityEvent(String streamName,
                              com.xpn.xwiki.doc.XWikiDocument doc,
                              String type,
                              int priority,
                              String title,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException
Adding an activity event. The Id does not need to be filled as it will be created. Date and Wiki are optional.

Parameters:
streamName - name of the stream to use for the addition
doc - which fired the event
type - type of the event
priority - priority of the event
title - title of the event
context - the XWiki context
Throws:
ActivityStreamException - if the addition to the stream fails

addDocumentActivityEvent

void addDocumentActivityEvent(String streamName,
                              com.xpn.xwiki.doc.XWikiDocument doc,
                              String type,
                              String title,
                              List<String> params,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException
Adding an activity event. The Id does not need to be filled as it will be created. Date and Wiki are optional.

Parameters:
streamName - name of the stream to use for the addition
doc - which fired the event
type - type of the event
title - title of the event
params - parameters of the event
context - the XWiki context
Throws:
ActivityStreamException - if the addition to the stream fails

addDocumentActivityEvent

void addDocumentActivityEvent(String streamName,
                              com.xpn.xwiki.doc.XWikiDocument doc,
                              String type,
                              int priority,
                              String title,
                              List<String> params,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException
Adding an activity event. The Id does not need to be filled as it will be created. Date and Wiki are optional.

Parameters:
streamName - name of the stream to use for the addition
doc - which fired the event
type - type of the event
priority - priority of the event
title - title of the event
params - parameters of the event
context - the XWiki context
Throws:
ActivityStreamException - if the addition to the stream fails

deleteActivityEvent

void deleteActivityEvent(ActivityEvent event,
                         com.xpn.xwiki.XWikiContext context)
                         throws ActivityStreamException
Delete the given event from the database.

Parameters:
event - the event to delete
context - the XWiki context
Throws:
ActivityStreamException - if the delete of the event fails

searchEvents

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

Parameters:
hql - HQL where query statement
filter - true if the events should be filtered by priority
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
matching events
Throws:
ActivityStreamException - if the search query fails

searchEvents

List<ActivityEvent> searchEvents(String hql,
                                 boolean filter,
                                 boolean globalSearch,
                                 int nb,
                                 int start,
                                 com.xpn.xwiki.XWikiContext context)
                                 throws ActivityStreamException
Search events.

Parameters:
hql - HQL where query statement
filter - true if the events should be filtered by priority
globalSearch - true if the request must be performed on the main database
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
matching events
Throws:
ActivityStreamException - if the search query fails

searchEvents

List<ActivityEvent> searchEvents(String hql,
                                 boolean filter,
                                 boolean globalSearch,
                                 int nb,
                                 int start,
                                 List<Object> parameterValues,
                                 com.xpn.xwiki.XWikiContext context)
                                 throws ActivityStreamException
Search events.

Parameters:
hql - HQL where query statement
filter - true if the events should be filtered by priority
globalSearch - true if the request must be performed on the main database
nb - number of events to retrieve
start - query offset
parameterValues - values of the parametrized query
context - the XWiki context
Returns:
matching events
Throws:
ActivityStreamException - if the search query fails

searchEvents

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

Parameters:
fromHql - HQL from query statement
hql - HQL where query statement
filter - true if the events should be filtered by priority
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
matching events
Throws:
ActivityStreamException - if the search query fails

searchEvents

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

Parameters:
fromHql - HQL from query statement
hql - HQL where query statement
filter - true if the events should be filtered by priority
globalSearch - true if the request must be performed on the main database
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
matching events
Throws:
ActivityStreamException - if the search query fails

searchEvents

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

Parameters:
fromHql - HQL from query statement
hql - HQL where query statement
filter - true if the events should be filtered by priority
nb - number of events to retrieve
start - query offset
parameterValues - values of the parametrized query
context - the XWiki context
Returns:
matching events
Throws:
ActivityStreamException - if the search query fails

searchEvents

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

Parameters:
fromHql - HQL from query statement
hql - HQL where query statement
filter - true if the events should be filtered by priority
globalSearch - true if the request must be performed on the main database
nb - number of events to retrieve
start - query offset
parameterValues - values of the parametrized query
context - the XWiki context
Returns:
matching events
Throws:
ActivityStreamException - if the search query fails

getEvents

List<ActivityEvent> getEvents(boolean filter,
                              int nb,
                              int start,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException
Get events from the activity stream.

Parameters:
filter - true if the events should be filtered by priority
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
a list of events
Throws:
ActivityStreamException - if the retrieval fails

getEventsForSpace

List<ActivityEvent> getEventsForSpace(String space,
                                      boolean filter,
                                      int nb,
                                      int start,
                                      com.xpn.xwiki.XWikiContext context)
                                      throws ActivityStreamException
Get events from the activity stream of a space.

Parameters:
space - space to retrieve the events from
filter - true if the events should be filtered by priority
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
a list of events
Throws:
ActivityStreamException - if the retrieval fails

getEventsForUser

List<ActivityEvent> getEventsForUser(String user,
                                     boolean filter,
                                     int nb,
                                     int start,
                                     com.xpn.xwiki.XWikiContext context)
                                     throws ActivityStreamException
Get events from the activity stream of a user.

Parameters:
user - user to retrieve the events from
filter - true if the events should be filtered by priority
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
a list of events
Throws:
ActivityStreamException - if the retrieval fails

getEvents

List<ActivityEvent> getEvents(String streamName,
                              boolean filter,
                              int nb,
                              int start,
                              com.xpn.xwiki.XWikiContext context)
                              throws ActivityStreamException
Get events from a particular activity stream.

Parameters:
streamName - name of the activity stream to retrieve the events from
filter - true if the events should be filtered by priority
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
a list of events
Throws:
ActivityStreamException - if the retrieval fails

getEventsForSpace

List<ActivityEvent> getEventsForSpace(String streamName,
                                      String space,
                                      boolean filter,
                                      int nb,
                                      int start,
                                      com.xpn.xwiki.XWikiContext context)
                                      throws ActivityStreamException
Get events from the given activity stream which happened in a particular space.

Parameters:
streamName - name of the activity stream to retrieve the events from
space - space to retrieve the events from
filter - true if the events should be filtered by priority
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
a list of events
Throws:
ActivityStreamException - if the retrieval fails

getEventsForUser

List<ActivityEvent> getEventsForUser(String streamName,
                                     String user,
                                     boolean filter,
                                     int nb,
                                     int start,
                                     com.xpn.xwiki.XWikiContext context)
                                     throws ActivityStreamException
Get events from the given activity stream which have been fired by a particular user.

Parameters:
streamName - name of the activity stream to retrieve the events from
user - user to retrieve the events from
filter - true if the events should be filtered by priority
nb - number of events to retrieve
start - query offset
context - the XWiki context
Returns:
a list of events
Throws:
ActivityStreamException - if the retrieval fails

getFeedEntry

com.sun.syndication.feed.synd.SyndEntry getFeedEntry(ActivityEvent event,
                                                     com.xpn.xwiki.XWikiContext context)
Get the feed entry for the given event.

Parameters:
event - event to get the entry for
context - the XWiki context
Returns:
the feed entry corresponding to the event

getFeedEntry

com.sun.syndication.feed.synd.SyndEntry getFeedEntry(ActivityEvent event,
                                                     String suffix,
                                                     com.xpn.xwiki.XWikiContext context)
Get the feed entry for the given event.

Parameters:
event - event to get the entry for
suffix - suffix to add to entry title and body strings
context - the XWiki context
Returns:
the feed entry corresponding to the event

getFeed

com.sun.syndication.feed.synd.SyndFeed getFeed(List<ActivityEvent> events,
                                               com.xpn.xwiki.XWikiContext context)
Get a feed from the given events.

Parameters:
events - events to create the feed from
context - the XWiki context
Returns:
the feed entry corresponding to the given events

getFeed

com.sun.syndication.feed.synd.SyndFeed getFeed(List<ActivityEvent> events,
                                               String suffix,
                                               com.xpn.xwiki.XWikiContext context)
Get a feed from the given events.

Parameters:
events - events to create the feed from
suffix - suffix to add to entries title and body strings
context - the XWiki context
Returns:
the feed entry corresponding to the given events

getFeed

com.sun.syndication.feed.synd.SyndFeed getFeed(List<ActivityEvent> events,
                                               String author,
                                               String title,
                                               String description,
                                               String copyright,
                                               String encoding,
                                               String url,
                                               com.xpn.xwiki.XWikiContext context)
Get a feed from the given events.

Parameters:
events - events to create the feed from
author - author to set in the feed metadata
title - title to set in the feed metadata
description - description to set in the feed metadata
copyright - copyright to set in the feed metadata
encoding - encoding to set in the feed metadata
url - URL to set in the feed metadata
context - the XWiki context
Returns:
the feed entry corresponding to the given events

getFeed

com.sun.syndication.feed.synd.SyndFeed getFeed(List<ActivityEvent> events,
                                               String author,
                                               String title,
                                               String description,
                                               String copyright,
                                               String encoding,
                                               String url,
                                               String suffix,
                                               com.xpn.xwiki.XWikiContext context)
Get a feed from the given events.

Parameters:
events - events to create the feed from
author - author to set in the feed metadata
title - title to set in the feed metadata
description - description to set in the feed metadata
copyright - copyright to set in the feed metadata
encoding - encoding to set in the feed metadata
url - URL to set in the feed metadata
suffix - suffix to add to entries title and body strings
context - the XWiki context
Returns:
the feed entry corresponding to the given events

getFeedOutput

String getFeedOutput(List<ActivityEvent> events,
                     String author,
                     String title,
                     String description,
                     String copyright,
                     String encoding,
                     String url,
                     String type,
                     com.xpn.xwiki.XWikiContext context)
Get the string representation of a feed from the given events.

Parameters:
events - events to create the feed from
author - author to set in the feed metadata
title - title to set in the feed metadata
description - description to set in the feed metadata
copyright - copyright to set in the feed metadata
encoding - encoding to set in the feed metadata
url - URL to set in the feed metadata
type - the feed type (syntax) to use, null if none. It can be any version of RSS or Atom. Some possible values are "rss_1.0", "rss_2.0" and "atom_1.0"
context - the XWiki context
Returns:
the feed entry corresponding to the given events

getFeedOutput

String getFeedOutput(List<ActivityEvent> events,
                     String author,
                     String title,
                     String description,
                     String copyright,
                     String encoding,
                     String url,
                     String type,
                     String suffix,
                     com.xpn.xwiki.XWikiContext context)
Get the string representation of a feed from the given events.

Parameters:
events - events to create the feed from
author - author to set in the feed metadata
title - title to set in the feed metadata
description - description to set in the feed metadata
copyright - copyright to set in the feed metadata
encoding - encoding to set in the feed metadata
url - URL to set in the feed metadata
type - the feed type (syntax) to use, null if none. It can be any version of RSS or Atom. Some possible values are "rss_1.0", "rss_2.0" and "atom_1.0"
suffix - suffix to add to entries title and body strings
context - the XWiki context
Returns:
the feed entry corresponding to the given events

getFeedOutput

String getFeedOutput(com.sun.syndication.feed.synd.SyndFeed feed,
                     String type)
Parameters:
feed - the feed to get the string representation for
type - the feed type (syntax) to use, null if none. It can be any version of RSS or Atom. Some possible values are "rss_1.0", "rss_2.0" and "atom_1.0"
Returns:
the string representation of the given feed.

getRelatedEvents

List<ActivityEvent> getRelatedEvents(ActivityEvent event,
                                     com.xpn.xwiki.XWikiContext context)
                                     throws ActivityStreamException
Get events that have the same requestId as the event passed as parameter. The provided event is also included in the returned list.

Parameters:
event - the event for which to look for related events
context - the XWiki context
Returns:
a list of events
Throws:
ActivityStreamException - if the retrieval fails

searchUniquePages

List<Object[]> searchUniquePages(String optionalWhereClause,
                                 int maxItems,
                                 int startAt,
                                 com.xpn.xwiki.XWikiContext context)
                                 throws ActivityStreamException
Get unique pages with events sorted by date. A document is returned at most once, regardless of the number of events.

Parameters:
optionalWhereClause - optional HQL where query statement
maxItems - maximum number of documents to retrieve
startAt - query offset
context - the XWiki context
Returns:
pairs of [document name, last event date], in descending order of the last event date
Throws:
ActivityStreamException - if the search fails

searchUniquePages

List<Object[]> searchUniquePages(String optionalWhereClause,
                                 List<Object> parametersValues,
                                 int maxItems,
                                 int startAt,
                                 com.xpn.xwiki.XWikiContext context)
                                 throws ActivityStreamException
Get unique pages with events sorted by date. A document is returned at most once, regardless of the number of events.

Parameters:
optionalWhereClause - optional HQL where query statement
parametersValues - values for the query parameters
maxItems - maximum number of documents to retrieve
startAt - query offset
context - the XWiki context
Returns:
pairs of [document name, last event date], in descending order of the last event date
Throws:
ActivityStreamException - if the search fails

searchDailyPages

List<Object[]> searchDailyPages(String optionalWhereClause,
                                int maxItems,
                                int startAt,
                                com.xpn.xwiki.XWikiContext context)
                                throws ActivityStreamException
Get unique pages with events sorted by date, grouped by days. A document is returned at most once per day, but might appear more than once if it has associated events in different days.

Parameters:
optionalWhereClause - optional HQL where query statement
maxItems - maximum number of documents to retrieve
startAt - query offset
context - the XWiki context
Returns:
pairs of [document name, event date], in descending order of the last event date
Throws:
ActivityStreamException - if the search fails

searchDailyPages

List<Object[]> searchDailyPages(String optionalWhereClause,
                                List<Object> parametersValues,
                                int maxItems,
                                int startAt,
                                com.xpn.xwiki.XWikiContext context)
                                throws ActivityStreamException
Get unique pages with events sorted by date, grouped by days. A document is returned at most once per day, but might appear more than once if it has associated events in different days.

Parameters:
optionalWhereClause - optional HQL where query statement
parametersValues - values for the query parameters
maxItems - maximum number of documents to retrieve
startAt - query offset
context - the XWiki context
Returns:
pairs of [document name, event date], in descending order of the last event date
Throws:
ActivityStreamException - if the search fails


Copyright © 2004-2011 XWiki. All Rights Reserved.