com.communote.plugins.api.rest.v24.resource.note

Class EditNoteParameter

java.lang.Object

com.communote.plugins.api.rest.v24.resource.note.EditNoteParameter

public class EditNoteParameter
extends Object

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Long[]	getAttachmentIds() Returns the AttachmentIds.
String	getAttachmentUploadSessionId() Returns the AttachmentUploadSessionId.
Long	getAutosaveNoteId() Returns the AutosaveNoteId.
String[]	getCrossPostTopicAliases() Returns the CrossPostTopicAliases.
Boolean	getIsHtml() Returns the IsHtml.
Integer	getMaxTextLength() Returns the MaxTextLength.
Long	getNoteId() Returns the NoteId.
Long	getNoteVersion() Returns the NoteVersion.
PropertyResource[]	getProperties() Returns the Properties.
Boolean	getPublish() Returns the Publish.
TagResource[]	getTags() Returns the Tags.
String	getText() Returns the Text.
Long	getTopicId() Returns the TopicId.
String[]	getUsersToNotify() Returns the UsersToNotify.
void	handleUnknownProperties(String key, Object value) Log unknown properties to loglevel warn.
void	setAttachmentIds(Long[] attachmentIds) Sets AttachmentIds.
void	setAttachmentUploadSessionId(String attachmentUploadSessionId) Sets AttachmentUploadSessionId.
void	setAutosaveNoteId(Long autosaveNoteId) Sets AutosaveNoteId.
void	setCrossPostTopicAliases(String[] crossPostTopicAliases) Sets CrossPostTopicAliases.
void	setIsHtml(Boolean isHtml) Sets IsHtml.
void	setMaxTextLength(Integer maxTextLength) Sets MaxTextLength.
void	setNoteId(Long noteId) Sets NoteId.
void	setNoteVersion(Long noteVersion) Sets NoteVersion.
void	setProperties(PropertyResource[] properties) Sets Properties.
void	setPublish(Boolean publish) Sets Publish.
void	setTags(TagResource[] tags) Sets Tags.
void	setText(String text) Sets Text.
void	setTopicId(Long topicId) Sets TopicId.
void	setUsersToNotify(String[] usersToNotify) Sets UsersToNotify.

Methods inherited from class java.lang.Object

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

Constructor Detail

EditNoteParameter

public EditNoteParameter()

Default Constuctor necessary for json parsing

EditNoteParameter

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

EditNoteParameter

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

setTags

public void setTags(TagResource[] tags)

Sets Tags.

Parameters:

tags -

getTags

public TagResource[] getTags()

Returns the Tags.

Returns:

the Tags

setUsersToNotify

public void setUsersToNotify(String[] usersToNotify)

Sets UsersToNotify.

Parameters:

usersToNotify -

getUsersToNotify

public String[] getUsersToNotify()

Returns the UsersToNotify.

Returns:

the UsersToNotify

setTopicId

public void setTopicId(Long topicId)

Sets TopicId.

Parameters:

topicId -

getTopicId

public Long getTopicId()

Returns the TopicId.

Returns:

the TopicId

setAttachmentIds

public void setAttachmentIds(Long[] attachmentIds)

Sets AttachmentIds.

Parameters:

attachmentIds -

getAttachmentIds

public Long[] getAttachmentIds()

Returns the AttachmentIds.

Returns:

the AttachmentIds

setProperties

public void setProperties(PropertyResource[] properties)

Sets Properties.

Parameters:

properties -

getProperties

public PropertyResource[] getProperties()

Returns the Properties.

Returns:

the Properties

setNoteVersion

public void setNoteVersion(Long noteVersion)

Sets NoteVersion.

Parameters:

noteVersion -

getNoteVersion

public Long getNoteVersion()

Returns the NoteVersion.

Returns:

the NoteVersion

setIsHtml

public void setIsHtml(Boolean isHtml)

Sets IsHtml.

Parameters:

isHtml -

getIsHtml

public Boolean getIsHtml()

Returns the IsHtml.

Returns:

the IsHtml

setMaxTextLength

public void setMaxTextLength(Integer maxTextLength)

Sets MaxTextLength.

Parameters:

maxTextLength -

getMaxTextLength

public Integer getMaxTextLength()

Returns the MaxTextLength.

Returns:

the MaxTextLength

setPublish

public void setPublish(Boolean publish)

Sets Publish.

Parameters:

publish -

getPublish

public Boolean getPublish()

Returns the Publish.

Returns:

the Publish

setAutosaveNoteId

public void setAutosaveNoteId(Long autosaveNoteId)

Sets AutosaveNoteId.

Parameters:

autosaveNoteId -

getAutosaveNoteId

public Long getAutosaveNoteId()

Returns the AutosaveNoteId.

Returns:

the AutosaveNoteId

setCrossPostTopicAliases

public void setCrossPostTopicAliases(String[] crossPostTopicAliases)

Sets CrossPostTopicAliases.

Parameters:

crossPostTopicAliases -

getCrossPostTopicAliases

public String[] getCrossPostTopicAliases()

Returns the CrossPostTopicAliases.

Returns:

the CrossPostTopicAliases

setAttachmentUploadSessionId

public void setAttachmentUploadSessionId(String attachmentUploadSessionId)

Sets AttachmentUploadSessionId.

Parameters:

attachmentUploadSessionId -

getAttachmentUploadSessionId

public String getAttachmentUploadSessionId()

Returns the AttachmentUploadSessionId.

Returns:

the AttachmentUploadSessionId

handleUnknownProperties

public void handleUnknownProperties(String key,
                                    Object value)

Log unknown properties to loglevel warn.