oracle.discussions.ws.beans
Class Subscription

java.lang.Object
oracle.discussions.ws.beans.Subscription

public class Subscription

extends java.lang.Object

Represents a watch that an user holds on any discussions element.

An user can subscribe to any of his favorite elements.
A notification will be sent to that user, in case if there is any change in the state of the element, or any of its children he has subscribed to.

Constructor Summary

Subscription()
Default constructor

Method Summary

long	getContainerId() Returns the container id of the container subscribed.
java.lang.String	getEmailAddress() Returns the email address of the user,retrieving the subscription.
int	getTopicId() Returns the id of the topic subscribed to.
int	getType() Returns the type of notification set.
void	setContainerId(long containerId) Sets the container id of the container being subscribed.
void	setEmailAddress(java.lang.String email) Sets the email address of the user, requesting subscription.
void	setTopicId(int topicId) Sets the id of the topic being subscribed.
void	setType(int type) Sets the type of notification.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Subscription

public Subscription()

Default constructor

Method Detail

setEmailAddress

public void setEmailAddress(java.lang.String email)

Sets the email address of the user, requesting subscription.

All the notifications to be sent to the email specified.

getEmailAddress

public java.lang.String getEmailAddress()

Returns the email address of the user,retrieving the subscription.

Returns:

String - User's email address.

setType

public void setType(int type)

Sets the type of notification.

Two subscription notifications are possible.

• EMAIL Notification, depicted with an integer value 0
• DIGEST Notification, depicted with an integer value 1

At present, only email notifications are enabled.

Parameters:

type - - Notification type.

getType

public int getType()

Returns the type of notification set.

Two subscription notifications are possible.

• EMAIL Notification, depicted with an integer value 0
• DIGEST Notification, depicted with an integer value 1

At present, only email notifications are enabled.

Returns:

int - Notification type.

setContainerId

public void setContainerId(long containerId)

Sets the container id of the container being subscribed.

Parameters:

containerId - - id of the container, being subscribed.

getContainerId

public long getContainerId()

Returns the container id of the container subscribed.

Returns:

long - id of the container, being subscribed.

setTopicId

public void setTopicId(int topicId)

Sets the id of the topic being subscribed.

If the subscription is a container subscription, topic id is set to -1.

Parameters:

topicId - - id of the topic,being subscribed.

getTopicId

public int getTopicId()

Returns the id of the topic subscribed to.

If the subscription is a container subscription, topic id is set to -1.

Returns:

int - id of the topic,being subscribed.