com.ibm.ram.client
Class RAMSubscription

java.lang.Object
  extended by com.ibm.ram.client.RAMSubscription

public class RAMSubscription
extends java.lang.Object

Represents a subscription to a forum, topic, post, or an asset

Since:
7.5

Nested Class Summary
static class RAMSubscription.Frequency
          Constants for how frequently a user is notified of a subscription
 
Constructor Summary
RAMSubscription(java.lang.String subscriptionName, RAMUser user)
          Create a new Asset Subscription.
 
Method Summary
 RAMAction getAction()
          RAMAction.DELETE to remove this subscription RAMACtion.UPDATE to make changes to this subscription RAMACtion.CREATE to post this as a new subscription null to make no change on put of the asset.
 RAMSubscription.Frequency getFrequency()
           
 java.lang.String getIdentifier()
           
 java.lang.String getName()
           
 java.lang.String getResourceURI()
          Return the URL of the internal XML Resource representation of this asset.
 RAMUser getUser()
           
 void setAction(RAMAction action)
          RAMAction.DELETE to remove this subscription RAMACtion.UPDATE to make changes to this subscription RAMACtion.CREATE to post this as a new subscription null to make no change on put of the asset.
 void setFrequency(RAMSubscription.Frequency frequency)
           
 void setName(java.lang.String name)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RAMSubscription

public RAMSubscription(java.lang.String subscriptionName,
                       RAMUser user)
Create a new Asset Subscription. RAMAsset.addSubscription(RAMSubscription) to subscribe to an asset

Since:
7.5
Method Detail

getUser

public RAMUser getUser()
Returns:
Returns the user.
Since:
7.5

getFrequency

public RAMSubscription.Frequency getFrequency()
Returns:
Returns the frequency.
Since:
7.5

setFrequency

public void setFrequency(RAMSubscription.Frequency frequency)
Parameters:
frequency - The frequency to set.
Since:
7.5

getName

public java.lang.String getName()
Returns:
Returns the subscription name.
Since:
7.5

setName

public void setName(java.lang.String name)
Since:
7.5

getIdentifier

public java.lang.String getIdentifier()
Returns:
Returns the identifier.
Since:
7.5

getAction

public RAMAction getAction()
RAMAction.DELETE to remove this subscription RAMACtion.UPDATE to make changes to this subscription RAMACtion.CREATE to post this as a new subscription null to make no change on put of the asset.

Since:
7.5

setAction

public void setAction(RAMAction action)
RAMAction.DELETE to remove this subscription RAMACtion.UPDATE to make changes to this subscription RAMACtion.CREATE to post this as a new subscription null to make no change on put of the asset.

Since:
7.5

getResourceURI

public java.lang.String getResourceURI()
Return the URL of the internal XML Resource representation of this asset.

Since:
7.5