|
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.base.stats.ReadStat
public class ReadStat
A read stat encapsulates information about an object read. Information includes what type of object is being
read (a forum, thread, message, document, etc), the object ID, the date it was read, the user who read it (or null
if it was read by a Guest) and the session
it was read under.
Constructor Summary | |
---|---|
ReadStat(User user,
int objectType,
long objectID,
ReadStatSession session)
Creates a new ReadStat. |
Method Summary | |
---|---|
java.util.Date |
getCreationDate()
Returns the date the read occured. |
long |
getID()
Returns the ID of the read stat, or -1 if the object has not been saved. |
long |
getObjectID()
Returns the ID of the object being read. |
int |
getObjectType()
Returns the type of object being read (ie, JiveConstants.FORUM ). |
ReadStatSession |
getReadStatSession()
Returns the session in which the read occurred. |
User |
getUser()
Returns the user who read the object, or null if the user was a Guest. |
void |
setID(long ID)
Sets the ID of the read stat - this is protected because the manager sets it when saving the read stat to the database. |
java.lang.String |
toString()
Returns the read stat in a readable format -- good for debugging. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ReadStat(User user, int objectType, long objectID, ReadStatSession session)
user
- the user reading the object or null if it is a guest.objectType
- the type of object being read.objectID
- the ID of the object being read.session
- the session the read occurs under.Method Detail |
---|
public long getID()
public void setID(long ID)
ID
- the new ID of the read stat.public int getObjectType()
JiveConstants.FORUM
).
public long getObjectID()
public java.util.Date getCreationDate()
public User getUser()
public ReadStatSession getReadStatSession()
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 |