Package org.deltava.beans.cooler

Class Channel

java.lang.Object

org.deltava.beans.cooler.Channel

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Channel>, Auditable, ComboAlias, ViewEntry, Cacheable

Direct Known Subclasses:

Channel.AllChannel

public class Channel
extends Object
implements Comparable<Channel>, Auditable, Cacheable, ComboAlias, ViewEntry

A class containing Water Cooler channel data.

Since:

1.0

Version:

11.0

Author:

Luke

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	Channel.AllChannel
static enum	Channel.InfoType	Subdata enumeration.

Field Summary

Fields

Modifier and Type	Field	Description
static final Channel	ALL
static final Channel	SHOTS

Constructor Summary

Constructors

Constructor	Description
Channel(String name)	Creates a new Channel object with a given Channel name.

Method Summary

Modifier and Type	Method	Description
void	addAirline(String aCode)	Add an Airline to the list of enabled airlines.
void	addRole(Channel.InfoType type, String roleName)	Add a security role to this Channel.
Object	cacheKey()	Returns the cache key for this object.
int	compareTo(Channel c2)
boolean	equals(Object o2)	Compares the channel to another object.
boolean	getActive()	Queries if the Channel is active.
Collection<String>	getAirlines()	Returns the airlines associated with this Channel.
boolean	getAllowNewPosts()	Queries if new Threads or Replies are allowed.
String	getAuditID()	Returns the object ID for this auditable object.
String	getComboAlias()	Returns the alias to use in the HTML <OPTION> element.
String	getComboName()	Returns the visible name to use in the HTML <OPTION> element.
String	getDescription()	Returns the Channel description.
String	getLastSubject()	Returns the title of the latest post in this Channel.
int	getLastThreadID()	Returns ID of the last Message Thread in this Channel.
String	getName()	Returns the Channel name.
Collection<String>	getNotifyRoles()	Returns the roles notified when a new post is created in this Channel.
int	getPostCount()	Returns the number of posts in this Channel.
Collection<String>	getReadRoles()	Returns the roles authorized to access this Channel.
String	getRowClassName()	Returns the CSS class for this object if rendered in a view table.
int	getThreadCount()	Returns the total number of message threads in this Channel.
int	getViewCount()	Returns the total number of thread views for Threads in this Channel.
Collection<String>	getWriteRoles()	Returns the roles authorized to post in this Channel.
boolean	hasAirline(String aCode)	Queries if the Channel supports a particular airline.
int	hashCode()
void	setActive(boolean active)	Set the channel active/inactive.
void	setAirlines(Collection<String> aCodes)	Updates the enabled airlines.
void	setAllowNewPosts(boolean allow)	Updates whether new Threads or Replies are allowed.
void	setDescription(String desc)	Update the Channel description.
void	setLastSubject(String subj)	Updates the last subject posted to in this Channel.
void	setLastThreadID(int id)	Updates the ID of the last Message Thread in this Channel.
void	setPostCount(int count)	Updates the number of posts in this Channel.
void	setRoles(Channel.InfoType type, Collection<String> roles)	Updates the security roles for this Channel.
void	setThreadCount(int count)	Updates the number of Message Threads in this Channel.
void	setViewCount(int count)	Updates the number of times all Threads in this Channel have been viewed.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.deltava.beans.Auditable

getAuditType, isCrossApp

Field Details

ALL

public static final Channel ALL

SHOTS

public static final Channel SHOTS

Constructor Details

Channel

public Channel(String name)

Creates a new Channel object with a given Channel name.

Parameters:

name - the Channel name

Throws:

NullPointerException - if name is null

See Also:

• getName()

Method Details

getName

public String getName()

Returns the Channel name.

Returns:

the channel name

getComboName

public String getComboName()

Description copied from interface: ComboAlias

Returns the visible name to use in the HTML <OPTION> element.

Specified by:

getComboName in interface ComboAlias

Returns:

The visible name for this entry

getComboAlias

public String getComboAlias()

Description copied from interface: ComboAlias

Returns the alias to use in the HTML <OPTION> element.

Specified by:

getComboAlias in interface ComboAlias

Returns:

The alias for this entry

getDescription

public String getDescription()

Returns the Channel description.

Returns:

the channel description

See Also:

• setDescription(String)

getReadRoles

public Collection<String> getReadRoles()

Returns the roles authorized to access this Channel.

Returns:

a Collection of roles authorized to view this Channel

See Also:

• addRole(InfoType, String)

getWriteRoles

public Collection<String> getWriteRoles()

Returns the roles authorized to post in this Channel.

Returns:

a Collection of roles authorized to view this Channel

See Also:

• addRole(InfoType, String)

getNotifyRoles

public Collection<String> getNotifyRoles()

Returns the roles notified when a new post is created in this Channel.

Returns:

a Collection of roles

See Also:

• addRole(InfoType, String)

getViewCount

public int getViewCount()

Returns the total number of thread views for Threads in this Channel.

Returns:

the number of views

See Also:

• setViewCount(int)

getThreadCount

