com.communote.server.api.core.blog

Class BlogTO

java.lang.Object

com.communote.server.api.core.blog.BlogTO

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

CreationBlogTO

public class BlogTO
extends Object
implements Serializable

Transfer object holding the details of a blog.

Author:

Communote GmbH - http://www.communote.com/

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BlogTO() Create a TO with default values.
BlogTO(boolean allCanRead, boolean allCanWrite, String title, boolean createSystemNotes) Create a new TO and set the provided members

Method Summary

Modifier and Type	Method and Description
void	copy(BlogTO otherBean) Copies all properties from the argument value object into this value object.
Long[]	getChildTopicIds()
Long	getCreatorUserId()
String	getDescription()
String	getNameIdentifier()
List<StringPropertyTO>	getProperties()
StringPropertyTO	getProperty(String keyGroup, String key) Find and return the property with matching values
Set<TagTO>	getTags()
String	getTitle()
String[]	getUnparsedTags()
boolean	isAllCanRead()
boolean	isAllCanWrite()
boolean	isCreateSystemNotes()
boolean	isToplevelTopic()
void	setAllCanRead(boolean allCanRead) Set whether all users are allowed to read the blog
void	setAllCanWrite(boolean allCanWrite) Set whether all users are allowed to write to the blog
void	setChildTopicIds(Long[] childTopicIds)
void	setCreateSystemNotes(boolean createSystemNotes) Set whether notes with creation source 'SYSTEM' can be created in the blog
void	setCreatorUserId(Long creatorUserId) Set the ID of the user that creates the blog, this user will be the manager of the blog.
void	setDescription(String description) Set the description of the blog.
void	setNameIdentifier(String nameIdentifier) Set the unique alias of the blog
void	setProperties(List<StringPropertyTO> properties) The properties of the blog
void	setTags(Set<TagTO> tags) Set the tags of the blog
void	setTitle(String title) Set the title of the blog
void	setToplevelTopic(boolean toplevelTopic) Set whether the topic is a top level topic
void	setUnparsedTags(String[] unparsedTags) Set the tags of the blog.

Methods inherited from class java.lang.Object

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

Constructor Detail

BlogTO

public BlogTO()

Create a TO with default values.

BlogTO

public BlogTO(boolean allCanRead,
              boolean allCanWrite,
              String title,
              boolean createSystemNotes)

Create a new TO and set the provided members

Parameters:

allCanRead - true if all users are allowed to read, false otherwise

allCanWrite - true if all users are allowed to write, false otherwise

title - the title of the blog

createSystemNotes - whether notes with creation source 'SYSTEM' can be created in the blog

Method Detail

copy

public void copy(BlogTO otherBean)

Copies all properties from the argument value object into this value object.

Parameters:

otherBean - the other object to copy from

getChildTopicIds

public Long[] getChildTopicIds()

Returns:

Array of id of child topics. This never returns null.

getCreatorUserId

public Long getCreatorUserId()

Returns:

the ID of the user that creates the blog, this user will be the manager of the blog. This member should be ignored when using the TO for updating an existing blog.

getDescription

public String getDescription()

Returns:

the description for the blog.

getNameIdentifier

public String getNameIdentifier()

Returns:

the unique alias of the blog.

getProperties

public List<StringPropertyTO> getProperties()

Returns:

the properties to add or added to the blog

getProperty

public StringPropertyTO getProperty(String keyGroup,
                                    String key)

Find and return the property with matching values

Parameters:

keyGroup - the key group

key - the key

Returns:

the property if found

getTags

public Set<TagTO> getTags()

Returns:

the tags of the blog as a collection of TOs describing the tags

getTitle

public String getTitle()

Returns:

the title of the blog

getUnparsedTags

public String[] getUnparsedTags()

Returns:

the tags of the blog as a an array of tag names

isAllCanRead

public boolean isAllCanRead()

Returns:

whether all users are allowed to read the blog

isAllCanWrite

public boolean isAllCanWrite()

Returns:

whether all users are allowed to write to the blog

isCreateSystemNotes

public boolean isCreateSystemNotes()

Returns:

whether notes with creation source 'SYSTEM' can be created in the blog

isToplevelTopic

public boolean isToplevelTopic()

Returns:

whether the topic is a top level topic

setAllCanRead

public void setAllCanRead(boolean allCanRead)

Set whether all users are allowed to read the blog

Parameters:

allCanRead - true if all users are allowed to read, false otherwise

setAllCanWrite

public void setAllCanWrite(boolean allCanWrite)

Set whether all users are allowed to write to the blog

Parameters:

allCanWrite - true if all users are allowed to write, false otherwise

setChildTopicIds

public void setChildTopicIds(Long[] childTopicIds)

Parameters:

childTopicIds - Array of child topic ids.

setCreateSystemNotes

public void setCreateSystemNotes(boolean createSystemNotes)

Set whether notes with creation source 'SYSTEM' can be created in the blog

Parameters:

createSystemNotes - true if the notes can be created, false otherwise

setCreatorUserId

public void setCreatorUserId(Long creatorUserId)

Set the ID of the user that creates the blog, this user will be the manager of the blog.

Parameters:

creatorUserId - the ID of the creator

setDescription

public void setDescription(String description)

Set the description of the blog.

Parameters:

description - a short description of the blog

setNameIdentifier

public void setNameIdentifier(String nameIdentifier)

Set the unique alias of the blog

Parameters:

nameIdentifier - the alias of the blog

setProperties

public void setProperties(List<StringPropertyTO> properties)

The properties of the blog

Parameters:

properties - the blog properties

setTags

public void setTags(Set<TagTO> tags)

Set the tags of the blog

Parameters:

tags - the tags as a collection of TOs describing the tags

setTitle

public void setTitle(String title)

Set the title of the blog

Parameters:

title - the blog title

setToplevelTopic

public void setToplevelTopic(boolean toplevelTopic)

Set whether the topic is a top level topic

Parameters:

toplevelTopic - true if the topic is a top level topic, otherwise false

setUnparsedTags

public void setUnparsedTags(String[] unparsedTags)

Set the tags of the blog.

Parameters:

unparsedTags - the tags as an array of tag names