Jive Forums API (5.5.20.2-oracle) Web Services Client Javadocs

com.jivesoftware.forum.webservices
Class Watch

java.lang.Object
  extended by com.jivesoftware.forum.webservices.Watch

public class Watch
extends java.lang.Object

A watch is a way for a user to track updates to an object. Users create watches on individual objects and can specify whether or not they want to be notified by email (or some other way) each time the object is updated.

Three kinds of watch types are available:


Field Summary
static int BATCH_EMAIL_WATCH
          Batch email watch type.
static int EMAIL_WATCH
          Email watch type.
static int NORMAL_WATCH
          Normal watch type.
 
Constructor Summary
Watch()
           
 
Method Summary
 boolean equals(java.lang.Object o)
           
 long getObjectID()
          Returns the object ID of the object being watched.
 int getObjectType()
          Returns the object type of the object being watched.
 long getUserID()
          Returns the if of the user who is associated with this watch.
 int getWatchType()
          Returns the type of the watch.
 int hashCode()
           
 boolean isExpirable()
          Returns whether this watch is expirable or not.
 void setExpirable(boolean expirable)
          Sets whether this watch is expirable or not.
 void setObjectID(long objectID)
           
 void setObjectType(int objectType)
           
 void setUserID(long userID)
           
 void setWatchType(int watchType)
          Sets the watch type.
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

NORMAL_WATCH

public static final int NORMAL_WATCH
Normal watch type.

See Also:
Constant Field Values

EMAIL_WATCH

public static final int EMAIL_WATCH
Email watch type.

See Also:
Constant Field Values

BATCH_EMAIL_WATCH

public static final int BATCH_EMAIL_WATCH
Batch email watch type.

See Also:
Constant Field Values
Constructor Detail

Watch

public Watch()
Method Detail

getUserID

public long getUserID()
Returns the if of the user who is associated with this watch.

Returns:
the if of the user who is associated with this watch.

setUserID

public void setUserID(long userID)

getObjectID

public long getObjectID()
Returns the object ID of the object being watched.

Returns:
the object ID of the object being watched.

setObjectID

public void setObjectID(long objectID)

getObjectType

public int getObjectType()
Returns the object type of the object being watched.

Returns:
the object type of the object being watched.

setObjectType

public void setObjectType(int objectType)

getWatchType

public int getWatchType()
Returns the type of the watch.

Returns:
the handler of the watch.

setWatchType

public void setWatchType(int watchType)
Sets the watch type.

Parameters:
watchType - the type of watch this should be.

isExpirable

public boolean isExpirable()
Returns whether this watch is expirable or not.

Returns:
true if the watch is expirable, false otherwise.

setExpirable

public void setExpirable(boolean expirable)
Sets whether this watch is expirable or not.

Parameters:
expirable - true if the watch is expirable, false if not.

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class java.lang.Object

hashCode

public int hashCode()
Overrides:
hashCode in class java.lang.Object

toString

public java.lang.String toString()
Overrides:
toString in class java.lang.Object

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.