TimelineQueryParameters (Communote 3.5 API)

java.lang.Object
- com.communote.server.core.vo.query.QueryParameters
- - com.communote.server.core.vo.query.PropertyQueryParameters
  - - com.communote.server.core.vo.query.user.UserQueryParameters
    - - com.communote.server.core.vo.query.TimelineQueryParameters

Direct Known Subclasses:

NoteQueryParameters, TaggingCoreItemTimeLimitsQueryParameters, TagQueryParameters, TopicTimelineParameters, UserTaggingCoreQueryParameters, UserTaggingCoreQueryParameters
```
public abstract class TimelineQueryParameters
extends UserQueryParameters
```
The base instance for CoreItemQueryDefinition It defines filter attributes for getting resources. In case of adding filter parameters also check #clone(TimelineQueryParameters)

Author:

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

Nested Class Summary
- Nested classes/interfaces inherited from class com.communote.server.core.vo.query.QueryParameters
  QueryParameters.OrderDirection

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PARAM_ATTACHMENT_REPO_CONNECTOR_ID` the parameter of the repo connector id
`static String`	`PARAM_BLOG_ID` the parameter name for the blog id
`static String`	`PARAM_DISCUSSION_ID` the parameter of an discussion
`static String`	`PARAM_FILTER` the parameter of a filter for at least the newsfeed
`static String`	`PARAM_LOWER_TAG_DATE` the parameter of the lower tag date
`static String`	`PARAM_MAX_RANK` the parameter of the maximum rank the note should have for the user
`static String`	`PARAM_MIN_RANK` the parameter of the minimum rank the note should have for the user
`static String`	`PARAM_NOTE_ID` the parameter of the resource id
`static String`	`PARAM_RESOURCE_ID` the parameter of the resource id
`static String`	`PARAM_TAG_PREFIX` the parameter name for the tag prefix
`static String`	`PARAM_UPPER_TAG_DATE` the parameter of the upper tag date
`static String`	`PARAM_USER_ID` the parameter name for the user ids
`static String`	`PARAM_USER_TO_BE_NOTIFIED` hql parameter for the user to be notified.

Fields inherited from class com.communote.server.core.vo.query.user.UserQueryParameters
PARAM_LAST_MODIFICATION_DATE, PARAM_USER_ROLE_FILTER, PLACEHOLDER_USER_ALIAS

Fields inherited from class com.communote.server.core.vo.query.QueryParameters
SORT_ASCENDING, SORT_DESCENDING

Constructor Summary

Constructors
Constructor and Description
`TimelineQueryParameters()` Construct me with the right query definition
`TimelineQueryParameters(TaggingCoreItemUTPExtension extension)` Construct me with the right query definition

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addTagId(Long tagId)`
`void`	`addTagStoreTagId(String tagStoreAlias, Collection<String> tagStoreTagIds)`
`void`	`addTagStoreTagId(String tagStoreAlias, String tagStoreTagId)`
`protected String`	`createParameterName(AtomicTagFormula atom)` Creates a named parameter from a atomic tag formula.
`String[]`	`getAttachmentContentIds()`
`String`	`getAttachmentRepositoryConnectorId()`
`String[]`	`getAttachmentRepositoryConnectorIds()`
`DiscussionFilterMode`	`getDiscussionFilterMode()` The discussion filter mode that should be used for getting results.
`DiscussionFilterMode`	`getDiscussionFilterModeForFiltering()` The discussion filter mode that should be used for filtering.
`Long`	`getDiscussionId()`
`NoteStatus[]`	`getExcludeNoteStatus()`
`String[]`	`getFullTextSearchFilters()`
`String[]`	`getFullTextSearchParameterNames()`
`LogicalTagFormula`	`getLogicalTags()` Returns the logical tag definitions.
`Date`	`getLowerTagDate()` the date after a resource must be tagged
`Double`	`getMaximumRank()`
`Double`	`getMinimumRank()`
`Long`	`getNoteId()`
`int`	`getNumberOfTagsToFilter()`
`Map<String,Object>`	`getParameters()` Get the parameters of this instances, the names are the keys
`Long`	`getResourceId()` Get the resource of this instance
`Set<Long>`	`getTagIds()`
`String`	`getTagPrefix()` Get the tag prefix
`Set<String>`	`getTagStoreAliases()`
`Map<String,Set<String>>`	`getTagStoreTagIds()`
`String[]`	`getTopicSearchParameterNames()`
`TaggingCoreItemUTPExtension`	`getTypeSpecificExtension()`
`Date`	`getUpperTagDate()`
`Set<String>`	`getUserAliases()`
`Long[]`	`getUserIds()` the user ids
`Long[]`	`getUserIdsToIgnore()`
`Long[]`	`getUserToBeNotified()` Gets the user to be notified.
`boolean`	`isAllowDuplicateResults()`
`boolean`	`isDirectMessage()`
`boolean`	`isFavorites()`
`boolean`	`isIncludeStartDate()`
`boolean`	`isMentionDiscussionAuthors()`
`boolean`	`isMentionTopicAuthors()`
`boolean`	`isMentionTopicManagers()`
`boolean`	`isMentionTopicReaders()`
`boolean`	`isMultilingualTagPrefixSearch()`
`boolean`	`isQueryForAdditionalDMs()` See setQueryForAdditionalDMs for a description.
`boolean`	`isRankFilterActive()`
`boolean`	`isRetrieveOnlyFollowedItems()`
`boolean`	`isSearchOnlyExtensionSpecificFields()`
`boolean`	`isSortByDayDateAndRank()`
`boolean`	`isTimeLimitsQueryRequired()` Determines whether an additional query for time limits is required.
`boolean`	`needTransformListItem()`
`void`	`setAllowDuplicateResults(boolean allowDuplicateResults)`
`void`	`setAttachmentContentIds(String[] attachmentContentIds)`
`void`	`setAttachmentRepositoryConnectorId(String attachmentRepositoryConnectorId)`
`void`	`setAttachmentRepositoryConnectorIds(String[] attachmentRepositoryConnectorIds)`
`void`	`setDirectMessage(boolean directMessage)`
`void`	`setDiscussionFilterMode(DiscussionFilterMode discussionFilterMode)`
`void`	`setDiscussionId(Long discussionId)` Sets the discussion id and resets the note id! There cannot be searched for a note and a discussion id on the same time.
`void`	`setExcludeNoteStatus(NoteStatus[] statuss)` Sets the `NoteStatus` which should be excluded from the query.
`void`	`setFavorites(Boolean favorites)`
`void`	`setFullTextSearchFilters(String[] fullTextSearchFilters)`
`void`	`setIncludeStartDate(boolean includeStartDate)`
`void`	`setLogicalTags(LogicalTagFormula formula)`
`void`	`setLowerTagDate(Date lowerTagDate)`
`void`	`setMaximumRank(Double maximumRank)`
`void`	`setMentionDiscussionAuthors(boolean mentionDiscussionAuthors)`
`void`	`setMentionTopicAuthors(boolean mentionTopicAuthors)`
`void`	`setMentionTopicManagers(boolean mentionTopicManagers)`
`void`	`setMentionTopicReaders(boolean mentionTopicReaders)`
`void`	`setMinimumRank(Double minimumRank)`
`void`	`setNoteId(Long noteId)` Set the note id.
`void`	`setQueryForAdditionalDMs(boolean queryForAdditionalDMs)` This method is just a hook for KENMEI-5766 and mainly KENMEI-5661 (the stupid desktop client), to make it possible to AND combine following and direct messages.
`void`	`setResourceId(Long resourceId)`
`void`	`setRetrieveOnlyFollowedItems(boolean onlyFollowedItems)` Whether to retrieve only followed items or items that are related to these items.
`void`	`setSortByDayDateAndRank(boolean sortByDayDateAndRank)`
`void`	`setTagIds(Collection<Long> tagIds)`
`void`	`setTagPrefix(String tagPrefix)` set the tag prefix.
`void`	`setTagStoreAliases(Set<String> tagStoreAliases)` Set aliases of tag stores to only consider tags from these stores
`void`	`setTimeLimitsQueryRequired(boolean timeLimitsQueryRequired)` Set whether a query for time limits is required.
`void`	`setTopicSearchFilters(String[] topicSearchFilters)` Set the strings to match against the topic titles
`void`	`setTypeSpecificExtension(TaggingCoreItemUTPExtension extension)` Focuses this query for Notes to one of the sub-types UserTaggedResource or Note.
`void`	`setUpperTagDate(Date upperTagDate)`
`void`	`setUserAliases(Set<String> userAliases)`
`void`	`setUserIds(Long[] userIds)` set the user ids parameter
`void`	`setUserIdsToIgnore(Long... userIdsToIgnore)` Method to ignore users.
`void`	`setUserToBeNotified(Long[] userToBeNotified)` Sets the user to be notified.

