Package org.deltava.beans.cooler

Class MessageThread

java.lang.Object

org.deltava.beans.DatabaseBean

org.deltava.beans.cooler.MessageThread

All Implemented Interfaces:

Serializable, Comparable<Object>, AuthoredBean, IDBean, ViewEntry, Cacheable

public class MessageThread
extends DatabaseBean
implements AuthoredBean, ViewEntry

A class to store Water Cooler message threads.

Since:

1.0

Version:

11.1

Author:

Luke

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MessageThread(String subject)	Create a new thread with a particular subject.

Method Summary

Modifier and Type	Method	Description
void	addImageURL(String url, String desc)	Adds a URL to the list of linked Image URLs for this Message Thread.
void	addImageURL(LinkedImage img)	Adds a URL to the list of linked Image URLs for this Message Thread.
void	addOption(PollOption opt)	Adds a single poll option to this thread.
void	addOptions(Collection<PollOption> opts)	Adds poll options to this thread.
void	addPost(Message msg)	Adds a message to this thread.
void	addReportID(int id)	Adds a database ID to the list of users reporting a thread for content.
void	addUpdate(ThreadUpdate upd)	Adds a thread update entry to this thread.
void	addVotes(Collection<PollVote> votes)	Adds poll votes to this thread.
int	compareTo(Object o2)	Compares to another thread via the last updated on date.
int	getAuthorID()	Returns the database ID of the first Person to post to this thread.
String	getChannel()	Returns the channel name for this thread.
boolean	getHasDisabledLinks()	Returns whether this thread has any disabled Image Links.
boolean	getHidden()	Returns if this thread is hidden to general users.
int	getImage()	Returns the linked image ID for this thread.
Collection<LinkedImage>	getImageURLs()	Returns all linked Image URLs for this Message Thread.
Message	getLastPost()	Returns the last post in a message thread.
Instant	getLastUpdatedOn()	Returns the date of the latest post in this thread.
int	getLastUpdateID()	Returns the database ID of the last Person to post to this thread.
boolean	getLocked()	Returns if this thread is locked (no new posts allowed).
int	getNextPostID(Instant dt)	Returns the post ID of the first post created after a particular date/time.
Collection<PollOption>	getOptions()	Returns all poll options for this Message Thread.
boolean	getPoll()	Returns if this thread has a poll.
int	getPostCount()	Returns the number of messages in this thread.
List<Message>	getPosts()	Returns this thread's messages.
int	getReportCount()	Returns the number of times this post has been reported for content.
Collection<Integer>	getReportIDs()	Returns the database IDs of all users reporting this thread for content.
String	getRowClassName()	Selects a table row class based upon whether the thread is hidden or not.
boolean	getStickyInChannelOnly()	Returns if this thread should be considered a "sticky" thread in its Channel only.
Instant	getStickyUntil()	Returns the date/time this thread will be "stuck" at the top of the thread list until.
String	getSubject()	Returns the thread's subject.
Collection<ThreadUpdate>	getUpdates()	Returns this thread's update history
int	getViews()	Returns the number of times this thread has been read.
Collection<PollVote>	getVotes()	Returns all poll votes for this Message Thread.
boolean	hasVoted(int pilotID)	Returns whether a Pilot has voted in a particular Water Cooler poll.
void	setAuthorID(int id)	Updates the database ID of the first Person to post to this thread.
void	setChannel(String channelName)	Updates this thread's Channel.
void	setHidden(boolean hidden)	Sets this thread's hidden flag.
void	setImage(int id)	Updates the linked image for this thread.
void	setLastUpdatedOn(Instant dt)	Updates the date this thread's latest message was posted.
void	setLastUpdateID(int id)	Updates the database ID of the last Person to post to this thread.
void	setLocked(boolean locked)	Sets this thread's locked flag.
void	setPoll(boolean poll)	Sets this thread's poll flag.
void	setPostCount(int posts)	Updates the number of messages in this thread.
void	setReportCount(int count)	Updates the thread's content report count.
void	setStickyInChannelOnly(boolean isSticky)	Updates whether the thread will be sticky in the current channel only.
void	setStickyUntil(Instant dt)	Updates the date/time this thread will be a "sticky" until.
void	setViews(int views)	Updates the number of times this thread has been read.
void	view()	Increments the view counter.

Methods inherited from class org.deltava.beans.DatabaseBean

cacheKey, equals, getHexID, getID, hashCode, setID, validateID, validateID

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

MessageThread

public MessageThread(String subject)

Create a new thread with a particular subject.

Parameters:

subject - the thread subject

Throws:

NullPointerException - if subject is null

See Also:

• getSubject()

Method Details

getChannel

public String getChannel()

