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

Class GetTopicParameter

java.lang.Object

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

public class GetTopicParameter
extends Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getAlias() Returns the Alias.
String	getBannerImageId() Returns the BannerImageId.
String	getBannerImageVersion() Returns the BannerImageVersion.
ChildTopicResource[]	getChildren() Returns the Children.
Date	getCrawlLastModificationDate() Returns the CrawlLastModificationDate.
Boolean	getCreateSystemNotes() Returns the CreateSystemNotes.
String	getDescription() Returns the Description.
Boolean	getIsFollow() Returns the IsFollow.
Date	getLastBannerImageModificationDate() Returns the LastBannerImageModificationDate.
Date	getLastModificationDate() Returns the LastModificationDate.
Date	getLastProfileImageModificationDate() Returns the LastProfileImageModificationDate.
String	getProfileImageId() Returns the ProfileImageId.
String	getProfileImageVersion() Returns the ProfileImageVersion.
TagResource[]	getTags() Returns the Tags.
String	getTitle() Returns the Title.
String	getTopicEmail() Returns the TopicEmail.
String	getTopicId() Returns the TopicId.
ETopicIdentifier	getTopicIdentifier() Returns the constant TopicIdentifier.
String	getUserRole() Returns the UserRole.
void	handleUnknownProperties(String key, Object value) Log unknown properties to loglevel warn.
void	setAlias(String alias) Sets Alias.
void	setBannerImageId(String bannerImageId) Sets BannerImageId.
void	setBannerImageVersion(String bannerImageVersion) Sets BannerImageVersion.
void	setChildren(ChildTopicResource[] children) Sets Children.
void	setCrawlLastModificationDate(Date crawlLastModificationDate) Sets CrawlLastModificationDate.
void	setCreateSystemNotes(Boolean createSystemNotes) Sets CreateSystemNotes.
void	setDescription(String description) Sets Description.
void	setIsFollow(Boolean isFollow) Sets IsFollow.
void	setLastBannerImageModificationDate(Date lastBannerImageModificationDate) Sets LastBannerImageModificationDate.
void	setLastModificationDate(Date lastModificationDate) Sets LastModificationDate.
void	setLastProfileImageModificationDate(Date lastProfileImageModificationDate) Sets LastProfileImageModificationDate.
void	setProfileImageId(String profileImageId) Sets ProfileImageId.
void	setProfileImageVersion(String profileImageVersion) Sets ProfileImageVersion.
void	setTags(TagResource[] tags) Sets Tags.
void	setTitle(String title) Sets Title.
void	setTopicEmail(String topicEmail) Sets TopicEmail.
void	setTopicId(String topicId) Sets TopicId.
void	setTopicIdentifier(ETopicIdentifier topicIdentifier) Sets the constant TopicIdentifier.
void	setUserRole(String userRole) Sets UserRole.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetTopicParameter

public GetTopicParameter()

Default Constuctor necessary for json parsing

GetTopicParameter

public GetTopicParameter(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

GetTopicParameter

public GetTopicParameter(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

setChildren

public void setChildren(ChildTopicResource[] children)

Sets Children.

Parameters:

children -

getChildren

public ChildTopicResource[] getChildren()

Returns the Children.

Returns:

the Children

setLastModificationDate

public void setLastModificationDate(Date lastModificationDate)

Sets LastModificationDate.

Parameters:

lastModificationDate -

getLastModificationDate

public Date getLastModificationDate()

Returns the LastModificationDate.

Returns:

the LastModificationDate

setTopicEmail

public void setTopicEmail(String topicEmail)

Sets TopicEmail.

Parameters:

topicEmail -

getTopicEmail

public String getTopicEmail()

Returns the TopicEmail.

Returns:

the TopicEmail

setCreateSystemNotes

public void setCreateSystemNotes(Boolean createSystemNotes)

Sets CreateSystemNotes.

Parameters:

createSystemNotes -

getCreateSystemNotes

public Boolean getCreateSystemNotes()

Returns the CreateSystemNotes.

Returns:

the CreateSystemNotes

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

setUserRole

public void setUserRole(String userRole)

Sets UserRole.

Parameters:

userRole -

getUserRole

public String getUserRole()

Returns the UserRole.

Returns:

the UserRole

setIsFollow

public void setIsFollow(Boolean isFollow)

Sets IsFollow.

Parameters:

isFollow -

getIsFollow

public Boolean getIsFollow()

Returns the IsFollow.

Returns:

the IsFollow

setProfileImageId

public void setProfileImageId(String profileImageId)

Sets ProfileImageId.

Parameters:

profileImageId -

getProfileImageId

public String getProfileImageId()

Returns the ProfileImageId.

Returns:

the ProfileImageId

setProfileImageVersion

public void setProfileImageVersion(String profileImageVersion)

Sets ProfileImageVersion.

Parameters:

profileImageVersion -

getProfileImageVersion

public String getProfileImageVersion()

Returns the ProfileImageVersion.

Returns:

the ProfileImageVersion

setLastProfileImageModificationDate

public void setLastProfileImageModificationDate(Date lastProfileImageModificationDate)

Sets LastProfileImageModificationDate.

Parameters:

lastProfileImageModificationDate -

getLastProfileImageModificationDate

public Date getLastProfileImageModificationDate()

Returns the LastProfileImageModificationDate.

Returns:

the LastProfileImageModificationDate

setBannerImageId

public void setBannerImageId(String bannerImageId)

Sets BannerImageId.

Parameters:

bannerImageId -

getBannerImageId

public String getBannerImageId()

Returns the BannerImageId.

Returns:

the BannerImageId

setBannerImageVersion

public void setBannerImageVersion(String bannerImageVersion)

Sets BannerImageVersion.

Parameters:

bannerImageVersion -

getBannerImageVersion

public String getBannerImageVersion()

Returns the BannerImageVersion.

Returns:

the BannerImageVersion

setLastBannerImageModificationDate

public void setLastBannerImageModificationDate(Date lastBannerImageModificationDate)

Sets LastBannerImageModificationDate.

Parameters:

lastBannerImageModificationDate -

getLastBannerImageModificationDate

public Date getLastBannerImageModificationDate()

Returns the LastBannerImageModificationDate.

Returns:

the LastBannerImageModificationDate

setCrawlLastModificationDate

public void setCrawlLastModificationDate(Date crawlLastModificationDate)

Sets CrawlLastModificationDate.

Parameters:

crawlLastModificationDate -

getCrawlLastModificationDate

public Date getCrawlLastModificationDate()

Returns the CrawlLastModificationDate.

Returns:

the CrawlLastModificationDate

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.