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

Class CreateTopicParameter

java.lang.Object

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

public class CreateTopicParameter
extends Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAlias() Returns the Alias.
Boolean	getAllCanRead() Returns the AllCanRead.
Boolean	getAllCanWrite() Returns the AllCanWrite.
Integer	getCheckAtLeastMoreResults() Returns the CheckAtLeastMoreResults.
String	getDescription() Returns the Description.
ExternalObjectResource[]	getExternalObjects() Returns the ExternalObjects.
Integer	getMaxCount() Returns the MaxCount.
Integer	getOffset() Returns the Offset.
PropertyResource[]	getProperties() Returns the Properties.
RoleExternalResource[]	getRoleExternals() Returns the RoleExternals.
RoleResource[]	getRoles() Returns the Roles.
TagResource[]	getTags() Returns the Tags.
String	getTitle() Returns the Title.
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	setCheckAtLeastMoreResults(Integer checkAtLeastMoreResults) Sets CheckAtLeastMoreResults.
void	setDescription(String description) Sets Description.
void	setExternalObjects(ExternalObjectResource[] externalObjects) Sets ExternalObjects.
void	setMaxCount(Integer maxCount) Sets MaxCount.
void	setOffset(Integer offset) Sets Offset.
void	setProperties(PropertyResource[] properties) Sets Properties.
void	setRoleExternals(RoleExternalResource[] roleExternals) Sets RoleExternals.
void	setRoles(RoleResource[] roles) Sets Roles.
void	setTags(TagResource[] tags) Sets Tags.
void	setTitle(String title) Sets Title.
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

CreateTopicParameter

public CreateTopicParameter()

Default Constuctor necessary for json parsing

CreateTopicParameter

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

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

Throws:

RestApiIllegalRequestParameterException

CreateTopicParameter

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

Throws:

org.codehaus.jackson.JsonParseException

org.codehaus.jackson.map.JsonMappingException

IOException

Method Detail

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

setExternalObjects

public void setExternalObjects(ExternalObjectResource[] externalObjects)

Sets ExternalObjects.

Parameters:

externalObjects -

getExternalObjects

public ExternalObjectResource[] getExternalObjects()

Returns the ExternalObjects.

Returns:

the ExternalObjects

setRoleExternals

public void setRoleExternals(RoleExternalResource[] roleExternals)

Sets RoleExternals.

Parameters:

roleExternals -

getRoleExternals

public RoleExternalResource[] getRoleExternals()

Returns the RoleExternals.

Returns:

the RoleExternals

setRoles

public void setRoles(RoleResource[] roles)

Sets Roles.

Parameters:

roles -

getRoles

public RoleResource[] getRoles()

Returns the Roles.

Returns:

the Roles

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

setOffset

public void setOffset(Integer offset)

Sets Offset.

Parameters:

offset -

getOffset

public Integer getOffset()

Returns the Offset.

Returns:

the Offset

setMaxCount

public void setMaxCount(Integer maxCount)

Sets MaxCount.

Parameters:

maxCount -

getMaxCount

public Integer getMaxCount()

Returns the MaxCount.

Returns:

the MaxCount

setCheckAtLeastMoreResults

public void setCheckAtLeastMoreResults(Integer checkAtLeastMoreResults)

Sets CheckAtLeastMoreResults.

Parameters:

checkAtLeastMoreResults -

getCheckAtLeastMoreResults

public Integer getCheckAtLeastMoreResults()

Returns the CheckAtLeastMoreResults.

Returns:

the CheckAtLeastMoreResults

handleUnknownProperties

public void handleUnknownProperties(String key,
                                    Object value)

Log unknown properties to loglevel warn.