Methods inherited from class com.communote.server.core.vo.query.PropertyQueryParameters
addPropertyFilter, getPropertyFilters

Methods inherited from class com.communote.server.core.vo.query.QueryParameters
addParameter, addParameter, addSortField, addSortField, createParameterNamesForSearch, getDatabaseConfiguration, getLanguageCode, getPageInformation, getPageInformation, getResultSpecification, getSortString, isLimitResultSet, isLimitResultSetAvodingDuplicates, putParameter, putParametersForSearch, putParametersForSearch, setLanguageCode, setLimitResultSet, setLimitResultSetAvodingDuplicates, setResultSpecification, validateLong

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

- Field Detail
  - PARAM_TAG_PREFIX
```
public static final String PARAM_TAG_PREFIX
```
    the parameter name for the tag prefix
    
    See Also:
    
    Constant Field Values
  - PARAM_USER_TO_BE_NOTIFIED
```
public static final String PARAM_USER_TO_BE_NOTIFIED
```
    hql parameter for the user to be notified.
    
    See Also:
    
    Constant Field Values
  - PARAM_USER_ID
```
public static final String PARAM_USER_ID
```
    the parameter name for the user ids
    
    See Also:
    
    Constant Field Values
  - PARAM_BLOG_ID
```
public static final String PARAM_BLOG_ID
```
    the parameter name for the blog id
    
    See Also:
    
    Constant Field Values
  - PARAM_LOWER_TAG_DATE