public int getThreadCount()

Returns the total number of message threads in this Channel.

Returns:

the number of threads

See Also:

• setThreadCount(int)

getPostCount

public int getPostCount()

Returns the number of posts in this Channel.

Returns:

the number of posts

See Also:

• setPostCount(int)

getAirlines

public Collection<String> getAirlines()

Returns the airlines associated with this Channel.

Returns:

a sorted Set of Airline codes for this Channel

See Also:

• addAirline(String)

getLastSubject

public String getLastSubject()

Returns the title of the latest post in this Channel.

Returns:

the post title

See Also:

• getLastSubject()

getLastThreadID

public int getLastThreadID()

Returns ID of the last Message Thread in this Channel.

Returns:

the database ID of the latest post

See Also:

• setLastThreadID(int)

getActive

public boolean getActive()

Queries if the Channel is active.

Returns:

TRUE if the Channel is active, otherwise FALSE

See Also:

• setActive(boolean)

getAllowNewPosts

public boolean getAllowNewPosts()

Queries if new Threads or Replies are allowed.

Returns:

TRUE if new threads/replies are allowed, otherwise FALSE

See Also:

• setAllowNewPosts(boolean)

hasAirline

public boolean hasAirline(String aCode)

Queries if the Channel supports a particular airline.

Parameters:

aCode - the Airline Code

Returns:

TRUE if the Channel is supported by an airline, FALSE otherwisse

See Also:

• Airline
• addAirline(String)

addAirline

public void addAirline(String aCode)

Add an Airline to the list of enabled airlines.

Parameters:

aCode - the Airline code to add

Throws:

NullPointerException - if the airline code is null

See Also:

• Airline
• getAirlines()
• hasAirline(String)

setAirlines

public void setAirlines(Collection<String> aCodes)

Updates the enabled airlines.

Parameters:

aCodes - the Airline codes to enable

Throws:

NullPointerException - if aCodes is null

See Also:

• getAirlines()
• hasAirline(String)

addRole

public void addRole(Channel.InfoType type,
 String roleName)

Add a security role to this Channel.

Parameters:

type - the role type

roleName - the name of the role to add to this Channel's access list

See Also:

• setRoles(InfoType, Collection)
• getReadRoles()
• getWriteRoles()
• getNotifyRoles()

setRoles

public void setRoles(Channel.InfoType type,
 Collection<String> roles)

Updates the security roles for this Channel.

Parameters:

type - the role type

roles - the roles to add to this Channel's access list

See Also:

• getReadRoles()
• getWriteRoles()
• addRole(InfoType, String)

setDescription

public void setDescription(String desc)

Update the Channel description.

Parameters:

desc - the Channel description

See Also:

• getDescription()

setActive

public void setActive(boolean active)

Set the channel active/inactive.

Parameters:

active - TRUE if the Channel is active, otherwise FALSE

See Also:

• getActive()

setAllowNewPosts

public void setAllowNewPosts(boolean allow)

Updates whether new Threads or Replies are allowed.

Parameters:

allow - TRUE if new posts allowed, otherwise FALSE

See Also:

• getAllowNewPosts()

setLastSubject

public void setLastSubject(String subj)

Updates the last subject posted to in this Channel.

Parameters:

subj - the thread subject

See Also:

• getLastSubject()

setLastThreadID

public void setLastThreadID(int id)

Updates the ID of the last Message Thread in this Channel.

Parameters:

id - the database ID

Throws:

IllegalArgumentException - if id is negative

See Also:

• getLastThreadID()

setThreadCount

public void setThreadCount(int count)

Updates the number of Message Threads in this Channel.

Parameters:

count - the number of threads

See Also:

• getThreadCount()

setPostCount

public void setPostCount(int count)

Updates the number of posts in this Channel.

Parameters:

count - the number of posts

See Also:

• getPostCount()

setViewCount

public void setViewCount(int count)

Updates the number of times all Threads in this Channel have been viewed.

Parameters:

count - the number of thread views

See Also:

• getThreadCount()

toString

public String toString()

Overrides:

toString in class Object

cacheKey

public Object cacheKey()

Description copied from interface: Cacheable

Returns the cache key for this object. Caches call this method when adding the object.

Specified by:

cacheKey in interface Cacheable

Returns:

the cache key for the object

equals

public boolean equals(Object o2)

Compares the channel to another object.

Overrides:

equals in class Object

Returns:

TRUE if o2 is a channel with the same name, or a String with the same name

hashCode

public int hashCode()

Overrides:

hashCode in class Object

compareTo

public int compareTo(Channel c2)

Specified by:

compareTo in interface Comparable<Channel>

getRowClassName

public String getRowClassName()

Description copied from interface: ViewEntry

Returns the CSS class for this object if rendered in a view table.

Specified by:

getRowClassName in interface ViewEntry

Returns:

the CSS class name, or NULL if none

getAuditID

public String getAuditID()

Description copied from interface: Auditable

Returns the object ID for this auditable object.

Specified by:

getAuditID in interface Auditable

Returns:

the ID