QueryParametersParameterNameProvider (Communote 3.5 API)

All Known Implementing Classes:

FilterApiParameterNameProvider, FilterRestApiParameterNameProvider, FilterRestApiParameterNameProvider, FilterRestApiParameterNameProvider, FilterRestApiParameterNameProvider, FilterWidgetParameterNameProvider
```
public interface QueryParametersParameterNameProvider
```
Interface for parameter name provider.

Author:

Communote GmbH - http://www.communote.com/

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`getNameForAccessLevel()` Returns the parameter name for the blog access level
`String`	`getNameForAttachmentContentIds()`
`String`	`getNameForAttachmentRepositoryConnectorIds()`
`String`	`getNameForBlogAliases()` Returns the parameter name for blog aliases.
`String`	`getNameForBlogIds()` Returns the parameter name for blog ids.
`String`	`getNameForBlogIdsToExclude()` Returns the parameter name for blog ids to exclude.
`String`	`getNameForBlogSearchString()` Returns the parameter name for the blog search string.
`String`	`getNameForCheckAtLeastMoreResults()` With this parameter it is possible to define a number of additional entities, which should be loaded when requesting data.
`String`	`getNameForDirectMessages()` Returns the parameter name for filtering direct messages.
`String`	`getNameForDiscussionFilterMode()` Returns the name for the parameter for `DiscussionFilterMode` .
`String`	`getNameForDiscussionId()` Returns the name for the parameter for the discussion id.
`String`	`getNameForEndDate()` Returns the parameter name for the end date .
`String`	`getNameForExcludeToplevelTopics()`
`String`	`getNameForExternalObjectId()` Returns the name for the parameter to filter for topics with an external object with the given externalId
`String`	`getNameForExternalObjectSystemId()` Returns the name for the parameter to filter for topics with an external object with the given externalSystemId
`String`	`getNameForFavorite()` Returns the parameter name for filtering favorites.
`String`	`getNameForFollowedBlogs()` Returns the parameter name for filtering for followed blogs.
`String`	`getNameForFollowedNotes()` Returns the parameter name for filtering for followed notes.
`String`	`getNameForForceAllTopics()` Returns the name for the force all topics flags on topic queries.
`String`	`getNameForFullTextSearchString()` Returns the parameter name for the full text search.
`String`	`getNameForIncludeChildTopics()`
`String`	`getNameForIncludeComments()`
`String`	`getNameForMaxCount()` Returns the parameter name for max post count.
`String`	`getNameForMaximumRank()`
`String`	`getNameForMinimumRank()`
`String`	`getNameForOffset()` Returns the parameter name for the posts offset.
`String`	`getNameForParentPostId()` Returns the parameter name for parent post id.
`String`	`getNameForParentTopicIds()`
`String`	`getNameForPostSearchString()` Returns the parameter name for the post search string.
`String`	`getNameForPropertyFilter()`
`String`	`getNameForRetrieveOnlyNotesAfterDate()`
`String`	`getNameForRetrieveOnlyNotesAfterId()`
`String`	`getNameForRetrieveOnlyNotesBeforeDate()`
`String`	`getNameForRetrieveOnlyNotesBeforeId()`
`String`	`getNameForSelectedViewType()` Returns the name for the parameter, which defines the selected view type.
`String`	`getNameForShowDiscussionParticipation()`
`String`	`getNameForShowOnlyRootTopics()`
`String`	`getNameForShowOnlyToplevelTopics()`
`String`	`getNameForShowPostsForMe()` Returns the parameter name for show posts only for me.
`String`	`getNameForSortByDayDateAndRank()`
`String`	`getNameForStartDate()` Returns the parameter name for the start date.
`String`	`getNameForTagIds()`
`String`	`getNameForTagIdsToExclude()`
`String`	`getNameForTagPrefix()` Returns the parameter name for the tag prefix.
`String`	`getNameForTags()` Returns the parameter name for tags.
`String`	`getNameForTargetBlogId()` Returns the name for the target blog ID which is a single blog ID.
`String`	`getNameForTopicSortByLatestNote()`
`String`	`getNameForUserAliases()` Returns the parameter name for the user aliases.
`String`	`getNameForUserIds()` Returns the parameter name for the user ids.
`String`	`getNameForUserIdsToIgnore()` Returns the parameter name for the user ids to ignore.
`String`	`getNameForUserSearchString()` Returns the parameter name for the user search string.
`String[]`	`getNamesForNoteId()` Returns the name for the parameter for the UserTaggedResource.

