com.arsdigita.forum
Class ForumSubscription

java.lang.Object
  extended bycom.arsdigita.domain.DomainObject
      extended bycom.arsdigita.domain.ObservableDomainObject
          extended bycom.arsdigita.kernel.ACSObject
              extended bycom.arsdigita.notification.BaseSubscription
                  extended bycom.arsdigita.forum.Subscription
                      extended bycom.arsdigita.forum.ForumSubscription
Direct Known Subclasses:
DailySubscription, ModerationAlert

public class ForumSubscription
extends Subscription

The ForumSubscription class provides notification capabilities on a Forum. Note that ForumSubscriptions should not be retrieved directly using the contructors, but rather by calling DomainObjectFactory.newInstance().

Version:
$Revision: #7 $ $Author: dan $ $DateTime: 2003/09/15 13:58:12 $
Author:
Kevin Scaldeferri (kevin@arsdigita.com)

Field Summary
static String BASE_DATA_OBJECT_TYPE
           
static String FORUM
           
static String IS_MODERATION_ALERT
           
 
Fields inherited from class com.arsdigita.forum.Subscription
versionId
 
Fields inherited from class com.arsdigita.notification.BaseSubscription
ALERT_BLURB, REPLY_BLURB, SEPARATOR
 
Fields inherited from class com.arsdigita.kernel.ACSObject
CONTAINER, DEFAULT_DOMAIN_CLASS, DISPLAY_NAME, ID, OBJECT_TYPE
 
Constructor Summary
protected ForumSubscription(BigDecimal id)
           
protected ForumSubscription(com.arsdigita.persistence.DataObject data)
           
  ForumSubscription(Forum forum)
           
protected ForumSubscription(com.arsdigita.persistence.OID oid)
           
  ForumSubscription(String typeName, Forum forum)
           
 
Method Summary
protected  void afterSave()
           
 void doWriteCheck()
           
protected  String getBaseDataObjectType()
           
 Forum getForum()
           
static ForumSubscription getFromForum(Forum forum)
          gets the ForumSubscription associated with the provided Forum
 String getSignature(com.arsdigita.messaging.ThreadedMessage post)
          Returns a signature with information about replying to the message.
 void setIsModerationAlert(boolean isModerationAlert)
           
 void setIsModerationAlert(Boolean isModerationAlert)
           
 
Methods inherited from class com.arsdigita.forum.Subscription
getHeader, getReturnURLMessage
 
Methods inherited from class com.arsdigita.notification.BaseSubscription
getGroup, isSubscribed, sendNotification, setGroup, setGroupName, setupSubscriptionGroup, subscribe, unsubscribe
 
Methods inherited from class com.arsdigita.kernel.ACSObject
assertPrivilege, beforeSave, checkPrivilege, doCreateCheck, getContainer, getDefaultDomainClass, getDisplayName, getID, getSpecificObjectType, getSpecificOID, gimmeContainer, initialize, isContainerModified, setID, setID
 
Methods inherited from class com.arsdigita.domain.ObservableDomainObject
addObserver, getObservers
 
Methods inherited from class com.arsdigita.domain.DomainObject
add, add, addToAssociation, afterDelete, beforeDelete, clear, delete, disconnect, equals, get, getObjectType, getOID, getSession, hashCode, isDeleted, isDisconnected, isModified, isNew, isPropertyModified, isValid, remove, remove, remove, removeFromAssociation, save, set, setAssociation, setAssociation, specializeDataObject, specializeDataObject, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

BASE_DATA_OBJECT_TYPE

public static final String BASE_DATA_OBJECT_TYPE
See Also:
Constant Field Values

IS_MODERATION_ALERT

public static final String IS_MODERATION_ALERT
See Also:
Constant Field Values

FORUM

public static final String FORUM
See Also:
Constant Field Values
Constructor Detail

ForumSubscription

public ForumSubscription(Forum forum)

ForumSubscription

public ForumSubscription(String typeName,
                         Forum forum)

ForumSubscription

protected ForumSubscription(com.arsdigita.persistence.OID oid)
                     throws com.arsdigita.domain.DataObjectNotFoundException

ForumSubscription

protected ForumSubscription(BigDecimal id)
                     throws com.arsdigita.domain.DataObjectNotFoundException

ForumSubscription

protected ForumSubscription(com.arsdigita.persistence.DataObject data)
Method Detail

getBaseDataObjectType

protected String getBaseDataObjectType()

getForum

public Forum getForum()

doWriteCheck

public void doWriteCheck()

afterSave

protected void afterSave()

getSignature

public String getSignature(com.arsdigita.messaging.ThreadedMessage post)
Returns a signature with information about replying to the message.

Overrides:
getSignature in class Subscription

getFromForum

public static ForumSubscription getFromForum(Forum forum)
gets the ForumSubscription associated with the provided Forum


setIsModerationAlert

public void setIsModerationAlert(boolean isModerationAlert)

setIsModerationAlert

public void setIsModerationAlert(Boolean isModerationAlert)


Copyright (c) 2004 Red Hat, Inc. Corporation. All Rights Reserved. Generated at July 21 2004:2348 UTC