```
public static final String PARAM_LOWER_TAG_DATE
```
    the parameter of the lower tag date
    
    See Also:
    
    Constant Field Values
  - PARAM_UPPER_TAG_DATE
```
public static final String PARAM_UPPER_TAG_DATE
```
    the parameter of the upper tag date
    
    See Also:
    
    Constant Field Values
  - PARAM_RESOURCE_ID
```
public static final String PARAM_RESOURCE_ID
```
    the parameter of the resource id
    
    See Also:
    
    Constant Field Values
  - PARAM_DISCUSSION_ID
```
public static final String PARAM_DISCUSSION_ID
```
    the parameter of an discussion
    
    See Also:
    
    Constant Field Values
  - PARAM_FILTER
```
public static final String PARAM_FILTER
```
    the parameter of a filter for at least the newsfeed
    
    See Also:
    
    Constant Field Values
  - PARAM_MIN_RANK
```
public static final String PARAM_MIN_RANK
```
    the parameter of the minimum rank the note should have for the user
    
    See Also:
    
    Constant Field Values
  - PARAM_MAX_RANK
```
public static final String PARAM_MAX_RANK
```
    the parameter of the maximum rank the note should have for the user
    
    See Also:
    
    Constant Field Values
  - PARAM_NOTE_ID
```
public static final String PARAM_NOTE_ID
```
    the parameter of the resource id
    
    See Also:
    
    Constant Field Values
  - PARAM_ATTACHMENT_REPO_CONNECTOR_ID
```
public static final String PARAM_ATTACHMENT_REPO_CONNECTOR_ID
```
    the parameter of the repo connector id
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TimelineQueryParameters
```
public TimelineQueryParameters()
```
    Construct me with the right query definition
  - TimelineQueryParameters
```
public TimelineQueryParameters(TaggingCoreItemUTPExtension extension)
```
    Construct me with the right query definition
    
    Parameters:
    
    extension - extension to use cannot be null
- Method Detail
  - addTagId
```
public void addTagId(Long tagId)
```
    Parameters:
    
    tagId - TagId to filter for.
  - addTagStoreTagId
```
public void addTagStoreTagId(String tagStoreAlias,
                             Collection<String> tagStoreTagIds)
```
    Parameters:
    
    tagStoreAlias - The alias of the TagStore.
    
    tagStoreTagIds - Collection of tag ids to add for the given TagStore.
  - addTagStoreTagId
```
public void addTagStoreTagId(String tagStoreAlias,
                             String tagStoreTagId)
```
    Parameters:
    
    tagStoreAlias - The alias of the TagStore.
    
    tagStoreTagId - The id of the tag within the TagStore.
  - createParameterName
```
protected String createParameterName(AtomicTagFormula atom)
```
    Creates a named parameter from a atomic tag formula. The parameter can be used in the query and will be included in the map returned by getParameters(). The tag is converted to lower case.
    
    Parameters:
    
    atom - the atomic tag formula for which the parameter is needed
    
    Returns:
    
    the named parameter
  - getAttachmentContentIds
```
public String[] getAttachmentContentIds()
```
  - getAttachmentRepositoryConnectorId
```
public String getAttachmentRepositoryConnectorId()
```
  - getAttachmentRepositoryConnectorIds
```
public String[] getAttachmentRepositoryConnectorIds()
```
  - getDiscussionFilterMode
```
public DiscussionFilterMode getDiscussionFilterMode()
```
    The discussion filter mode that should be used for getting results.
    
    Returns:
    
    the discussionFilterMode
  - getDiscussionFilterModeForFiltering
```
public DiscussionFilterMode getDiscussionFilterModeForFiltering()
```
    The discussion filter mode that should be used for filtering.
    
    Returns:
    
    the discussionFilterMode
  - getDiscussionId
```
public Long getDiscussionId()
```
    Returns:
    
    the discussionId
  - getExcludeNoteStatus
```
public NoteStatus[] getExcludeNoteStatus()
```
    Returns:
    
    Array of NoteStatus, which should be ignored.
  - getFullTextSearchFilters
```
public String[] getFullTextSearchFilters()
```
    Returns:
    
    the fields for full text search
  - getFullTextSearchParameterNames
```
public String[] getFullTextSearchParameterNames()
```
    Returns:
    
    the parameter names to be used in a full text search or null if no text search filter was set
  - getLogicalTags
```
public LogicalTagFormula getLogicalTags()
```
    Returns the logical tag definitions.
    
    Returns:
    
    the formula describing the logically combined tags or null if they are not set
  - getLowerTagDate
```
public Date getLowerTagDate()
```
    the date after a resource must be tagged
    
    Returns:
    
    the date
  - getMaximumRank
```
public Double getMaximumRank()
```
    Returns:
    
    the maximum rank the note should have for the user, null to ignore
  - getMinimumRank
```
public Double getMinimumRank()
```
    Returns:
    
    the minimum rank the note should have for the user, null to ignore
  - getNoteId
```
public Long getNoteId()
```
    Returns:
    
    Id of the note to load. This will result in at max. one result.
  - getNumberOfTagsToFilter
```
public int getNumberOfTagsToFilter()
```
    Returns:
    
    counts the number of tags to filter for using getTagIds() and getTagStoreTagIds()
  - getParameters
```
public Map<String,Object> getParameters()
```
    Get the parameters of this instances, the names are the keys
    
    Overrides:
    
    getParameters in class UserQueryParameters
    
    Returns:
    
    The parameters
  - getResourceId
```
public Long getResourceId()
```
    Get the resource of this instance
    
    Returns:
    
    the resource id
  - getTagIds
```
public Set<Long> getTagIds()
```
    Returns:
    
    the tagIds
  - getTagPrefix
```
public String getTagPrefix()
```
    Get the tag prefix
    
    Overrides:
    
    getTagPrefix in class UserQueryParameters
    
    Returns:
    
    the tag prefix
  - getTagStoreAliases
```
public Set<String> getTagStoreAliases()
```
    Overrides:
    
    getTagStoreAliases in class UserQueryParameters
    
    Returns:
    
    set of aliases identifying tag stores
  - getTagStoreTagIds
```
public Map<String,Set<String>> getTagStoreTagIds()
```
    Returns:
    
    the tagStoreTagIds
  - getTopicSearchParameterNames
```
public String[] getTopicSearchParameterNames()
```
    Returns:
    
    the parameter names to be used in a topic title search or null if no title search filter was set
  - getTypeSpecificExtension
```
public TaggingCoreItemUTPExtension getTypeSpecificExtension()
```
    Returns:
    
    the extension
  - getUpperTagDate
```
public Date getUpperTagDate()
```
    Returns:
    
    the upper tag date
  - getUserAliases
```
public Set<String> getUserAliases()
```
    Returns:
    
    Set of user aliases, which are allowed to be a notes author.
  - getUserIds
```
public Long[] getUserIds()
```
    the user ids
    
    Returns:
    
    the user ids, which can be null or an array with at least one value
  - getUserIdsToIgnore
```
public Long[] getUserIdsToIgnore()
```
    Returns:
    
    An array of user ids, which should be ignored, when retrieving data. This may be empty but never null.
  - getUserToBeNotified
```
public Long[] getUserToBeNotified()
```
    Gets the user to be notified.
    
    Returns:
    
    the user to be notified
  - isAllowDuplicateResults
```
public boolean isAllowDuplicateResults()
```
    Returns:
    
    true if the result may contain distinct result (it will be faster though). In detail no distinct will be used in the query.
  - isDirectMessage
```
public boolean isDirectMessage()
```
    Returns:
    
    the directMessage, which can be true or false
  - isFavorites
```
public boolean isFavorites()
```
    Returns:
    
    the favorites
  - isIncludeStartDate
```
public boolean isIncludeStartDate()
```
    Returns:
    
    the includeStartDate
  - isMentionDiscussionAuthors
```
public boolean isMentionDiscussionAuthors()
```
    Returns:
    
    the mentionDiscussionAuthors
  - isMentionTopicAuthors
```
public boolean isMentionTopicAuthors()
```
    Returns:
    
    the mentionTopicAuthors
  - isMentionTopicManagers
```
public boolean isMentionTopicManagers()
```
    Returns:
    
    the mentionTopicManagers
  - isMentionTopicReaders
```
public boolean isMentionTopicReaders()
```
    Returns:
    
    the mentionTopicReaders
  - isMultilingualTagPrefixSearch
```
public boolean isMultilingualTagPrefixSearch()
```
    Overrides:
    
    isMultilingualTagPrefixSearch in class UserQueryParameters
    
    Returns:
    
    true if a tag prefix query should check the translations of tags
  - isQueryForAdditionalDMs
```
public boolean isQueryForAdditionalDMs()
```
    See setQueryForAdditionalDMs for a description.
    
    Returns:
    
    True, if this query is used to retrieve additional DM's
  - isRankFilterActive
```
public boolean isRankFilterActive()
```
    Returns:
    
    true of either the rank filter is active
  - isRetrieveOnlyFollowedItems
```
public boolean isRetrieveOnlyFollowedItems()
```
    Returns:
    
    whether to retrieve only followed items or items that are related to these items
  - isSearchOnlyExtensionSpecificFields
```
public boolean isSearchOnlyExtensionSpecificFields()
```
    Returns:
    
    true to only search extension specific fields
  - isSortByDayDateAndRank
```
public boolean isSortByDayDateAndRank()
```
    Returns:
    
    true if to sort only by the date and then by the rank (per date). a minimum or maximum rank must be set for this to work.
  - isTimeLimitsQueryRequired
```
public boolean isTimeLimitsQueryRequired()
```
    Determines whether an additional query for time limits is required. For details see setTimeLimitsQueryRequired(boolean).
    
    Returns:
    
    true if the query is required
  - needTransformListItem
```
public boolean needTransformListItem()
```
    Description copied from class: UserQueryParameters
    
    Overrides:
    
    needTransformListItem in class UserQueryParameters
    
    Returns:
    
    true if the transform list item function should be used after retrieving the objects
  - setAllowDuplicateResults
```
public void setAllowDuplicateResults(boolean allowDuplicateResults)
```
    Parameters:
    
    allowDuplicateResults - true if the result may contain distinct result (it will be faster tho). In detail no distinct will be used in the query.
  - setAttachmentContentIds
```
public void setAttachmentContentIds(String[] attachmentContentIds)
```
  - setAttachmentRepositoryConnectorId
```
public void setAttachmentRepositoryConnectorId(String attachmentRepositoryConnectorId)
```
  - setAttachmentRepositoryConnectorIds
```
public void setAttachmentRepositoryConnectorIds(String[] attachmentRepositoryConnectorIds)
```
  - setDirectMessage
```
public void setDirectMessage(boolean directMessage)
```
    Parameters:
    
    directMessage - Set to true, if only direct messages should be loaded.
  - setDiscussionFilterMode
```
public void setDiscussionFilterMode(DiscussionFilterMode discussionFilterMode)
```
    Parameters:
    
    discussionFilterMode - the discussionFilterMode to set
  - setDiscussionId
```
public void setDiscussionId(Long discussionId)
```
    Sets the discussion id and resets the note id! There cannot be searched for a note and a discussion id on the same time. If a single note is needed use the note id only, that is discussion id must be null.
    
    Parameters:
    
    discussionId - the discussionId to set
  - setExcludeNoteStatus
