GetNoteParameter (Communote 3.5 API)

java.lang.Object
- com.communote.plugins.api.rest.v30.resource.note.GetNoteParameter

```
public class GetNoteParameter
extends Object
```
This class it the parameter class for the Note resource. It covers all the parameter and attributes of the HTTP GET method.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long[]`	`getAttachmentIds()` Returns the AttachmentIds.
`AttachmentResource[]`	`getAttachments()` Returns the Attachments.
`Date`	`getCrawlLastModificationDate()` Returns the CrawlLastModificationDate.
`Date`	`getCreationDate()` Returns the CreationDate.
`Integer`	`getDiscussionDepth()` Returns the DiscussionDepth.
`Long`	`getDiscussionId()` Returns the DiscussionId.
`String`	`getDiscussionPath()` Returns the DiscussionPath.
`Boolean`	`getFilterHtml()` Returns the FilterHtml.
`String`	`getFirstName()` Returns the FirstName.
`String[]`	`getFollowedItems()` Returns the FollowedItems.
`Boolean`	`getIsDirectMessage()` Returns the IsDirectMessage.
`Boolean`	`getIsFavorite()` Returns the IsFavorite.
`Boolean`	`getIsLike()` Returns the IsLike.
`Boolean`	`getIsMentionDiscussionAuthors()` Returns the IsMentionDiscussionAuthors.
`Boolean`	`getIsMentionTopicAuthors()` Returns the IsMentionTopicAuthors.
`Boolean`	`getIsMentionTopicManagers()` Returns the IsMentionTopicManagers.
`Boolean`	`getIsMentionTopicReaders()` Returns the IsMentionTopicReaders.
`Boolean`	`getIsNoteForMe()` Returns the IsNoteForMe.
`Date`	`getLastModificationDate()` Returns the LastModificationDate.
`String`	`getLastName()` Returns the LastName.
`Long`	`getNoteId()` Returns the NoteId.
`Long`	`getNoteVersion()` Returns the NoteVersion.
`Integer`	`getNumberOfComments()` Returns the NumberOfComments.
`Long`	`getParentNoteId()` Returns the ParentNoteId.
`TagResource[]`	`getTags()` Returns the Tags.
`String`	`getText()` Returns the Text.
`Long`	`getTopicId()` Returns the TopicId.
`String`	`getTopicName()` Returns the TopicName.
`Long`	`getUserId()` Returns the UserId.
`String`	`getUserName()` Returns the UserName.
`String[]`	`getUsersToNotify()` Returns the UsersToNotify.
`Long[]`	`getUsersToNotifyIds()` Returns the UsersToNotifyIds.
`void`	`handleUnknownProperties(String key, Object value)` Log unknown properties to loglevel warn.
`void`	`setAttachmentIds(Long[] attachmentIds)` Sets AttachmentIds.
`void`	`setAttachments(AttachmentResource[] attachments)` Sets Attachments.
`void`	`setCrawlLastModificationDate(Date crawlLastModificationDate)` Sets CrawlLastModificationDate.
`void`	`setCreationDate(Date creationDate)` Sets CreationDate.
`void`	`setDiscussionDepth(Integer discussionDepth)` Sets DiscussionDepth.
`void`	`setDiscussionId(Long discussionId)` Sets DiscussionId.
`void`	`setDiscussionPath(String discussionPath)` Sets DiscussionPath.
`void`	`setFilterHtml(Boolean filterHtml)` Sets FilterHtml.
`void`	`setFirstName(String firstName)` Sets FirstName.
`void`	`setFollowedItems(String[] followedItems)` Sets FollowedItems.
`void`	`setIsDirectMessage(Boolean isDirectMessage)` Sets IsDirectMessage.
`void`	`setIsFavorite(Boolean isFavorite)` Sets IsFavorite.
`void`	`setIsLike(Boolean isLike)` Sets IsLike.
`void`	`setIsMentionDiscussionAuthors(Boolean isMentionDiscussionAuthors)` Sets IsMentionDiscussionAuthors.
`void`	`setIsMentionTopicAuthors(Boolean isMentionTopicAuthors)` Sets IsMentionTopicAuthors.
`void`	`setIsMentionTopicManagers(Boolean isMentionTopicManagers)` Sets IsMentionTopicManagers.
`void`	`setIsMentionTopicReaders(Boolean isMentionTopicReaders)` Sets IsMentionTopicReaders.
`void`	`setIsNoteForMe(Boolean isNoteForMe)` Sets IsNoteForMe.
`void`	`setLastModificationDate(Date lastModificationDate)` Sets LastModificationDate.
`void`	`setLastName(String lastName)` Sets LastName.
`void`	`setNoteId(Long noteId)` Sets NoteId.
`void`	`setNoteVersion(Long noteVersion)` Sets NoteVersion.
`void`	`setNumberOfComments(Integer numberOfComments)` Sets NumberOfComments.
`void`	`setParentNoteId(Long parentNoteId)` Sets ParentNoteId.
`void`	`setTags(TagResource[] tags)` Sets Tags.
`void`	`setText(String text)` Sets Text.
`void`	`setTopicId(Long topicId)` Sets TopicId.
`void`	`setTopicName(String topicName)` Sets TopicName.
`void`	`setUserId(Long userId)` Sets UserId.
`void`	`setUserName(String userName)` Sets UserName.
`void`	`setUsersToNotify(String[] usersToNotify)` Sets UsersToNotify.
`void`	`setUsersToNotifyIds(Long[] usersToNotifyIds)` Sets UsersToNotifyIds.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GetNoteParameter
```
public GetNoteParameter()
```
    Default Constuctor necessary for json parsing
  - GetNoteParameter
```
public GetNoteParameter(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
  - GetNoteParameter
```
public GetNoteParameter(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
  - setNumberOfComments
```
public void setNumberOfComments(Integer numberOfComments)
```
    Sets NumberOfComments.
    
    Parameters:
    
    numberOfComments -
  - getNumberOfComments
```
public Integer getNumberOfComments()
```
    Returns the NumberOfComments.
    
    Returns:
    
    the NumberOfComments
  - setTags
```
public void setTags(TagResource[] tags)
```
    Sets Tags.
    
    Parameters:
    
    tags -
  - getTags
```
public TagResource[] getTags()
```
    Returns the Tags.
    
    Returns:
    
    the Tags
  - setParentNoteId
```
public void setParentNoteId(Long parentNoteId)
```
    Sets ParentNoteId.
    
    Parameters:
    
    parentNoteId -
  - getParentNoteId
```
public Long getParentNoteId()
```
    Returns the ParentNoteId.
    
    Returns:
    
    the ParentNoteId
  - setIsDirectMessage
```
public void setIsDirectMessage(Boolean isDirectMessage)
```
    Sets IsDirectMessage.
    
    Parameters:
    
    isDirectMessage -
  - getIsDirectMessage
```
public Boolean getIsDirectMessage()
```
    Returns the IsDirectMessage.
    
    Returns:
    
    the IsDirectMessage
  - setIsNoteForMe
```
public void setIsNoteForMe(Boolean isNoteForMe)
```
    Sets IsNoteForMe.
    
    Parameters:
    
    isNoteForMe -
  - getIsNoteForMe
```
public Boolean getIsNoteForMe()
```
    Returns the IsNoteForMe.
    
    Returns:
    
    the IsNoteForMe
  - setUsersToNotify
```
public void setUsersToNotify(String[] usersToNotify)
```
    Sets UsersToNotify.
    
    Parameters:
    
    usersToNotify -
  - getUsersToNotify
```
public String[] getUsersToNotify()
```
    Returns the UsersToNotify.
    
    Returns:
    
    the UsersToNotify
  - setUsersToNotifyIds
```
public void setUsersToNotifyIds(Long[] usersToNotifyIds)
```
    Sets UsersToNotifyIds.
    
    Parameters:
    
    usersToNotifyIds -
  - getUsersToNotifyIds
```
public Long[] getUsersToNotifyIds()
```
    Returns the UsersToNotifyIds.
    
    Returns:
    
    the UsersToNotifyIds
  - setFollowedItems
```
public void setFollowedItems(String[] followedItems)
```
    Sets FollowedItems.
    
    Parameters:
    
    followedItems -
  - getFollowedItems
```
public String[] getFollowedItems()
```
    Returns the FollowedItems.
    
    Returns:
    
    the FollowedItems
  - setIsFavorite
```
public void setIsFavorite(Boolean isFavorite)
```
    Sets IsFavorite.
    
    Parameters:
    
    isFavorite -
  - getIsFavorite
```
public Boolean getIsFavorite()
```
    Returns the IsFavorite.
    
    Returns:
    
    the IsFavorite
  - setIsLike
```
public void setIsLike(Boolean isLike)
```
    Sets IsLike.
    
    Parameters:
    
    isLike -
  - getIsLike
```
public Boolean getIsLike()
```
    Returns the IsLike.
    
    Returns:
    
    the IsLike
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    Sets CreationDate.
    
    Parameters:
    
    creationDate -
  - getCreationDate
```
public Date getCreationDate()
```
    Returns the CreationDate.
    
    Returns:
    
    the CreationDate
  - setLastModificationDate
```
public void setLastModificationDate(Date lastModificationDate)
```
    Sets LastModificationDate.
    
    Parameters:
    
    lastModificationDate -
  - getLastModificationDate
```
public Date getLastModificationDate()
```
    Returns the LastModificationDate.
    
    Returns:
    
    the LastModificationDate
  - setTopicId
```
public void setTopicId(Long topicId)
```
    Sets TopicId.
    
    Parameters:
    
    topicId -
  - getTopicId
```
public Long getTopicId()
```
    Returns the TopicId.
    
    Returns:
    
    the TopicId
  - setTopicName
```
public void setTopicName(String topicName)
```
    Sets TopicName.
    
    Parameters:
    
    topicName -
  - getTopicName
```
public String getTopicName()
```
    Returns the TopicName.
    
    Returns:
    
    the TopicName
  - setUserName
```
public void setUserName(String userName)
```
    Sets UserName.
    
    Parameters:
    
    userName -
  - getUserName
```
public String getUserName()
```
    Returns the UserName.
    
    Returns:
    
    the UserName
  - setFirstName
```
public void setFirstName(String firstName)
```
    Sets FirstName.
    
    Parameters:
    
    firstName -
  - getFirstName
```
public String getFirstName()
```
    Returns the FirstName.
    
    Returns:
    
    the FirstName
  - setLastName
```
public void setLastName(String lastName)
```
    Sets LastName.
    
    Parameters:
    
    lastName -
  - getLastName
```
public String getLastName()
```
    Returns the LastName.
    
    Returns:
    
    the LastName
  - setUserId
```
public void setUserId(Long userId)
```
    Sets UserId.
    
    Parameters:
    
    userId -
  - getUserId
```
public Long getUserId()
```
    Returns the UserId.
    
    Returns:
    
    the UserId
  - setDiscussionDepth
```
public void setDiscussionDepth(Integer discussionDepth)
```
    Sets DiscussionDepth.
    
    Parameters:
    
    discussionDepth -
  - getDiscussionDepth
```
public Integer getDiscussionDepth()
```
    Returns the DiscussionDepth.
    
    Returns:
    
    the DiscussionDepth
  - setDiscussionPath
```
public void setDiscussionPath(String discussionPath)
```
    Sets DiscussionPath.
    
    Parameters:
    
    discussionPath -
  - getDiscussionPath
```
public String getDiscussionPath()
```
    Returns the DiscussionPath.
    
    Returns:
    
    the DiscussionPath
  - setDiscussionId
```
public void setDiscussionId(Long discussionId)
```
    Sets DiscussionId.
    
    Parameters:
    
    discussionId -
  - getDiscussionId
```
public Long getDiscussionId()
```
    Returns the DiscussionId.
    
    Returns:
    
    the DiscussionId
  - setAttachmentIds
```
public void setAttachmentIds(Long[] attachmentIds)
```
    Sets AttachmentIds.
    
    Parameters:
    
    attachmentIds -
  - getAttachmentIds
```
public Long[] getAttachmentIds()
```
    Returns the AttachmentIds.
    
    Returns:
    
    the AttachmentIds
  - setAttachments
```
public void setAttachments(AttachmentResource[] attachments)
```
    Sets Attachments.
    
    Parameters:
    
    attachments -
  - getAttachments
```
public AttachmentResource[] getAttachments()
```
    Returns the Attachments.
    
    Returns:
    
    the Attachments
  - setNoteVersion
```
public void setNoteVersion(Long noteVersion)
```
    Sets NoteVersion.
    
    Parameters:
    
    noteVersion -
  - getNoteVersion
```
public Long getNoteVersion()
```
    Returns the NoteVersion.
    
    Returns:
    
    the NoteVersion
  - setIsMentionTopicReaders
```
public void setIsMentionTopicReaders(Boolean isMentionTopicReaders)
```
    Sets IsMentionTopicReaders.
    
    Parameters:
    
    isMentionTopicReaders -
  - getIsMentionTopicReaders
```
public Boolean getIsMentionTopicReaders()
```
    Returns the IsMentionTopicReaders.
    
    Returns:
    
    the IsMentionTopicReaders
  - setIsMentionTopicAuthors
```
public void setIsMentionTopicAuthors(Boolean isMentionTopicAuthors)
```
    Sets IsMentionTopicAuthors.
    
    Parameters:
    
    isMentionTopicAuthors -
  - getIsMentionTopicAuthors
```
public Boolean getIsMentionTopicAuthors()
```
    Returns the IsMentionTopicAuthors.
    
    Returns:
    
    the IsMentionTopicAuthors
  - setIsMentionTopicManagers
```
public void setIsMentionTopicManagers(Boolean isMentionTopicManagers)
```
    Sets IsMentionTopicManagers.
    
    Parameters:
    
    isMentionTopicManagers -
  - getIsMentionTopicManagers
```
public Boolean getIsMentionTopicManagers()
```
    Returns the IsMentionTopicManagers.
    
    Returns:
    
    the IsMentionTopicManagers
  - setIsMentionDiscussionAuthors
```
public void setIsMentionDiscussionAuthors(Boolean isMentionDiscussionAuthors)
```
    Sets IsMentionDiscussionAuthors.
    
    Parameters:
    
    isMentionDiscussionAuthors -
  - getIsMentionDiscussionAuthors
```
public Boolean getIsMentionDiscussionAuthors()
```
    Returns the IsMentionDiscussionAuthors.
    
    Returns:
    
    the IsMentionDiscussionAuthors
  - setCrawlLastModificationDate
```
public void setCrawlLastModificationDate(Date crawlLastModificationDate)
```
    Sets CrawlLastModificationDate.
    
    Parameters:
    
    crawlLastModificationDate -
  - getCrawlLastModificationDate
```
public Date getCrawlLastModificationDate()
```
    Returns the CrawlLastModificationDate.
    
    Returns:
    
    the CrawlLastModificationDate
  - setFilterHtml
```
public void setFilterHtml(Boolean filterHtml)
```
    Sets FilterHtml.
    
    Parameters:
    
    filterHtml -
  - getFilterHtml
```
public Boolean getFilterHtml()
```
    Returns the FilterHtml.
    
    Returns:
    
    the FilterHtml
  - handleUnknownProperties
```
public void handleUnknownProperties(String key,
                                    Object value)
```
    Log unknown properties to loglevel warn.

Class GetNoteParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetNoteParameter

GetNoteParameter

GetNoteParameter

Method Detail

setNoteId

getNoteId

setText

getText

setNumberOfComments

getNumberOfComments

setTags

getTags

setParentNoteId

getParentNoteId

setIsDirectMessage

getIsDirectMessage

setIsNoteForMe

getIsNoteForMe

setUsersToNotify

getUsersToNotify

setUsersToNotifyIds

getUsersToNotifyIds

setFollowedItems

getFollowedItems

setIsFavorite

getIsFavorite

setIsLike

getIsLike

setCreationDate

getCreationDate

setLastModificationDate

getLastModificationDate

setTopicId

getTopicId

setTopicName

getTopicName

setUserName

getUserName

setFirstName

getFirstName

setLastName

getLastName

setUserId

getUserId

setDiscussionDepth

getDiscussionDepth

setDiscussionPath

getDiscussionPath

setDiscussionId

getDiscussionId

setAttachmentIds

getAttachmentIds

setAttachments

getAttachments

setNoteVersion

getNoteVersion

setIsMentionTopicReaders

getIsMentionTopicReaders

setIsMentionTopicAuthors

getIsMentionTopicAuthors

setIsMentionTopicManagers

getIsMentionTopicManagers

setIsMentionDiscussionAuthors

getIsMentionDiscussionAuthors

setCrawlLastModificationDate

getCrawlLastModificationDate

setFilterHtml

getFilterHtml

handleUnknownProperties