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

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


setReceiveDocumentEvents

public void setReceiveDocumentEvents(boolean value)

getReceiveDocumentEvents

public boolean getReceiveDocumentEvents()

setReceiveSchemaEvents

public void setReceiveSchemaEvents(boolean value)

getReceiveSchemaEvents

public boolean getReceiveSchemaEvents()

setReceiveUserEvents

public void setReceiveUserEvents(boolean value)

getReceiveUserEvents

public boolean getReceiveUserEvents()

setReceiveCollectionEvents

public void setReceiveCollectionEvents(boolean value)

getReceiveCollectionEvents

public boolean getReceiveCollectionEvents()

setReceiveAclEvents

public void setReceiveAclEvents(boolean value)

getReceiveAclEvents

public boolean getReceiveAclEvents()

setReceiveCommentEvents

public void setReceiveCommentEvents(boolean value)

getReceiveCommentEvents

public boolean getReceiveCommentEvents()

getLocale

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


setLocale

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

Parameters:
locale - can be null

getSubscribedVariantKeys

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

setSubscribedVariantKeys

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


getSubscribedCollectionKeys

public CollectionSubscriptionKey[] getSubscribedCollectionKeys()

setSubscribedCollectionKeys

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


save

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

getXml

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

setFromXml

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


Copyright © -2005 . All Rights Reserved.