com.atlassian.confluence.mail.notification
Class Notification

java.lang.Object
  com.atlassian.core.bean.EntityObject
      com.atlassian.confluence.core.ConfluenceEntityObject
          com.atlassian.confluence.mail.notification.Notification

All Implemented Interfaces:

Serializable, Cloneable

public class Notification
extends ConfluenceEntityObject

A "Notification" is an email subscription or "watch" on some space. If page and space are set, it's a page notification If just space is set, it's a space notification If neither are set, it's a daily email subscription (Yeah, slightly dodgy, but it works)

See Also:

Serialized Form

Constructor Summary

Notification()

Method Summary

String[]	getDropWatch(NotificationData notificationData) Returns the url and text for the email footer 'Stop watching/following...' links
AbstractPage	getPage()
Space	getSpace()
ContentTypeEnum	getType()
String	getUserName()
boolean	isDigest()
boolean	isNetwork()
boolean	isUserChange()
boolean	matchesContentType(AbstractPage page) Returns true if this notification matches the type of the passed content object.
void	setDigest(boolean digest)
void	setNetwork(boolean network)
void	setPage(AbstractPage page)
void	setSpace(Space space)
void	setType(ContentTypeEnum type)
void	setUserName(String userName)

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreatorName, getLastModifierName, getRealClass, isPersistent, setCreatorName, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, equals, getCreationDate, getCurrentDate, getId, getLastModificationDate, hashCode, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Notification

public Notification()

Method Detail

getPage

public AbstractPage getPage()

setPage

public void setPage(AbstractPage page)

getUserName

public String getUserName()

setUserName

public void setUserName(String userName)

getSpace

public Space getSpace()

setSpace

public void setSpace(Space space)

isUserChange

public boolean isUserChange()

isDigest

public boolean isDigest()

setDigest

public void setDigest(boolean digest)

getType

public ContentTypeEnum getType()

setType

public void setType(ContentTypeEnum type)

isNetwork

public boolean isNetwork()

setNetwork

public void setNetwork(boolean network)

getDropWatch

public String[] getDropWatch(NotificationData notificationData)

Returns the url and text for the email footer 'Stop watching/following...' links

Parameters:

notificationData - The notification data for which the url should be generated

Returns:

A two-member String array of [url, text], or null if the notification has no defined watch type

matchesContentType

public boolean matchesContentType(AbstractPage page)

Returns true if this notification matches the type of the passed content object.