GetCollectionNoteParameter (Communote 3.5 API)

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

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

Constructor Summary

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

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`	`getCreationDate()` Returns the CreationDate.
`Integer`	`getDiscussionDepth()` Returns the DiscussionDepth.
`Long`	`getDiscussionId()` Returns the DiscussionId.
`String`	`getDiscussionPath()` Returns the DiscussionPath.
`Long`	`getF_discussionId()` Returns the F_discussionId.
`Date`	`getF_endDate()` Returns the F_endDate.
`String`	`getF_fullTextSearchString()` Returns the F_fullTextSearchString.
`Boolean`	`getF_includeComments()` Returns the F_includeComments.
`String`	`getF_noteSearchString()` Returns the F_noteSearchString.
`Long`	`getF_parentNoteId()` Returns the F_parentNoteId.
`String`	`getF_propertyFilter()` Returns the F_propertyFilter.
`Boolean`	`getF_showDirectMessages()` Returns the F_showDirectMessages.
`Boolean`	`getF_showFavorites()` Returns the F_showFavorites.
`Boolean`	`getF_showFollowedItems()` Returns the F_showFollowedItems.
`Boolean`	`getF_showNotesForMe()` Returns the F_showNotesForMe.
`Date`	`getF_startDate()` Returns the F_startDate.
`String`	`getF_tagPrefix()` Returns the F_tagPrefix.
`String[]`	`getF_tags()` Returns the F_tags.
`String[]`	`getF_topicAliases()` Returns the F_topicAliases.
`Long[]`	`getF_topicIds()` Returns the F_topicIds.
`Long[]`	`getF_userIds()` Returns the F_userIds.
`String`	`getF_userSearchString()` Returns the F_userSearchString.
`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`	`getIsNoteForMe()` Returns the IsNoteForMe.
`Date`	`getLastModificationDate()` Returns the LastModificationDate.
`String`	`getLastName()` Returns the LastName.
`Integer`	`getMaxCount()` Returns the MaxCount.
`Long`	`getNoteId()` Returns the NoteId.
`Long`	`getNoteVersion()` Returns the NoteVersion.
`Integer`	`getNumberOfComments()` Returns the NumberOfComments.
`Integer`	`getOffset()` Returns the Offset.
`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.
`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`	`setCreationDate(Date creationDate)` Sets CreationDate.
`void`	`setDiscussionDepth(Integer discussionDepth)` Sets DiscussionDepth.
`void`	`setDiscussionId(Long discussionId)` Sets DiscussionId.
`void`	`setDiscussionPath(String discussionPath)` Sets DiscussionPath.
`void`	`setF_discussionId(Long f_discussionId)` Sets F_discussionId.
`void`	`setF_endDate(Date f_endDate)` Sets F_endDate.
`void`	`setF_fullTextSearchString(String f_fullTextSearchString)` Sets F_fullTextSearchString.
`void`	`setF_includeComments(Boolean f_includeComments)` Sets F_includeComments.
`void`	`setF_noteSearchString(String f_noteSearchString)` Sets F_noteSearchString.
`void`	`setF_parentNoteId(Long f_parentNoteId)` Sets F_parentNoteId.
`void`	`setF_propertyFilter(String f_propertyFilter)` Sets F_propertyFilter.
`void`	`setF_showDirectMessages(Boolean f_showDirectMessages)` Sets F_showDirectMessages.
`void`	`setF_showFavorites(Boolean f_showFavorites)` Sets F_showFavorites.
`void`	`setF_showFollowedItems(Boolean f_showFollowedItems)` Sets F_showFollowedItems.
`void`	`setF_showNotesForMe(Boolean f_showNotesForMe)` Sets F_showNotesForMe.
`void`	`setF_startDate(Date f_startDate)` Sets F_startDate.
`void`	`setF_tagPrefix(String f_tagPrefix)` Sets F_tagPrefix.
`void`	`setF_tags(String[] f_tags)` Sets F_tags.
`void`	`setF_topicAliases(String[] f_topicAliases)` Sets F_topicAliases.
`void`	`setF_topicIds(Long[] f_topicIds)` Sets F_topicIds.
`void`	`setF_userIds(Long[] f_userIds)` Sets F_userIds.
`void`	`setF_userSearchString(String f_userSearchString)` Sets F_userSearchString.
`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`	`setIsNoteForMe(Boolean isNoteForMe)` Sets IsNoteForMe.
`void`	`setLastModificationDate(Date lastModificationDate)` Sets LastModificationDate.
`void`	`setLastName(String lastName)` Sets LastName.
`void`	`setMaxCount(Integer maxCount)` Sets MaxCount.
`void`	`setNoteId(Long noteId)` Sets NoteId.
`void`	`setNoteVersion(Long noteVersion)` Sets NoteVersion.
`void`	`setNumberOfComments(Integer numberOfComments)` Sets NumberOfComments.
`void`	`setOffset(Integer offset)` Sets Offset.
`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.

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

- Constructor Detail
  - GetCollectionNoteParameter
```
public GetCollectionNoteParameter()
```
    Default Constuctor necessary for json parsing
  - GetCollectionNoteParameter
```
public GetCollectionNoteParameter(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
  - GetCollectionNoteParameter
```
public GetCollectionNoteParameter(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
  - 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
  - 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
  - setFilterHtml
```
public void setFilterHtml(Boolean filterHtml)
```
    Sets FilterHtml.
    
    Parameters:
    
    filterHtml -
  - getFilterHtml
```
public Boolean getFilterHtml()
```
    Returns the FilterHtml.
    
    Returns:
    
    the FilterHtml
  - setF_topicAliases
```
public void setF_topicAliases(String[] f_topicAliases)
```
    Sets F_topicAliases.
    
    Parameters:
    
    f_topicAliases -
  - getF_topicAliases
```
public String[] getF_topicAliases()
```
    Returns the F_topicAliases.
    
    Returns:
    
    the F_topicAliases
  - setF_topicIds
```
public void setF_topicIds(Long[] f_topicIds)
```
    Sets F_topicIds.
    
    Parameters:
    
    f_topicIds -
  - getF_topicIds
```
public Long[] getF_topicIds()
```
    Returns the F_topicIds.
    
    Returns:
    
    the F_topicIds
  - setF_discussionId
```
public void setF_discussionId(Long f_discussionId)
```
    Sets F_discussionId.
    
    Parameters:
    
    f_discussionId -
  - getF_discussionId
```
public Long getF_discussionId()
```
    Returns the F_discussionId.
    
    Returns:
    
    the F_discussionId
  - setF_endDate
```
public void setF_endDate(Date f_endDate)
```
    Sets F_endDate.
    
    Parameters:
    
    f_endDate -
  - getF_endDate
```
public Date getF_endDate()
```
    Returns the F_endDate.
    
    Returns:
    
    the F_endDate
  - setF_fullTextSearchString
```
public void setF_fullTextSearchString(String f_fullTextSearchString)
```
    Sets F_fullTextSearchString.
    
    Parameters:
    
    f_fullTextSearchString -
  - getF_fullTextSearchString
```
public String getF_fullTextSearchString()
```
    Returns the F_fullTextSearchString.
    
    Returns:
    
    the F_fullTextSearchString
  - setF_includeComments
```
public void setF_includeComments(Boolean f_includeComments)
```
    Sets F_includeComments.
    
    Parameters:
    
    f_includeComments -
  - getF_includeComments
```
public Boolean getF_includeComments()
```
    Returns the F_includeComments.
    
    Returns:
    
    the F_includeComments
  - setF_noteSearchString
```
public void setF_noteSearchString(String f_noteSearchString)
```
    Sets F_noteSearchString.
    
    Parameters:
    
    f_noteSearchString -
  - getF_noteSearchString
```
public String getF_noteSearchString()
```
    Returns the F_noteSearchString.
    
    Returns:
    
    the F_noteSearchString
  - setF_parentNoteId
```
public void setF_parentNoteId(Long f_parentNoteId)
```
    Sets F_parentNoteId.
    
    Parameters:
    
    f_parentNoteId -
  - getF_parentNoteId
```
public Long getF_parentNoteId()
```
    Returns the F_parentNoteId.
    
    Returns:
    
    the F_parentNoteId
  - setF_propertyFilter
```
public void setF_propertyFilter(String f_propertyFilter)
```
    Sets F_propertyFilter.
    
    Parameters:
    
    f_propertyFilter -
  - getF_propertyFilter
```
public String getF_propertyFilter()
```
    Returns the F_propertyFilter.
    
    Returns:
    
    the F_propertyFilter
  - setF_showDirectMessages
```
public void setF_showDirectMessages(Boolean f_showDirectMessages)
```
    Sets F_showDirectMessages.
    
    Parameters:
    
    f_showDirectMessages -
  - getF_showDirectMessages
```
public Boolean getF_showDirectMessages()
```
    Returns the F_showDirectMessages.
    
    Returns:
    
    the F_showDirectMessages
  - setF_showFavorites
```
public void setF_showFavorites(Boolean f_showFavorites)
```
    Sets F_showFavorites.
    
    Parameters:
    
    f_showFavorites -
  - getF_showFavorites
```
public Boolean getF_showFavorites()
```
    Returns the F_showFavorites.
    
    Returns:
    
    the F_showFavorites
  - setF_showFollowedItems
```
public void setF_showFollowedItems(Boolean f_showFollowedItems)
```
    Sets F_showFollowedItems.
    
    Parameters:
    
    f_showFollowedItems -
  - getF_showFollowedItems
```
public Boolean getF_showFollowedItems()
```
    Returns the F_showFollowedItems.
    
    Returns:
    
    the F_showFollowedItems
  - setF_showNotesForMe
```
public void setF_showNotesForMe(Boolean f_showNotesForMe)
```
    Sets F_showNotesForMe.
    
    Parameters:
    
    f_showNotesForMe -
  - getF_showNotesForMe
```
public Boolean getF_showNotesForMe()
```
    Returns the F_showNotesForMe.
    
    Returns:
    
    the F_showNotesForMe
  - setF_startDate
```
public void setF_startDate(Date f_startDate)
```
    Sets F_startDate.
    
    Parameters:
    
    f_startDate -
  - getF_startDate
```
public Date getF_startDate()
```
    Returns the F_startDate.
    
    Returns:
    
    the F_startDate
  - setF_tags
```
public void setF_tags(String[] f_tags)
```
    Sets F_tags.
    
    Parameters:
    
    f_tags -
  - getF_tags
```
public String[] getF_tags()
```
    Returns the F_tags.
    
    Returns:
    
    the F_tags
  - setF_tagPrefix
```
public void setF_tagPrefix(String f_tagPrefix)
```
    Sets F_tagPrefix.
    
    Parameters:
    
    f_tagPrefix -
  - getF_tagPrefix
```
public String getF_tagPrefix()
```
    Returns the F_tagPrefix.
    
    Returns:
    
    the F_tagPrefix
  - setF_userIds
```
public void setF_userIds(Long[] f_userIds)
```
    Sets F_userIds.
    
    Parameters:
    
    f_userIds -
  - getF_userIds
```
public Long[] getF_userIds()
```
    Returns the F_userIds.
    
    Returns:
    
    the F_userIds
  - setF_userSearchString
```
public void setF_userSearchString(String f_userSearchString)
```
    Sets F_userSearchString.
    
    Parameters:
    
    f_userSearchString -
  - getF_userSearchString
```
public String getF_userSearchString()
```
    Returns the F_userSearchString.
    
    Returns:
    
    the F_userSearchString
  - 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
  - handleUnknownProperties
```
public void handleUnknownProperties(String key,
                                    Object value)
```
    Log unknown properties to loglevel warn.

Class GetCollectionNoteParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetCollectionNoteParameter

GetCollectionNoteParameter

GetCollectionNoteParameter

Method Detail

setNoteId

getNoteId

setText

getText

setNumberOfComments

getNumberOfComments

setTags

getTags

setParentNoteId

getParentNoteId

setIsDirectMessage

getIsDirectMessage

setIsNoteForMe

getIsNoteForMe

setUsersToNotify

getUsersToNotify

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

setFilterHtml

getFilterHtml

setF_topicAliases

getF_topicAliases

setF_topicIds

getF_topicIds

setF_discussionId

getF_discussionId

setF_endDate

getF_endDate

setF_fullTextSearchString

getF_fullTextSearchString

setF_includeComments

getF_includeComments

setF_noteSearchString

getF_noteSearchString

setF_parentNoteId

getF_parentNoteId

setF_propertyFilter

getF_propertyFilter

setF_showDirectMessages