|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.forum.webservices.Watch
public class Watch
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 |
---|
public static final int NORMAL_WATCH
public static final int EMAIL_WATCH
public static final int BATCH_EMAIL_WATCH
Constructor Detail |
---|
public Watch()
Method Detail |
---|
public long getUserID()
public void setUserID(long userID)
public long getObjectID()
public void setObjectID(long objectID)
public int getObjectType()
public void setObjectType(int objectType)
public int getWatchType()
public void setWatchType(int watchType)
watchType
- the type of watch this should be.public boolean isExpirable()
public void setExpirable(boolean expirable)
expirable
- true if the watch is expirable, false if not.public boolean equals(java.lang.Object o)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |