com.communote.plugins.api.rest.resource.timelinenote

Class GetTimelineNoteParameter

java.lang.Object

com.communote.plugins.api.rest.resource.timelinenote.GetTimelineNoteParameter

public class GetTimelineNoteParameter
extends Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
AttachmentResource[]	getAttachments() Returns the Attachments.
TimelineUserResource	getAuthor() Returns the Author.
Date	getCreationDate() Returns the CreationDate.
TimelineNoteDiscussionResource	getDiscussion() Returns the Discussion.
Boolean	getFilterHtml() Returns the FilterHtml.
Boolean	getIsDirectMessage() Returns the IsDirectMessage.
Integer	getMaxTextLength() Returns the MaxTextLength.
Long	getNoteId() Returns the NoteId.
Integer	getNumberOfChildNotes() Returns the NumberOfChildNotes.
Integer	getNumberOfLikes() Returns the NumberOfLikes.
Long	getParentNoteId() Returns the ParentNoteId.
List<ERights>	getRights() Returns List of constants Rights.
String	getShortText() Returns the ShortText.
TimelineNoteTagResource[]	getTags() Returns the Tags.
String	getText() Returns the Text.
TimelineTopicResource	getTopic() Returns the Topic.
List<EUserNoteProperties>	getUserNoteProperties() Returns List of constants UserNoteProperties.
TimelineUserResource[]	getUsersToNotify() Returns the UsersToNotify.
void	handleUnknownProperties(String key, Object value) Log unknown properties to loglevel warn.
void	setAttachments(AttachmentResource[] attachments) Sets Attachments.
void	setAuthor(TimelineUserResource author) Sets Author.
void	setCreationDate(Date creationDate) Sets CreationDate.
void	setDiscussion(TimelineNoteDiscussionResource discussion) Sets Discussion.
void	setFilterHtml(Boolean filterHtml) Sets FilterHtml.
void	setIsDirectMessage(Boolean isDirectMessage) Sets IsDirectMessage.
void	setMaxTextLength(Integer maxTextLength) Sets MaxTextLength.
void	setNoteId(Long noteId) Sets NoteId.
void	setNumberOfChildNotes(Integer numberOfChildNotes) Sets NumberOfChildNotes.
void	setNumberOfLikes(Integer numberOfLikes) Sets NumberOfLikes.
void	setParentNoteId(Long parentNoteId) Sets ParentNoteId.
void	setRights(List<ERights> rights) List of constants Rights.
void	setShortText(String shortText) Sets ShortText.
void	setTags(TimelineNoteTagResource[] tags) Sets Tags.
void	setText(String text) Sets Text.
void	setTopic(TimelineTopicResource topic) Sets Topic.
void	setUserNoteProperties(List<EUserNoteProperties> userNoteProperties) List of constants UserNoteProperties.
void	setUsersToNotify(TimelineUserResource[] usersToNotify) Sets UsersToNotify.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetTimelineNoteParameter

public GetTimelineNoteParameter()

Default Constuctor necessary for json parsing

GetTimelineNoteParameter

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

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

Throws:

RestApiIllegalRequestParameterException

GetTimelineNoteParameter

public GetTimelineNoteParameter(String representation,
                                Long noteId)
                         throws org.codehaus.jackson.JsonParseException,
                                org.codehaus.jackson.map.JsonMappingException,
                                IOException

Throws:

org.codehaus.jackson.JsonParseException

org.codehaus.jackson.map.JsonMappingException

IOException

Method Detail

setNoteId

public void setNoteId(Long noteId)

Sets NoteId.

Parameters:

noteId -

getNoteId

public Long getNoteId()

Returns the NoteId.

Returns:

the NoteId

setText

public void setText(String text)

Sets Text.

Parameters:

text -

getText

public String getText()

Returns the Text.

Returns:

the Text

setShortText

public void setShortText(String shortText)

Sets ShortText.

Parameters:

shortText -

getShortText

public String getShortText()

Returns the ShortText.

Returns:

the ShortText

setCreationDate

public void setCreationDate(Date creationDate)

Sets CreationDate.

Parameters:

creationDate -

getCreationDate

public Date getCreationDate()

Returns the CreationDate.

Returns:

the CreationDate

setAuthor

public void setAuthor(TimelineUserResource author)

Sets Author.

Parameters:

author -

getAuthor

public TimelineUserResource getAuthor()

Returns the Author.

Returns:

the Author

setUsersToNotify

public void setUsersToNotify(TimelineUserResource[] usersToNotify)

Sets UsersToNotify.

Parameters:

usersToNotify -

getUsersToNotify

public TimelineUserResource[] getUsersToNotify()

Returns the UsersToNotify.

Returns:

the UsersToNotify

setNumberOfChildNotes

public void setNumberOfChildNotes(Integer numberOfChildNotes)

Sets NumberOfChildNotes.

Parameters:

numberOfChildNotes -

getNumberOfChildNotes

public Integer getNumberOfChildNotes()

Returns the NumberOfChildNotes.

Returns:

the NumberOfChildNotes

setTags

public void setTags(TimelineNoteTagResource[] tags)

Sets Tags.

Parameters:

tags -

getTags

public TimelineNoteTagResource[] getTags()

Returns the Tags.

Returns:

the Tags

setUserNoteProperties

public void setUserNoteProperties(List<EUserNoteProperties> userNoteProperties)

List of constants UserNoteProperties.

Parameters:

the - constants userNoteProperties

getUserNoteProperties

public List<EUserNoteProperties> getUserNoteProperties()

Returns List of constants UserNoteProperties.

Returns:

List of constants UserNoteProperties

setIsDirectMessage

public void setIsDirectMessage(Boolean isDirectMessage)

Sets IsDirectMessage.

Parameters:

isDirectMessage -

getIsDirectMessage

public Boolean getIsDirectMessage()

Returns the IsDirectMessage.

Returns:

the IsDirectMessage

setNumberOfLikes

public void setNumberOfLikes(Integer numberOfLikes)

Sets NumberOfLikes.

Parameters:

numberOfLikes -

getNumberOfLikes

public Integer getNumberOfLikes()

Returns the NumberOfLikes.

Returns:

the NumberOfLikes

setRights

public void setRights(List<ERights> rights)

List of constants Rights.

Parameters:

the - constants rights

getRights

public List<ERights> getRights()

Returns List of constants Rights.

Returns:

List of constants Rights

setAttachments

public void setAttachments(AttachmentResource[] attachments)

Sets Attachments.

Parameters:

attachments -

getAttachments

public AttachmentResource[] getAttachments()

Returns the Attachments.

Returns:

the Attachments

setTopic

public void setTopic(TimelineTopicResource topic)

Sets Topic.

Parameters:

topic -

getTopic

public TimelineTopicResource getTopic()

Returns the Topic.

Returns:

the Topic

setDiscussion

public void setDiscussion(TimelineNoteDiscussionResource discussion)

Sets Discussion.

Parameters:

discussion -

getDiscussion

public TimelineNoteDiscussionResource getDiscussion()

Returns the Discussion.

Returns:

the Discussion

setParentNoteId

public void setParentNoteId(Long parentNoteId)

Sets ParentNoteId.

Parameters:

parentNoteId -

getParentNoteId

public Long getParentNoteId()

Returns the ParentNoteId.

Returns:

the ParentNoteId

setFilterHtml

public void setFilterHtml(Boolean filterHtml)

Sets FilterHtml.

Parameters:

filterHtml -

getFilterHtml

public Boolean getFilterHtml()

Returns the FilterHtml.

Returns:

the FilterHtml

setMaxTextLength

public void setMaxTextLength(Integer maxTextLength)

Sets MaxTextLength.

Parameters:

maxTextLength -

getMaxTextLength

public Integer getMaxTextLength()

Returns the MaxTextLength.

Returns:

the MaxTextLength

handleUnknownProperties

public void handleUnknownProperties(String key,
                                    Object value)

Log unknown properties to loglevel warn.