org.sakaiproject.chat2.model

Class ChatChannel

java.lang.Object

org.sakaiproject.chat2.model.ChatChannel

All Implemented Interfaces:

Entity

@Entity
public class ChatChannel
extends Object
implements Entity

Nested Class Summary

Nested classes/interfaces inherited from interface org.sakaiproject.entity.api.Entity

Entity.UrlType

Field Summary

Fields

Modifier and Type	Field and Description
static String	FILTER_ALL
static String	FILTER_BY_NUMBER Message filter names
static String	FILTER_BY_TIME
static String	FILTER_NONE
static String	FILTER_TODAY

Fields inherited from interface org.sakaiproject.entity.api.Entity

SEPARATOR

Constructor Summary

Constructors

Constructor and Description
ChatChannel(ChatChannel defaults) Set up a new ChatChannel with the set defaults

Method Summary

Modifier and Type	Method and Description
ResourceProperties	getProperties()
String	getReference()
String	getReference(String rootProperty)
String	getUrl()
String	getUrl(String rootProperty)
Element	toXml(Document doc, Stack stack) Serialize the resource into XML, adding an element to the doc under the top of the stack element.
static ChatChannel	xmlToChatChannel(Element channelElement, String siteId) Converts the serialized xml back to a ChatChannel object

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.sakaiproject.entity.api.Entity

getId

Field Detail

FILTER_BY_NUMBER

public static final String FILTER_BY_NUMBER

Message filter names

See Also:

Constant Field Values

FILTER_BY_TIME

public static final String FILTER_BY_TIME

See Also:

Constant Field Values

FILTER_TODAY

public static final String FILTER_TODAY

See Also:

Constant Field Values

FILTER_ALL

public static final String FILTER_ALL

See Also:

Constant Field Values

FILTER_NONE

public static final String FILTER_NONE

See Also:

Constant Field Values

Constructor Detail

ChatChannel

public ChatChannel(ChatChannel defaults)

Set up a new ChatChannel with the set defaults

Parameters:

defaults -

Method Detail

toXml

public Element toXml(Document doc,
                     Stack stack)

Serialize the resource into XML, adding an element to the doc under the top of the stack element.

Specified by:

toXml in interface Entity

Parameters:

doc - The DOM doc to contain the XML (or null for a string return).

stack - The DOM elements, the top of which is the containing element of the new "resource" element.

Returns:

The newly added element.

xmlToChatChannel

public static ChatChannel xmlToChatChannel(Element channelElement,
                                           String siteId)

Converts the serialized xml back to a ChatChannel object

Parameters:

channelElement -

Returns:

the Channel

getProperties

public ResourceProperties getProperties()

Specified by:

getProperties in interface Entity

getReference

public String getReference()

Specified by:

getReference in interface Entity

getReference

public String getReference(String rootProperty)

Specified by:

getReference in interface Entity

getUrl

public String getUrl()

Specified by:

getUrl in interface Entity

getUrl

public String getUrl(String rootProperty)

Specified by:

getUrl in interface Entity