com.jivesoftware.base
Class ForumObject

java.lang.Object
  com.jivesoftware.base.ForumObject

All Implemented Interfaces:

JiveObject

Direct Known Subclasses:

PermissionEvent

public class ForumObject
extends java.lang.Object
implements JiveObject

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

ForumObject

public ForumObject(int objectType,
                   long id)

Creates ForumObject from type and id

Parameters:

objectType - type of forum object as defined in JiveConstants

id - identifier for this object

Method Detail

getObjectType

public int getObjectType()

Get the object type

Specified by:

getObjectType in interface JiveObject

Returns:

object type as defined in JiveConstants

setObjectType

public void setObjectType(int objectType)

Set the object type

Parameters:

objectType - defined in JiveConstants

getID

public long getID()

Get the id

Specified by:

getID in interface JiveObject

Returns:

identifier for this object

setID

public void setID(long id)

Set the id

Parameters:

id - identifier for this object

isRootCategory

public 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

Parameters:

objectType - defined in JiveConstants

id - identifier for this object

Returns:

true of parameters refer to the root category

isRootCategory

public boolean isRootCategory()

Whether the type and id is the root category of the jive forums instance

Returns:

true if object is the root category

isCategory

public boolean isCategory()

Whether this object is a forum category

Returns:

true if object is a forum category

isForum

public boolean isForum()

Whether this object is a forum

Returns:

true if object is a forum

isPoll

public boolean isPoll()

Whether this object is a poll

Returns:

true if object is a poll

isAnnouncement

public boolean isAnnouncement()

Whether this object is an announcement

Returns:

true if object is a announcement

isThread

public boolean isThread()

Whether this object is a thread

Returns:

true if object is a thread

isMessage

public boolean isMessage()

Whether this object is a message

Returns:

true if object is a message

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object