org.exoplatform.services.cms.watch

Interface WatchDocumentService

All Known Implementing Classes:

WatchDocumentServiceImpl

public interface WatchDocumentService

Created by The eXo Platform SARL Author : Pham Xuan Hoa hoapham@exoplatform.com Nov 30, 2006

Field Summary

Fields

Modifier and Type	Field and Description
static int	FULL_NOTIFICATION
static int	NOTIFICATION_BY_EMAIL
static int	NOTIFICATION_BY_RSS

Method Summary

Modifier and Type	Method and Description
int	getNotificationType(javax.jcr.Node documentNode, String userName) This method will gets the type of notification for the specify document
void	initializeMessageConfig(MessageConfigPlugin msgConfigPlugin) Initialize the notification email contents of watching document when the notification type is by email.
void	unwatchDocument(javax.jcr.Node documentNode, String userName, int notificationType) UnWatching the document that is specified by the node by giving a userName, notifyType
void	watchDocument(javax.jcr.Node documentNode, String userName, int notifyType) Watching the document that is specified by the node by giving a userName, notifyType

Field Detail

NOTIFICATION_BY_EMAIL

static final int NOTIFICATION_BY_EMAIL

See Also:

Constant Field Values

NOTIFICATION_BY_RSS

static final int NOTIFICATION_BY_RSS

See Also:

Constant Field Values

FULL_NOTIFICATION

static final int FULL_NOTIFICATION

See Also:

Constant Field Values

Method Detail

watchDocument

void watchDocument(javax.jcr.Node documentNode,
                   String userName,
                   int notifyType)
            throws Exception

Watching the document that is specified by the node by giving a userName, notifyType

If the document is watching, all thing that changes to it's property will be notified to user specified by the userName

Parameters:

documentNode - Specify the document for watching

userName - he username of current user is votting. It can't be null

notifyType - Type of notification. Its can be 0, 1 or 2 0 : Notification by email 1 : Notification by rss 2 : Full notification

Throws:

Exception

See Also:

Node

getNotificationType

int getNotificationType(javax.jcr.Node documentNode,
                        String userName)
                 throws Exception

This method will gets the type of notification for the specify document

If that document is not a exo:watchable document, the value return is -1 If notification is notified by email, the value return is 1 If notification is notified by rss, the value return is 2 If notification is notified by rss and email, the value return is 0

Parameters:

documentNode - Specify the document for watching

userName - The username of current user is votting. It can't be null

Returns:

0, 1, 2 or -1

Throws:

Exception

See Also:

Node

unwatchDocument

void unwatchDocument(javax.jcr.Node documentNode,
                     String userName,
                     int notificationType)
              throws Exception

UnWatching the document that is specified by the node by giving a userName, notifyType

If the document is unwatching, all thing that changes to it's property will not be notified to user specified by the userName

Parameters:

documentNode - Specify the document for watching

userName - The username of current user is votting. It can't be null

notificationType - Type of notification. Its can be 0, 1 or 2 0 : Notification by email 1 : Notification by rss 2 : Full notification

Throws:

Exception

See Also:

Node

initializeMessageConfig

void initializeMessageConfig(MessageConfigPlugin msgConfigPlugin)

Initialize the notification email contents of watching document when the notification type is by email.

Parameters:

msgConfigPlugin - The message configuration plug-in