- Method Detail
  - getNameForAccessLevel
```
String getNameForAccessLevel()
```
    Returns the parameter name for the blog access level
    
    Returns:
    
    the parameter name
  - getNameForAttachmentContentIds
```
String getNameForAttachmentContentIds()
```
    Returns:
    
    parameter name for a comma separated list of content ids of attachments
  - getNameForAttachmentRepositoryConnectorIds
```
String getNameForAttachmentRepositoryConnectorIds()
```
    Returns:
    
    parameter name for a comma separated list of repository connectors ids. The ids will be used in conjunction with the content ids. If only one is provided it will be used for all.
  - getNameForBlogAliases
```
String getNameForBlogAliases()
```
    Returns the parameter name for blog aliases.
    
    Returns:
    
    The parameter name.
  - getNameForBlogIds
```
String getNameForBlogIds()
```
    Returns the parameter name for blog ids.
    
    Returns:
    
    The parameter name.
  - getNameForBlogIdsToExclude
```
String getNameForBlogIdsToExclude()
```
    Returns the parameter name for blog ids to exclude.
    
    Returns:
    
    The parameter name.
  - getNameForBlogSearchString
```
String getNameForBlogSearchString()
```
    Returns the parameter name for the blog search string.
    
    Returns:
    
    The parameter name.
  - getNameForCheckAtLeastMoreResults
```
String getNameForCheckAtLeastMoreResults()
```
    With this parameter it is possible to define a number of additional entities, which should be loaded when requesting data. These will be used to build information for paging, endless scrolling etc..
    
    Returns:
    
    The parameter name.
  - getNameForDirectMessages
```
String getNameForDirectMessages()
```
    Returns the parameter name for filtering direct messages.
    
    Returns:
    
    The parameter name.
  - getNameForDiscussionFilterMode
```
String getNameForDiscussionFilterMode()
```
    Returns the name for the parameter for DiscussionFilterMode .
    
    Returns:
    
    The parameter name.
  - getNameForDiscussionId
```
String getNameForDiscussionId()
```
    Returns the name for the parameter for the discussion id. So if the user wants to filter for a specific discussion.
    
    Returns:
    
    the name for the discussion id
  - getNameForEndDate
```
String getNameForEndDate()
```
    Returns the parameter name for the end date .
    
    Returns:
    
    The parameter name.
  - getNameForExcludeToplevelTopics
```
String getNameForExcludeToplevelTopics()
```
    Returns:
    
    The name for excluding top level topics from the result.
  - getNameForExternalObjectId
```
String getNameForExternalObjectId()
```
    Returns the name for the parameter to filter for topics with an external object with the given externalId
    
    Returns:
    
    The parameter name.
  - getNameForExternalObjectSystemId
```
String getNameForExternalObjectSystemId()
```
    Returns the name for the parameter to filter for topics with an external object with the given externalSystemId
    
    Returns:
    
    The parameter name.
  - getNameForFavorite
```
String getNameForFavorite()
```
    Returns the parameter name for filtering favorites.
    
    Returns:
    
    The parameter name.
  - getNameForFollowedBlogs
```
String getNameForFollowedBlogs()
```
    Returns the parameter name for filtering for followed blogs.
    
    Returns:
    
    The parameter name.
  - getNameForFollowedNotes
```
String getNameForFollowedNotes()
```
    Returns the parameter name for filtering for followed notes.
    
    Returns:
    
    The parameter name.
  - getNameForForceAllTopics
