Oracle Discussions Java API Reference
10g Release 1 (10.1.2)

B25496-01

oracle.discussions.sdk
Class TdSubscription

java.lang.Object
  |
  +--oracle.discussions.sdk.TdSubscription
Direct Known Subclasses:
TdThreadSubscription

public class TdSubscription
extends java.lang.Object

Oracle discussions allows users to subscribe to the discussions elements of their choice, to which they have access to.

Once the element is subscribed by a user, a notification email will be sent to him on any change in that element.
Once created, the subscription remains in place till

Subscriptions allow discussions users to monitor the changes to the discussions elements, without actually logging into the discussions instance.

Sample code snippet to illustrate the usage of TdSubscription

  //tdStore is an instance of TdStore class.
  //Extract the Subscription Manager from teh tdStore instance.
  TdSubscriptionManager tdSbtMgr = tdStore.getSubscriptionManager();
  //Extract subscription on a particulat thread from the subscription manager.
  TdSubscription tdSbt = tdSbtMgr.getSubscription(tdt);//tdt is a thread instance which is subscribed.
  //Extract the subscriber information from the subscription object.
  TdUser tdu = tdSbt.getSubscriber();
 
Since:
OCS 10.1.1
See Also:
TdSubscriptionManager

Field Summary
protected  java.lang.String _email
           
protected  int _iType
           
protected  TdContainer _tdc
           
protected  TdUser _usrctx
           
static int DIGEST
          Indicates that the notification sent is a forward to the user.
static int EMAIL
          Indicates the notification sent is an email to the user.

 

Constructor Summary
TdSubscription(TdUser usrctx, TdContainer tdc, java.lang.String email, int iType)
          Constructor to initialize a TdSubscription taking in the following parameters.

 

Method Summary
 java.lang.String getEmail()
          Returns the email address of the user requesting subscription.
 TdUser getSubscriber()
          Returns the user requesting the subscription.
 TdContainer getTdContainer()
          Returns the container on which the subscription is requested.
 int getType()
          Returns the subscription type for the current subscription.
 void setEmail(java.lang.String email)
          Sets the email address of the user requesting subscription.
 void setSubscriber(TdUser usrctx)
          Sets the user requesting the subscription.
 void setTdContainer(TdContainer tdc)
          Sets the container on which the subscription is being requested.
 void setType(int iType)
          Sets the subscription type for the current subscription.

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Field Detail

EMAIL

public static final int EMAIL
Indicates the notification sent is an email to the user.

DIGEST

public static final int DIGEST
Indicates that the notification sent is a forward to the user.

_usrctx

protected TdUser _usrctx

_tdc

protected TdContainer _tdc

_email

protected java.lang.String _email

_iType

protected int _iType

Constructor Detail

TdSubscription

public TdSubscription(TdUser usrctx,
                      TdContainer tdc,
                      java.lang.String email,
                      int iType)
Constructor to initialize a TdSubscription taking in the following parameters.