Returns the channel name for this thread.

Returns:

the channel name

See Also:

• setChannel(String)
• Channel

getAuthorID

public int getAuthorID()

Returns the database ID of the first Person to post to this thread.

Specified by:

getAuthorID in interface AuthoredBean

Returns:

the database ID

See Also:

• setAuthorID(int)
• getLastUpdateID()

getLastUpdateID

public int getLastUpdateID()

Returns the database ID of the last Person to post to this thread.

Returns:

the database ID

See Also:

• setLastUpdateID(int)
• getAuthorID()

getNextPostID

public int getNextPostID(Instant dt)

Returns the post ID of the first post created after a particular date/time.

Parameters:

dt - the date/time to check

Returns:

the post ID, or MAX_INTEGER if none

getLastUpdatedOn

public Instant getLastUpdatedOn()

Returns the date of the latest post in this thread.

Returns:

the date/time of the latest post

See Also:

• setLastUpdatedOn(Instant)

getReportCount

public int getReportCount()

Returns the number of times this post has been reported for content.

Returns:

the number of reports, or -1 if no further reports can be made

See Also:

• setReportCount(int)

getStickyUntil

public Instant getStickyUntil()

Returns the date/time this thread will be "stuck" at the top of the thread list until.

Returns:

the date/time the post will be a sticky until

See Also:

• setStickyUntil(Instant)

getStickyInChannelOnly

public boolean getStickyInChannelOnly()

Returns if this thread should be considered a "sticky" thread in its Channel only.

Returns:

TRUE if the thread is "sticky" and is sticky in the Channel, otherwise FALSE

getViews

public int getViews()

Returns the number of times this thread has been read.

Returns:

the number of views

See Also:

• setViews(int)

getPostCount

public int getPostCount()

Returns the number of messages in this thread.

Returns:

the number of posts

See Also:

• setPostCount(int)

getImage

public int getImage()

Returns the linked image ID for this thread.

Returns:

the linked Image ID

See Also:

• setImage(int)

getSubject

public String getSubject()

Returns the thread's subject.

Returns:

the subject

getHidden

public boolean getHidden()

Returns if this thread is hidden to general users.

Returns:

TRUE if the thread is hidden, otherwise FALSE

See Also:

• setHidden(boolean)
• getLocked()

getLocked

public boolean getLocked()

Returns if this thread is locked (no new posts allowed).

Returns:

TRUE if the thread is locked, otherwise FALSE

See Also:

• setLocked(boolean)
• getHidden()

getPoll

public boolean getPoll()

Returns if this thread has a poll.

Returns:

TRUE if there is a poll, otherwise FALSE

See Also:

• getOptions()
• setPoll(boolean)

getHasDisabledLinks

public boolean getHasDisabledLinks()

Returns whether this thread has any disabled Image Links.

Returns:

TRUE if any links are disabled, otherwise FALSE

getOptions

public Collection<PollOption> getOptions()

Returns all poll options for this Message Thread.

Returns:

a Collection of PollOption beans

See Also:

• addOptions(Collection)
• getVotes()

getVotes

public Collection<PollVote> getVotes()

Returns all poll votes for this Message Thread.

Returns:

a Collection of PollVote beans

See Also:

• addVotes(Collection)
• getOptions()

getImageURLs

public Collection<LinkedImage> getImageURLs()

Returns all linked Image URLs for this Message Thread.

Returns:

a Collection of LinkedImages

See Also:

• addImageURL(String, String)

getReportIDs

public Collection<Integer> getReportIDs()

Returns the database IDs of all users reporting this thread for content.

Returns:

a Collection of database IDs

See Also:

• getReportCount()

hasVoted

public boolean hasVoted(int pilotID)

Returns whether a Pilot has voted in a particular Water Cooler poll.

Parameters:

pilotID - the Pilot's database ID

Returns:

TRUE if the Pilot has voted, otherwise FALSE

setChannel

public void setChannel(String channelName)

Updates this thread's Channel.

Parameters:

channelName - the name of the channel

Throws:

NullPointerException - if channelName is null

See Also:

• getChannel()
• Channel

setAuthorID

public void setAuthorID(int id)

Updates the database ID of the first Person to post to this thread.

Specified by:

setAuthorID in interface AuthoredBean

Parameters:

id - the database ID

Throws:

IllegalArgumentException - if the ID is invalid

See Also:

• getAuthorID()
• setLastUpdateID(int)

setLastUpdateID

public void setLastUpdateID(int id)

Updates the database ID of the last Person to post to this thread.

Parameters:

id - the database ID

Throws:

IllegalArgumentException - if the ID is invalid

See Also:

• getLastUpdateID()
• setAuthorID(int)

setLastUpdatedOn

