org.figure8.join.businessfacades.reporting
Interface ReportingManager

All Known Implementing Classes:

DefaultReportingManager

public interface ReportingManager

This is a business facades that exposes all methods related to Join reporting services.

Version:

$Revision: 1.3 $

Author:

Laurent Broudoux

Method Summary

Event	getEvent(java.lang.String key) Retrieve an Event using its unique key
java.util.List	getEvents() Retrieve all already registered events
MailingList	getMailingList(Event event, java.lang.String resourceId) Retrieve the mailing list corresponding to an event on a specified resource
MailingList	getMailingList(java.lang.String name) Retrieve a MailigList using its name
java.util.List	getMailingLists() Retrieve all the existing mailing lists
java.util.List	getMailingLists(Event event) Retrieve the mailing list corresponding to an event
Message	getMessage(long id) Retrieve a message using its unique identifier
java.util.List	getMessages(java.util.Date startDate, java.util.Date endDate, Release release) Retrieve the messages published between startDate and endDate for a release
java.util.List	getOpenMessages(Release release) Retrieve the currently opened messages (ie : published) for a release
java.util.List	getSubscriptionsForUser(java.lang.String subscriberId) Retrieve all subscriptions corresponding to a subscriber
void	saveMailingList(MailingList list) Save a MilingList within datastore (create or update)
void	saveMessage(Message message) Save a Message within datastore (create or update)
void	susbcribeUser(java.lang.String subscriberId, java.util.List mailingLists) Subscribe a user to a set of mailing lists.

Method Detail

getEvents

java.util.List getEvents()

Retrieve all already registered events

Returns:

A list of org.figure8.join.businessobjects.reporting.Event objects

getEvent

Event getEvent(java.lang.String key)

Retrieve an Event using its unique key

Parameters:

key - The key of Event to retrieve

Returns:

The Event having this key or null if no one match

saveMessage

void saveMessage(Message message)

Save a Message within datastore (create or update)

Parameters:

message - The message to save

getOpenMessages

java.util.List getOpenMessages(Release release)

Retrieve the currently opened messages (ie : published) for a release

Parameters:

release - The release to filter messages for (may be null)

Returns:

A list of {org.figure8.join.businessobjects.reporting.Message}s

getMessages

java.util.List getMessages(java.util.Date startDate,
                           java.util.Date endDate,
                           Release release)

Retrieve the messages published between startDate and endDate for a release

Parameters:

startDate - The date of messages research start

endDate - The date of messages research end

release - The release to filter messages for (may be null)

Returns:

A list of {org.figure8.join.businessobjects.reporting.Message}s

getMessage

Message getMessage(long id)

Retrieve a message using its unique identifier

Parameters:

id - Identifier of message to retrieve

Returns:

The message having this id or null if not found.

saveMailingList

void saveMailingList(MailingList list)
                     throws DuplicateEntityException

Save a MilingList within datastore (create or update)

Parameters:

list - The mailing list to save

Throws:

DuplicateEntityException - if another list with same name already exists

getMailingLists

java.util.List getMailingLists(Event event)

Retrieve the mailing list corresponding to an event

Parameters:

event - The event to get lists for

Returns:

A list of org.figure8.join.businessobjects.reporting.MailingList objects

getMailingLists

java.util.List getMailingLists()

Retrieve all the existing mailing lists

Returns:

A list of all the existing MailingLists

getMailingList

MailingList getMailingList(java.lang.String name)

Retrieve a MailigList using its name

Parameters:

name - The name of mailing list to retrieve

Returns:

The mailing list having this name or null if no correspondance found

getMailingList

MailingList getMailingList(Event event,
                           java.lang.String resourceId)

Retrieve the mailing list corresponding to an event on a specified resource

Parameters:

event - The event to get lists for

resourceId - The identifier of resource to whom event applies

Returns:

A org.figure8.join.businessobjects.reporting.MailingList object

susbcribeUser

void susbcribeUser(java.lang.String subscriberId,
                   java.util.List mailingLists)

Subscribe a user to a set of mailing lists. This will also unsubscribe user from existing mailing lists that are not present into given set.

Parameters:

subscriberId - Unique identifier of user to register subscriptions

mailingLists - A list of org.figure8.join.businessobjects.reporting.MailingList objects

getSubscriptionsForUser

java.util.List getSubscriptionsForUser(java.lang.String subscriberId)

Retrieve all subscriptions corresponding to a subscriber

Parameters:

subscriberId - Unique identifier of user having subscriptions

Returns:

A list of org.figure8.join.businessobjects.reporting.Subscription