```
public void setExcludeNoteStatus(NoteStatus[] statuss)
```
    Sets the NoteStatus which should be excluded from the query.
    
    Parameters:
    
    statuss - Array of NoteStatus.
  - setFavorites
```
public void setFavorites(Boolean favorites)
```
    Parameters:
    
    favorites - the favorites to set
  - setFullTextSearchFilters
```
public void setFullTextSearchFilters(String[] fullTextSearchFilters)
```
    Parameters:
    
    fullTextSearchFilters - the full text search filters
  - setIncludeStartDate
```
public void setIncludeStartDate(boolean includeStartDate)
```
    Parameters:
    
    includeStartDate - If true, also notes written exactly at the start date will be filtered, else only notes written after the set start date.
  - setLogicalTags
```
public void setLogicalTags(LogicalTagFormula formula)
```
    Parameters:
    
    formula - the formula to match the tags
  - setLowerTagDate
```
public void setLowerTagDate(Date lowerTagDate)
```
    Parameters:
    
    lowerTagDate - the lower tag date
  - setMaximumRank
```
public void setMaximumRank(Double maximumRank)
```
    Parameters:
    
    maximumRank - the maximum rank the note should have for the user, null to ignore
  - setMentionDiscussionAuthors
```
public void setMentionDiscussionAuthors(boolean mentionDiscussionAuthors)
```
    Parameters:
    
    mentionDiscussionAuthors - the mentionDiscussionAuthors to set
  - setMentionTopicAuthors
```
public void setMentionTopicAuthors(boolean mentionTopicAuthors)
```
    Parameters:
    
    mentionTopicAuthors - the mentionTopicAuthors to set
  - setMentionTopicManagers
```
public void setMentionTopicManagers(boolean mentionTopicManagers)
```
    Parameters:
    
    mentionTopicManagers - the mentionTopicManagers to set
  - setMentionTopicReaders
```
public void setMentionTopicReaders(boolean mentionTopicReaders)
```
    Parameters:
    
    mentionTopicReaders - the mentionTopicReaders to set
  - setMinimumRank
```
public void setMinimumRank(Double minimumRank)
```
    Parameters:
    
    minimumRank - the minimum rank the note should have for the user, null to ignore
  - setNoteId
```
public void setNoteId(Long noteId)
```
    Set the note id. Will be ignored if there is an discussion
    
    Parameters:
    
    noteId - the noteId to set
  - setQueryForAdditionalDMs
```
public void setQueryForAdditionalDMs(boolean queryForAdditionalDMs)
```
    This method is just a hook for KENMEI-5766 and mainly KENMEI-5661 (the stupid desktop client), to make it possible to AND combine following and direct messages.
    
    Parameters:
    
    queryForAdditionalDMs - Set to true, if this query is used to retrieve additional DM's
  - setResourceId
```
public void setResourceId(Long resourceId)
```
    Parameters:
    
    resourceId - the resource id to filter for
  - setRetrieveOnlyFollowedItems
```
public void setRetrieveOnlyFollowedItems(boolean onlyFollowedItems)
```
    Whether to retrieve only followed items or items that are related to these items.
    
    Parameters:
    
    onlyFollowedItems - true for retrieving only followed items
  - setSortByDayDateAndRank
```
public void setSortByDayDateAndRank(boolean sortByDayDateAndRank)
```
    Parameters:
    
    sortByDayDateAndRank - true if to sort only by the date and then by the rank (per date). a minimum or maximum rank must be set for this to work.
  - setTagIds
```
public void setTagIds(Collection<Long> tagIds)
```
    Parameters:
    
    tagIds - the tagIds to set
  - setTagPrefix
```
public void setTagPrefix(String tagPrefix)
```
    set the tag prefix. The resulting tags must be starting with this prefix
    
    Overrides:
    
    setTagPrefix in class UserQueryParameters
    
    Parameters:
    
    tagPrefix - the tag prefix
  - setTagStoreAliases
```
public void setTagStoreAliases(Set<String> tagStoreAliases)
```
    Set aliases of tag stores to only consider tags from these stores
    
    Overrides:
    
    setTagStoreAliases in class UserQueryParameters
    
    Parameters:
    
    tagStoreAliases - set of aliases identifying tag stores
  - setTimeLimitsQueryRequired
