|
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.ForumObject
public class ForumObject
Container representing a the type and ID of a forum object (e.g. ForumCategory, Forum, Poll, Announcement, etc.).
Constructor Summary | |
---|---|
ForumObject(int objectType,
long id)
Creates ForumObject from type and id |
Method Summary | |
---|---|
long |
getID()
Get the id |
int |
getObjectType()
Get the object type |
boolean |
isAnnouncement()
Whether this object is an announcement |
boolean |
isCategory()
Whether this object is a forum category |
boolean |
isForum()
Whether this object is a forum |
boolean |
isMessage()
Whether this object is a message |
boolean |
isPoll()
Whether this object is a poll |
boolean |
isRootCategory()
Whether the type and id is the root category of the jive forums instance |
static boolean |
isRootCategory(int objectType,
long id)
Convenience method to test whether the type and id is the root category of the jive forums instance |
boolean |
isThread()
Whether this object is a thread |
void |
setID(long id)
Set the id |
void |
setObjectType(int objectType)
Set the object type |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ForumObject(int objectType, long id)
objectType
- type of forum object as defined in JiveConstants
id
- identifier for this objectMethod Detail |
---|
public int getObjectType()
getObjectType
in interface JiveObject
JiveConstants
public void setObjectType(int objectType)
objectType
- defined in JiveConstants
public long getID()
getID
in interface JiveObject
public void setID(long id)
id
- identifier for this objectpublic static boolean isRootCategory(int objectType, long id)
objectType
- defined in JiveConstants
id
- identifier for this object
public boolean isRootCategory()
public boolean isCategory()
public boolean isForum()
public boolean isPoll()
public boolean isAnnouncement()
public boolean isThread()
public boolean isMessage()
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 |