```
String getNameForForceAllTopics()
```
    Returns the name for the force all topics flags on topic queries.
    
    Returns:
    
    The parameter name.
  - getNameForFullTextSearchString
```
String getNameForFullTextSearchString()
```
    Returns the parameter name for the full text search.
    
    Returns:
    
    The parameter name.
  - getNameForIncludeChildTopics
```
String getNameForIncludeChildTopics()
```
    Returns:
    
    The name for the boolean parameter to include results, i.e. notes or tags, from child topics within the query. This only works in combination with setting a target blog id or a list of blog ids.
  - getNameForIncludeComments
```
String getNameForIncludeComments()
```
    Returns:
    
    the name for the boolean parameter that describes whether comments should be considered when retrieving notes.
  - getNameForMaxCount
```
String getNameForMaxCount()
```
    Returns the parameter name for max post count.
    
    Returns:
    
    The parameter name.
  - getNameForMaximumRank
```
String getNameForMaximumRank()
```
    Returns:
    
    the name for the parameter for the maximum rank of the note must have for the user.
  - getNameForMinimumRank
```
String getNameForMinimumRank()
```
    Returns:
    
    the name for the parameter for the minimum rank of the note must have for the user.
  - getNameForOffset
```
String getNameForOffset()
```
    Returns the parameter name for the posts offset.
    
    Returns:
    
    The parameter name.
  - getNameForParentPostId
```
String getNameForParentPostId()
```
    Returns the parameter name for parent post id.
    
    Returns:
    
    The parameter name.
  - getNameForParentTopicIds
```
String getNameForParentTopicIds()
```
    Returns:
    
    The name for the parameter containing a list of parent topics ids to filter for.
  - getNameForPostSearchString
```
String getNameForPostSearchString()
```
    Returns the parameter name for the post search string.
    
    Returns:
    
    The parameter name.
  - getNameForPropertyFilter
```
String getNameForPropertyFilter()
```
    Returns:
    
    The name for the property filter parameter.
  - getNameForRetrieveOnlyNotesAfterDate
```
String getNameForRetrieveOnlyNotesAfterDate()
```
    Returns:
    
    The parameter name.
    
    See Also:
    
    NoteQueryParameters.setRetrieveOnlyNotesAfterDate(java.util.Date)
  - getNameForRetrieveOnlyNotesAfterId
```
String getNameForRetrieveOnlyNotesAfterId()
```
    Returns:
    
    The parameter name.
    
    See Also:
    
    NoteQueryParameters.setRetrieveOnlyNotesAfterId(java.lang.Long)
  - getNameForRetrieveOnlyNotesBeforeDate
```
String getNameForRetrieveOnlyNotesBeforeDate()
```
    Returns:
    
    The parameter name.
    
    See Also:
    
    NoteQueryParameters.setRetrieveOnlyNotesBeforeDate(java.util.Date)
  - getNameForRetrieveOnlyNotesBeforeId
```
String getNameForRetrieveOnlyNotesBeforeId()
```
    Returns:
    
    The parameter name.
    
    See Also:
    
    NoteQueryParameters.setRetrieveOnlyNotesBeforeId(java.lang.Long)
  - getNameForSelectedViewType
```
String getNameForSelectedViewType()
```
    Returns the name for the parameter, which defines the selected view type.
    
    Returns:
    
    The parameter name.
  - getNameForShowDiscussionParticipation
```
String getNameForShowDiscussionParticipation()
```
    Returns:
    
    the showDiscussionParticipation.
  - getNameForShowOnlyRootTopics
```
String getNameForShowOnlyRootTopics()
```
    Returns:
    
    Parameter name for showing only root topics.
  - getNameForShowOnlyToplevelTopics
```
String getNameForShowOnlyToplevelTopics()
```
    Returns:
    
    The name for showing only toplevel topics.
  - getNameForShowPostsForMe
```
String getNameForShowPostsForMe()
```
    Returns the parameter name for show posts only for me.
    
    Returns:
    
    The parameter name.
  - getNameForSortByDayDateAndRank
