org.figure8.join.services.remoting
Interface ReportingService

All Superinterfaces:

AuthenticatedService, java.rmi.Remote

All Known Implementing Classes:

ReportingServiceImpl

public interface ReportingService
extends AuthenticatedService

Remote service interface definition. This service allows to interact with reporting related services of Join system such as informational messages creation and mailing list infos retrieval.

Version:

$Revision: 1.1 $

Author:

Laurent Broudoux

Method Summary

void	createMessage(java.lang.String token, RemoteMessage message) Create an informational message within Join system.
RemoteMailingList	getMailingList(java.lang.String eventKey, java.lang.String resourceId) Retrieve the mailing list corresponding to an event for a specified resource.
RemoteMailingList[]	getMailingLists(java.lang.String eventKey) Retrieve a list of mailing lists corresponding to an event (for different resources) Returns null if no match.
RemoteSubscriber[]	getSubscribers(RemoteMailingList mailingList) Retrieve a list of subscribers corresponding to a given mailing list.

Methods inherited from interface org.figure8.join.services.remoting.AuthenticatedService

login, logout

Method Detail

createMessage

void createMessage(java.lang.String token,
                   RemoteMessage message)
                   throws InvalidParameterException,
                          InvalidSessionException,
                          java.rmi.RemoteException

Create an informational message within Join system. This message will be visible through home page 'news' box and RSS feeds until its expiry date. This method requires authentication and 'joiner' role.

Parameters:

token - Authentication token provided earlier by login() method

message - The lightweight bean representing message to create

Throws:

InvalidParameterException - if message is not complete for being created

InvalidSessionException - if user has no valid session on server-side

java.rmi.RemoteException - if an exception occurs during the remote conversation

getMailingList

RemoteMailingList getMailingList(java.lang.String eventKey,
                                 java.lang.String resourceId)
                                 throws java.rmi.RemoteException

Retrieve the mailing list corresponding to an event for a specified resource. It returns null if no corresponding mailing list exists. This method requires authentication.

Parameters:

eventKey - The unique business key of event to get mailing list for

resourceId - The identifier of resource concerned by event

Returns:

A lightweight bean representing searched mailing list.

Throws:

java.rmi.RemoteException - if an exception occurs during the remote conversation

getMailingLists

RemoteMailingList[] getMailingLists(java.lang.String eventKey)
                                    throws java.rmi.RemoteException

Retrieve a list of mailing lists corresponding to an event (for different resources) Returns null if no match. This method requires authentication.

Parameters:

eventKey - The unique business key of event to get mailing list for

Returns:

An array of lightweight beans representing mailing lists

Throws:

java.rmi.RemoteException - if an exception occurs during the remote conversation

getSubscribers

RemoteSubscriber[] getSubscribers(RemoteMailingList mailingList)
                                  throws java.rmi.RemoteException

Retrieve a list of subscribers corresponding to a given mailing list. Returns null if no subscribers.

Parameters:

mailingList - The mailing list to retrieve subsribers for

Returns:

An array of lightweight beans representing subscribers of mailing list

Throws:

java.rmi.RemoteException - if an exception occurs during the remote conversation