com.sas.hls.messaging.subscription
Class Subscription

java.lang.Object
  extended by com.sas.hls.messaging.subscription.Subscription
All Implemented Interfaces:
Serializable

public class Subscription
extends Object
implements Serializable

The client representation of a subscription

See Also:
Serialized Form

Constructor Summary
Subscription(String path, Principal principal, SubscribableEvent event, boolean cascade)
          Constructor
 
Method Summary
 boolean equals(Object obj)
          Indicate whether some other object is "equal to" this one.
 String getPath()
          Get the path of the object for the subscription
 Principal getPrincipal()
          Get the principal for the subscription
 SubscribableEvent getSubscriptionEvent()
          Get the event subscribing to
 int hashCode()
          Return a hash code value for the object.
 boolean isCascade()
          Gets whether the subscription cascades
 void setCascade(boolean cascade)
          Sets whether the subscription will cascade
 void setPath(String path)
          Set the path of the object for the subscription
 void setPrincipal(Principal principal)
          Set the principal for the subscription
 void setSubscriptionEvent(SubscribableEvent event)
          Set the event subscribing to
 String toString()
          Return a string representation of the object.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Subscription

public Subscription(String path,
                    Principal principal,
                    SubscribableEvent event,
                    boolean cascade)
Constructor

Parameters:
path - The path of the object to which is being subscribed
principal - The principal who is being subscribed
event - The subscribable event
cascade - Whether child items should be included in the subscription
Method Detail

getPath

public String getPath()
Get the path of the object for the subscription

Returns:
The path of the object for the subscription

setPath

public void setPath(String path)
Set the path of the object for the subscription

Parameters:
path - The path of the object for the subscription

getPrincipal

public Principal getPrincipal()
Get the principal for the subscription

Returns:
principal the principal for this subscription

setPrincipal

public void setPrincipal(Principal principal)
Set the principal for the subscription

Parameters:
principal - the principal for this subscription

getSubscriptionEvent

public SubscribableEvent getSubscriptionEvent()
Get the event subscribing to

Returns:
event subscribing to

setSubscriptionEvent

public void setSubscriptionEvent(SubscribableEvent event)
Set the event subscribing to

Parameters:
event - the event subscribing to

isCascade

public boolean isCascade()
Gets whether the subscription cascades

Returns:
whether the event cascades

setCascade

public void setCascade(boolean cascade)
Sets whether the subscription will cascade

Parameters:
cascade - whether the subscription will cascade

hashCode

public int hashCode()
Return a hash code value for the object.

Overrides:
hashCode in class Object
See Also:
Object.hashCode()

equals

public boolean equals(Object obj)
Indicate whether some other object is "equal to" this one.

Overrides:
equals in class Object
See Also:
Object.equals(java.lang.Object)

toString

public String toString()
Return a string representation of the object.

Overrides:
toString in class Object
See Also:
Object.toString()


Copyright (c) 2014, SAS Institute Inc., Cary, NC, USA