```
String getNameForSortByDayDateAndRank()
```
    Returns:
    
    parameter name for sorting by the day and the rank
  - getNameForStartDate
```
String getNameForStartDate()
```
    Returns the parameter name for the start date.
    
    Returns:
    
    The parameter name.
  - getNameForTagIds
```
String getNameForTagIds()
```
    Returns:
    
    The parameter name for tag ids.
  - getNameForTagIdsToExclude
```
String getNameForTagIdsToExclude()
```
    Returns:
    
    The parameter name for tag ids to exclude within the result set.
  - getNameForTagPrefix
```
String getNameForTagPrefix()
```
    Returns the parameter name for the tag prefix.
    
    Returns:
    
    The parameter name.
  - getNameForTags
```
String getNameForTags()
```
    Returns the parameter name for tags.
    
    Returns:
    
    The parameter name.
  - getNameForTargetBlogId
```
String getNameForTargetBlogId()
```
    Returns the name for the target blog ID which is a single blog ID.
    
    Returns:
    
    The parameter name.
  - getNameForTopicSortByLatestNote
```
String getNameForTopicSortByLatestNote()
```
    Returns:
    
    name of parameter to sort topics by the youngest note (based on creation date)
  - getNameForUserAliases
```
String getNameForUserAliases()
```
    Returns the parameter name for the user aliases.
    
    Returns:
    
    The parameter name.
  - getNameForUserIds
```
String getNameForUserIds()
```
    Returns the parameter name for the user ids.
    
    Returns:
    
    The parameter name.
  - getNameForUserIdsToIgnore
```
String getNameForUserIdsToIgnore()
```
    Returns the parameter name for the user ids to ignore.
    
    Returns:
    
    The parameter name.
  - getNameForUserSearchString
```
String getNameForUserSearchString()
```
    Returns the parameter name for the user search string.
    
    Returns:
    
    The parameter name.
  - getNamesForNoteId
```
String[] getNamesForNoteId()
```
    Returns the name for the parameter for the UserTaggedResource. So if the user wants to filter for a specific element only.
    
    Returns:
    
    The parameter name.

Interface QueryParametersParameterNameProvider

Method Summary

Method Detail

getNameForAccessLevel

getNameForAttachmentContentIds

getNameForAttachmentRepositoryConnectorIds

getNameForBlogAliases

getNameForBlogIds

getNameForBlogIdsToExclude

getNameForBlogSearchString

getNameForCheckAtLeastMoreResults

getNameForDirectMessages

getNameForDiscussionFilterMode

getNameForDiscussionId

getNameForEndDate

getNameForExcludeToplevelTopics

getNameForExternalObjectId

getNameForExternalObjectSystemId

getNameForFavorite

getNameForFollowedBlogs

getNameForFollowedNotes

getNameForForceAllTopics

getNameForFullTextSearchString

getNameForIncludeChildTopics

getNameForIncludeComments

getNameForMaxCount

getNameForMaximumRank

getNameForMinimumRank

getNameForOffset

getNameForParentPostId

getNameForParentTopicIds

getNameForPostSearchString

getNameForPropertyFilter

getNameForRetrieveOnlyNotesAfterDate

getNameForRetrieveOnlyNotesAfterId

getNameForRetrieveOnlyNotesBeforeDate

getNameForRetrieveOnlyNotesBeforeId

getNameForSelectedViewType

getNameForShowDiscussionParticipation

getNameForShowOnlyRootTopics

getNameForShowOnlyToplevelTopics

getNameForShowPostsForMe

getNameForSortByDayDateAndRank

getNameForStartDate

getNameForTagIds

getNameForTagIdsToExclude

getNameForTagPrefix

getNameForTags

getNameForTargetBlogId

getNameForTopicSortByLatestNote

getNameForUserAliases

getNameForUserIds

getNameForUserIdsToIgnore

getNameForUserSearchString

getNamesForNoteId