com.communote.plugins.api.rest.resource.topic

Class EditTopicParameter

java.lang.Object

com.communote.plugins.api.rest.resource.topic.EditTopicParameter

public class EditTopicParameter
extends Object

This class it the parameter class for the Topic resource. It covers all the parameter and attributes of the HTTP EDIT method.

Constructor Summary

Constructors

Constructor and Description
EditTopicParameter() Default Constuctor necessary for json parsing
EditTopicParameter(javax.ws.rs.core.MultivaluedMap<String,String> valueMap, String topicId) This constructor parses all incoming parameter of a request into the class structure
EditTopicParameter(String representation, String topicId)

Method Summary

Modifier and Type	Method and Description
String	getAlias() Returns the Alias.
Boolean	getAllCanRead() Returns the AllCanRead.
Boolean	getAllCanWrite() Returns the AllCanWrite.
String	getDescription() Returns the Description.
PropertyResource[]	getProperties() Returns the Properties.
TagResource[]	getTags() Returns the Tags.
String	getTitle() Returns the Title.
String	getTopicId() Returns the TopicId.
ETopicIdentifier	getTopicIdentifier() Returns the constant TopicIdentifier.
void	handleUnknownProperties(String key, Object value) Log unknown properties to loglevel warn.
void	setAlias(String alias) Sets Alias.
void	setAllCanRead(Boolean allCanRead) Sets AllCanRead.
void	setAllCanWrite(Boolean allCanWrite) Sets AllCanWrite.
void	setDescription(String description) Sets Description.
void	setProperties(PropertyResource[] properties) Sets Properties.
void	setTags(TagResource[] tags) Sets Tags.
void	setTitle(String title) Sets Title.
void	setTopicId(String topicId) Sets TopicId.
void	setTopicIdentifier(ETopicIdentifier topicIdentifier) Sets the constant TopicIdentifier.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditTopicParameter

public EditTopicParameter()

Default Constuctor necessary for json parsing

EditTopicParameter

public EditTopicParameter(javax.ws.rs.core.MultivaluedMap<String,String> valueMap,
                          String topicId)
                   throws RestApiIllegalRequestParameterException

This constructor parses all incoming parameter of a request into the class structure

Throws:

RestApiIllegalRequestParameterException

EditTopicParameter

public EditTopicParameter(String representation,
                          String topicId)
                   throws org.codehaus.jackson.JsonParseException,
                          org.codehaus.jackson.map.JsonMappingException,
                          IOException

Throws:

org.codehaus.jackson.JsonParseException

org.codehaus.jackson.map.JsonMappingException

IOException

Method Detail

setTopicId

public void setTopicId(String topicId)

Sets TopicId.

Parameters:

topicId -

getTopicId

public String getTopicId()

Returns the TopicId.

Returns:

the TopicId

setDescription

public void setDescription(String description)

Sets Description.

Parameters:

description -

getDescription

public String getDescription()

Returns the Description.

Returns:

the Description

setTags

public void setTags(TagResource[] tags)

Sets Tags.

Parameters:

tags -

getTags

public TagResource[] getTags()

Returns the Tags.

Returns:

the Tags

setAlias

public void setAlias(String alias)

Sets Alias.

Parameters:

alias -

getAlias

public String getAlias()

Returns the Alias.

Returns:

the Alias

setTitle

public void setTitle(String title)

Sets Title.

Parameters:

title -

getTitle

public String getTitle()

Returns the Title.

Returns:

the Title

setProperties

public void setProperties(PropertyResource[] properties)

Sets Properties.

Parameters:

properties -

getProperties

public PropertyResource[] getProperties()

Returns the Properties.

Returns:

the Properties

setAllCanWrite

public void setAllCanWrite(Boolean allCanWrite)

Sets AllCanWrite.

Parameters:

allCanWrite -

getAllCanWrite

public Boolean getAllCanWrite()

Returns the AllCanWrite.

Returns:

the AllCanWrite

setAllCanRead

public void setAllCanRead(Boolean allCanRead)

Sets AllCanRead.

Parameters:

allCanRead -

getAllCanRead

public Boolean getAllCanRead()

Returns the AllCanRead.

Returns:

the AllCanRead

setTopicIdentifier

public void setTopicIdentifier(ETopicIdentifier topicIdentifier)

Sets the constant TopicIdentifier.

Parameters:

the - constant topicIdentifier

getTopicIdentifier

public ETopicIdentifier getTopicIdentifier()

Returns the constant TopicIdentifier.

Returns:

the constant TopicIdentifier

handleUnknownProperties

public void handleUnknownProperties(String key,
                                    Object value)

Log unknown properties to loglevel warn.