org.outerj.daisy.emailnotifier
Interface Subscription


public interface Subscription


Method Summary
 java.util.Locale getLocale()
          Returns the locale to use to format the notification mails, returns null if not set.
 boolean getReceiveAclEvents()
           
 boolean getReceiveCollectionEvents()
           
 boolean getReceiveCommentEvents()
           
 boolean getReceiveDocumentEvents()
           
 boolean getReceiveSchemaEvents()
           
 boolean getReceiveUserEvents()
           
 CollectionSubscriptionKey[] getSubscribedCollectionKeys()
           
 org.outerj.daisy.repository.VariantKey[] getSubscribedVariantKeys()
           
 long getUserId()
          Returns the user to which this subscription applies.
 org.outerx.daisy.x10.SubscriptionDocument getXml()
           
 void save()
           
 void setFromXml(org.outerx.daisy.x10.SubscriptionDocument.Subscription subscriptionXml)
           
 void setLocale(java.util.Locale locale)
          Sets the locale used to format the notification mails.
 void setReceiveAclEvents(boolean value)
           
 void setReceiveCollectionEvents(boolean value)
           
 void setReceiveCommentEvents(boolean value)
           
 void setReceiveDocumentEvents(boolean value)
           
 void setReceiveSchemaEvents(boolean value)
           
 void setReceiveUserEvents(boolean value)
           
 void setSubscribedCollectionKeys(CollectionSubscriptionKey[] keys)
          Note: if any of the CollectionSubscriptionKey components for an entry is '-1', it means 'any'.
 void setSubscribedVariantKeys(org.outerj.daisy.repository.VariantKey[] keys)
          Note: if any of the VariantKey components for an entry is '-1', it means 'any'.
 

Method Detail

getUserId

long getUserId()
Returns the user to which this subscription applies.


setReceiveDocumentEvents

void setReceiveDocumentEvents(boolean value)

getReceiveDocumentEvents

boolean getReceiveDocumentEvents()

setReceiveSchemaEvents

void setReceiveSchemaEvents(boolean value)

getReceiveSchemaEvents

boolean getReceiveSchemaEvents()

setReceiveUserEvents

void setReceiveUserEvents(boolean value)

getReceiveUserEvents

boolean getReceiveUserEvents()

setReceiveCollectionEvents

void setReceiveCollectionEvents(boolean value)

getReceiveCollectionEvents

boolean getReceiveCollectionEvents()

setReceiveAclEvents

void setReceiveAclEvents(boolean value)

getReceiveAclEvents

boolean getReceiveAclEvents()

setReceiveCommentEvents

void setReceiveCommentEvents(boolean value)

getReceiveCommentEvents

boolean getReceiveCommentEvents()

getLocale

java.util.Locale getLocale()
Returns the locale to use to format the notification mails, returns null if not set.


setLocale

void setLocale(java.util.Locale locale)
Sets the locale used to format the notification mails.

Parameters:
locale - can be null

getSubscribedVariantKeys

org.outerj.daisy.repository.VariantKey[] getSubscribedVariantKeys()

setSubscribedVariantKeys

void setSubscribedVariantKeys(org.outerj.daisy.repository.VariantKey[] keys)
Note: if any of the VariantKey components for an entry is '-1', it means 'any'.


getSubscribedCollectionKeys

CollectionSubscriptionKey[] getSubscribedCollectionKeys()

setSubscribedCollectionKeys

void setSubscribedCollectionKeys(CollectionSubscriptionKey[] keys)
Note: if any of the CollectionSubscriptionKey components for an entry is '-1', it means 'any'.


save

void save()
          throws org.outerj.daisy.repository.RepositoryException
Throws:
org.outerj.daisy.repository.RepositoryException

getXml

org.outerx.daisy.x10.SubscriptionDocument getXml()

setFromXml

void setFromXml(org.outerx.daisy.x10.SubscriptionDocument.Subscription subscriptionXml)


Copyright © -2012 . All Rights Reserved.