public void setLastUpdatedOn(Instant dt)

Updates the date this thread's latest message was posted.

Parameters:

dt - the date/time the last message was posted

setStickyUntil

public void setStickyUntil(Instant dt)

Updates the date/time this thread will be a "sticky" until.

Parameters:

dt - the date/time

See Also:

• getStickyUntil()

setStickyInChannelOnly

public void setStickyInChannelOnly(boolean isSticky)

Updates whether the thread will be sticky in the current channel only.

Parameters:

isSticky - TRUE if the thread is stick in the current channel, otherwise FALSE

See Also:

• getStickyInChannelOnly()

setReportCount

public void setReportCount(int count)

Updates the thread's content report count.

Parameters:

count - the number of times it has been reported, or -1 if no reports allowed

See Also:

• getReportCount()

setHidden

public void setHidden(boolean hidden)

Sets this thread's hidden flag.

Parameters:

hidden - TRUE if the thread is hidden, otherwise FALSE

See Also:

• getHidden()

setLocked

public void setLocked(boolean locked)

Sets this thread's locked flag.

Parameters:

locked - TRUE if the thread is locked, otherwise FALSE

See Also:

• getLocked()

setPoll

public void setPoll(boolean poll)

Sets this thread's poll flag.

Parameters:

poll - TRUE if the thread has a poll, otherwise FALSE

See Also:

• getPoll()

setImage

public void setImage(int id)

Updates the linked image for this thread.

Parameters:

id - the linked image database ID

See Also:

• getImage()

setViews

public void setViews(int views)

Updates the number of times this thread has been read.

Parameters:

views - the number of views

Throws:

IllegalArgumentException - if views is negative

See Also:

• getViews()

view

public void view()

Increments the view counter.

setPostCount

public void setPostCount(int posts)

Updates the number of messages in this thread.

Parameters:

posts - the number of messages

Throws:

IllegalArgumentException - if posts is negative

IllegalStateException - if a message has been added via addPost()

See Also:

• getPostCount()
• addPost(Message)

addPost

public void addPost(Message msg)

Adds a message to this thread.

Parameters:

msg - the message to add

Throws:

NullPointerException - if msg is null

See Also:

• getPosts()
• getPostCount()

addUpdate

public void addUpdate(ThreadUpdate upd)

Adds a thread update entry to this thread.

Parameters:

upd - the update entry bean

See Also:

• getUpdates()

addReportID

public void addReportID(int id)

Adds a database ID to the list of users reporting a thread for content.

Parameters:

id - the database ID

See Also:

• getReportCount()
• getReportIDs()

addOptions

public void addOptions(Collection<PollOption> opts)

Adds poll options to this thread.

Parameters:

opts - a Colllection of PollOption beans

See Also:

• addOption(PollOption)
• getOptions()
• addVotes(Collection)

addImageURL

public void addImageURL(String url,
 String desc)

Adds a URL to the list of linked Image URLs for this Message Thread.

Parameters:

url - the image URL

desc - the image description

See Also:

• addImageURL(LinkedImage)
• getImageURLs()

addImageURL

public void addImageURL(LinkedImage img)

Adds a URL to the list of linked Image URLs for this Message Thread.

Parameters:

img - the LinkedImage bean

See Also:

• addImageURL(String, String)
• getImageURLs()

addOption

public void addOption(PollOption opt)

Adds a single poll option to this thread.

Parameters:

opt - the PollOption bean

See Also:

• addOptions(Collection)
• getOptions()
• addVotes(Collection)

addVotes

public void addVotes(Collection<PollVote> votes)

Adds poll votes to this thread.

Parameters:

votes - a Collection of PollVote beans

See Also:

• getVotes()
• addOptions(Collection)

getPosts

public List<Message> getPosts()

Returns this thread's messages.

Returns:

a List of posts, or an empty list if no messages have been added

See Also:

• getPostCount()
• getLastPost()
• addPost(Message)

getUpdates

public Collection<ThreadUpdate> getUpdates()

Returns this thread's update history

Returns:

a Collection of ThreadUpdate beans

See Also:

• addUpdate(ThreadUpdate)

getLastPost

public Message getLastPost()

Returns the last post in a message thread.

Returns:

the last post, or null if no messages have been added.

See Also:

• getPosts()
• getLastPost()
• addPost(Message)

compareTo

public int compareTo(Object o2)

Compares to another thread via the last updated on date.

Specified by:

compareTo in interface Comparable<Object>

Overrides:

compareTo in class DatabaseBean

getRowClassName

public String getRowClassName()

Selects a table row class based upon whether the thread is hidden or not.

Specified by:

getRowClassName in interface ViewEntry

Returns:

the row CSS class name