```
public void setTimeLimitsQueryRequired(boolean timeLimitsQueryRequired)
```
    Set whether a query for time limits is required. If set to true a separate query which retrieves the upper and lower creation date of those UTIs which match the current filter settings (not including time filters) will be executed. The query result will change to a subtype of PageableList, namely AugmentedPageableList which holds all list items and the time limits.
    
    Parameters:
    
    timeLimitsQueryRequired - true to get the time limits
  - setTopicSearchFilters
```
public void setTopicSearchFilters(String[] topicSearchFilters)
```
    Set the strings to match against the topic titles
    
    Parameters:
    
    topicSearchFilters - the strings to match against the titles
  - setTypeSpecificExtension
```
public void setTypeSpecificExtension(TaggingCoreItemUTPExtension extension)
```
    Focuses this query for Notes to one of the sub-types UserTaggedResource or Note. In case this method is not called explicitly the type will default to UserTaggedResource.
    
    Parameters:
    
    extension - the sub-type of Note on which the query should focus with its specific data
  - setUpperTagDate
```
public void setUpperTagDate(Date upperTagDate)
```
    Parameters:
    
    upperTagDate - set the upper tag date
  - setUserAliases
```
public void setUserAliases(Set<String> userAliases)
```
    Parameters:
    
    userAliases - the userAliases to set
  - setUserIds
```
public void setUserIds(Long[] userIds)
```
    set the user ids parameter
    
    Parameters:
    
    userIds - the user ids parameter
  - setUserIdsToIgnore
```
public void setUserIdsToIgnore(Long... userIdsToIgnore)
```
    Method to ignore users.
    
    Parameters:
    
    userIdsToIgnore - An array of user ids, which should be ignored, when retrieving content.
  - setUserToBeNotified
```
public void setUserToBeNotified(Long[] userToBeNotified)
```
    Sets the user to be notified.
    
    Parameters:
    
    userToBeNotified - the new user to be notified

Class TimelineQueryParameters

Nested Class Summary

Nested classes/interfaces inherited from class com.communote.server.core.vo.query.QueryParameters

Field Summary

Fields inherited from class com.communote.server.core.vo.query.user.UserQueryParameters

Fields inherited from class com.communote.server.core.vo.query.QueryParameters

Constructor Summary

Method Summary

Methods inherited from class com.communote.server.core.vo.query.user.UserQueryParameters

Methods inherited from class com.communote.server.core.vo.query.PropertyQueryParameters

Methods inherited from class com.communote.server.core.vo.query.QueryParameters

Methods inherited from class java.lang.Object

Field Detail

PARAM_TAG_PREFIX

PARAM_USER_TO_BE_NOTIFIED

PARAM_USER_ID

PARAM_BLOG_ID

PARAM_LOWER_TAG_DATE

PARAM_UPPER_TAG_DATE

PARAM_RESOURCE_ID

PARAM_DISCUSSION_ID

PARAM_FILTER

PARAM_MIN_RANK

PARAM_MAX_RANK

PARAM_NOTE_ID

PARAM_ATTACHMENT_REPO_CONNECTOR_ID

Constructor Detail

TimelineQueryParameters

TimelineQueryParameters

Method Detail

addTagId

addTagStoreTagId

addTagStoreTagId

createParameterName

getAttachmentContentIds

getAttachmentRepositoryConnectorId

getAttachmentRepositoryConnectorIds

getDiscussionFilterMode

getDiscussionFilterModeForFiltering

getDiscussionId

getExcludeNoteStatus

getFullTextSearchFilters

getFullTextSearchParameterNames

getLogicalTags

getLowerTagDate

getMaximumRank

getMinimumRank

getNoteId

getNumberOfTagsToFilter

getParameters

getResourceId

getTagIds

getTagPrefix

getTagStoreAliases

getTagStoreTagIds

getTopicSearchParameterNames

getTypeSpecificExtension

getUpperTagDate

getUserAliases

getUserIds

getUserIdsToIgnore

getUserToBeNotified

isAllowDuplicateResults

isDirectMessage

isFavorites

isIncludeStartDate

isMentionDiscussionAuthors

isMentionTopicAuthors

isMentionTopicManagers

isMentionTopicReaders

isMultilingualTagPrefixSearch

isQueryForAdditionalDMs

isRankFilterActive

isRetrieveOnlyFollowedItems

isSearchOnlyExtensionSpecificFields

isSortByDayDateAndRank

isTimeLimitsQueryRequired

needTransformListItem

setAllowDuplicateResults

setAttachmentContentIds