com.communote.server.core.vo.query.post

Class NoteQueryParameters

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

com.communote.server.core.vo.query.post.NoteQueryParameters

Direct Known Subclasses:

DeleteActivitiesNoteQueryParameters

public class NoteQueryParameters
extends TimelineQueryParameters

Query instance to find notes

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_NOTE_STATUS Parameter name in Query for the NoteStatus

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

PARAM_ATTACHMENT_REPO_CONNECTOR_ID, PARAM_BLOG_ID, PARAM_DISCUSSION_ID, PARAM_FILTER, PARAM_LOWER_TAG_DATE, PARAM_MAX_RANK, PARAM_MIN_RANK, PARAM_NOTE_ID, PARAM_RESOURCE_ID, PARAM_TAG_PREFIX, PARAM_UPPER_TAG_DATE, PARAM_USER_ID, PARAM_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
NoteQueryParameters() Construct me with the right query definition

Method Summary

Modifier and Type	Method and Description
static NoteQueryParameters	clone(NoteQueryParameters parameters) Create a new NoteQueryParameters by cloning others.
static NoteQueryParameters	clone(TimelineQueryParameters queryParameters) Create a new NoteQueryInstance that takes the common TimelineQueryParameters Parameters.
DiscussionFilterMode	getDiscussionFilterModeForFiltering() The discussion filter mode that should be used for filtering.
String	getOriginalPostId()
Map<String,Object>	getParameters() Get the parameters of this instances, the names are the keys
ResultSpecification	getResultSpecification() Get the result specification to be used
Date	getRetrieveOnlyNotesAfterDate()
Long	getRetrieveOnlyNotesAfterId()
Date	getRetrieveOnlyNotesBeforeDate()
Long	getRetrieveOnlyNotesBeforeId()
QueryParameters.OrderDirection	getSortByDate()
QueryParameters.OrderDirection	getSortById()
NoteStatus	getStatus()
boolean	isDiscussionDependentRootNotesFilter() See also isDiscussionIndependentFilter()
boolean	isDiscussionIndependentFilter() Return whether the current filters are discussion independent which means that, no matter what value a filter has the result set will always contain all the notes of a discussion the current user is allowed to read.
boolean	isFavoriteFeedAndUnfiltered()
boolean	isFeedFiltered() Checks if the user has filtered the message feed by standard filters.
boolean	isFeedFiltered(boolean allowBlogFilter, boolean allowDateFilter, boolean allowDiscussionIdFilter) Checks if the user has filtered the message feed allowing to ignore specific parameters
boolean	isFollowingFeedAndUnfiltered()
boolean	isNotificationFeed()
boolean	isThreadedView()
void	setOriginalPostId(String originalPostId)
void	setRetrieveOnlyNotesAfterDate(Date retrieveOnlyNotesAfterDate)
void	setRetrieveOnlyNotesAfterId(Long noteId) Note: If also the lowerTagDate filter is set and the lowerTagDate > creationDate of retrieveOnlyNotesBeforeId a standard filtering for lowerTagDate will be done.
void	setRetrieveOnlyNotesBeforeDate(Date retrieveOnlyNotesBeforeDate) Filter to restrict the result to notes that were created before this date.
void	setRetrieveOnlyNotesBeforeId(Long noteId) Filter to restrict the result to notes that have an ID that is lower than this one.
void	setSortByDate(QueryParameters.OrderDirection orderDirection) Method to set the date sorting.
void	setSortById(QueryParameters.OrderDirection sortById) Method to set the id sorting.
void	setStatus(NoteStatus status)
void	setTimelineFilterViewType(TimelineFilterViewType timelineFilterViewType)

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

addTagId, addTagStoreTagId, addTagStoreTagId, createParameterName, getAttachmentContentIds, getAttachmentRepositoryConnectorId, getAttachmentRepositoryConnectorIds, getDiscussionFilterMode, getDiscussionId, getExcludeNoteStatus, getFullTextSearchFilters, getFullTextSearchParameterNames, getLogicalTags, getLowerTagDate, getMaximumRank, getMinimumRank, getNoteId, getNumberOfTagsToFilter, 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, setAttachmentRepositoryConnectorId, setAttachmentRepositoryConnectorIds, setDirectMessage, setDiscussionFilterMode, setDiscussionId, setExcludeNoteStatus, setFavorites, setFullTextSearchFilters, setIncludeStartDate, setLogicalTags, setLowerTagDate, setMaximumRank, setMentionDiscussionAuthors, setMentionTopicAuthors, setMentionTopicManagers, setMentionTopicReaders, setMinimumRank, setNoteId, setQueryForAdditionalDMs, setResourceId, setRetrieveOnlyFollowedItems, setSortByDayDateAndRank, setTagIds, setTagPrefix, setTagStoreAliases, setTimeLimitsQueryRequired, setTopicSearchFilters, setTypeSpecificExtension, setUpperTagDate, setUserAliases, setUserIds, setUserIdsToIgnore, setUserToBeNotified

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

addRoleToExclude, addRoleToInclude, addUserTagIds, addUserTagStoreTagId, addUserTagStoreTagId, getExcludeStatusFilter, getIncludeStatusFilter, getLastModifiedAfter, getMatchMode, getRolesToExclude, getRolesToInclude, getUserSearchFilters, getUserSearchParameterNames, getUserTagIds, getUserTagStoreTagIds, isHideSelectedTags, isIgnoreEmailField, isRetrieveOnlyFollowedUsers, setExcludeStatusFilter, setHideSelectedTags, setIncludeStatusFilter, setLastModifiedAfter, setMatchMode, setRetrieveOnlyFollowedUsers, setUserSearchFilters, setUserSearchFilters, sortByEmailAsc, sortByFirstNameAsc, sortByLastNameAsc, transformResultItem

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, 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_NOTE_STATUS

public static final String PARAM_NOTE_STATUS

Parameter name in Query for the NoteStatus

See Also:

Constant Field Values

Constructor Detail

NoteQueryParameters

public NoteQueryParameters()

Construct me with the right query definition

Method Detail

clone

public static NoteQueryParameters clone(NoteQueryParameters parameters)

Create a new NoteQueryParameters by cloning others.

Parameters:

parameters - The parameters to clone.

Returns:

The NoteQueryParameters with the filters set as in queryInstance

clone

public static NoteQueryParameters clone(TimelineQueryParameters queryParameters)

Create a new NoteQueryInstance that takes the common TimelineQueryParameters Parameters.

Parameters:

queryParameters - The query instance containing all parameters.

Returns:

The NoteQueryParameters with the filters set as in queryInstance

getDiscussionFilterModeForFiltering

public DiscussionFilterMode getDiscussionFilterModeForFiltering()

The discussion filter mode that should be used for filtering.

Overrides:

getDiscussionFilterModeForFiltering in class TimelineQueryParameters

Returns:

the discussionFilterMode

getOriginalPostId

public String getOriginalPostId()

Returns:

the originalPostId

getParameters

public Map<String,Object> getParameters()

Get the parameters of this instances, the names are the keys

Overrides:

getParameters in class TimelineQueryParameters

Returns:

The parameters

getResultSpecification

public ResultSpecification getResultSpecification()

Get the result specification to be used

Overrides:

getResultSpecification in class QueryParameters

Returns:

the ResultSpecification

getRetrieveOnlyNotesAfterDate

public Date getRetrieveOnlyNotesAfterDate()

Returns:

The date to be used for getting a newer note.

getRetrieveOnlyNotesAfterId

public Long getRetrieveOnlyNotesAfterId()

Returns:

tId of the note, which defines an upper bound for returning notes or null for no boundary.

getRetrieveOnlyNotesBeforeDate

public Date getRetrieveOnlyNotesBeforeDate()

Returns:

The date to be used for getting an older note. If null the value returned by getRetrieveOnlyNotesBeforeId() will be ignored.

getRetrieveOnlyNotesBeforeId

public Long getRetrieveOnlyNotesBeforeId()

Returns:

Id of the note, which defines an lower bound for returning notes or null for no boundary. If null the value returned by getRetrieveOnlyNotesBeforeDate() will be ignored. In case the discussion filter mode is set to DiscussionFilterMode.IS_ROOT this ID should be a discussion ID.

getSortByDate

public QueryParameters.OrderDirection getSortByDate()

Returns:

If set, this returns the direction of the date sorting. If no sorting is desired, null will be returned.

getSortById

public QueryParameters.OrderDirection getSortById()

Returns:

If set, this returns the direction of the id sorting. If no sorting is desired, null will be returned.

getStatus

public NoteStatus getStatus()

Returns:

the status

isDiscussionDependentRootNotesFilter

public boolean isDiscussionDependentRootNotesFilter()

See also isDiscussionIndependentFilter()

Returns:

true if it is a filtering for root notes

isDiscussionIndependentFilter

public boolean isDiscussionIndependentFilter()

Return whether the current filters are discussion independent which means that, no matter what value a filter has the result set will always contain all the notes of a discussion the current user is allowed to read. For example the filter for a topic is discussion independent because all notes of one discussion are in the same topic. The same applies for the start and end date filter because the filtering will not use the date of the notes but the lastDiscussionNoteCreationDate of the discussion. In contrast to these filters the tag filter for instance is not discussion independent because some notes of the discussion can have other, more or less tags.

Returns:

true if the feed filters are discussion independent

isFavoriteFeedAndUnfiltered

public boolean isFavoriteFeedAndUnfiltered()

Returns:

true if the user uses an unfiltered favorite feed

isFeedFiltered

public boolean isFeedFiltered()

Checks if the user has filtered the message feed by standard filters.

Returns:

True, if the user set a filter, else false.

isFeedFiltered

public boolean isFeedFiltered(boolean allowBlogFilter,
                              boolean allowDateFilter,
                              boolean allowDiscussionIdFilter)

Checks if the user has filtered the message feed allowing to ignore specific parameters

Parameters:

allowBlogFilter - true to ignore the topic filter when checking for set filters

allowDateFilter - true to ignore the date filter when checking for set filters

allowDiscussionIdFilter - true to ignore the discussionId filter when checking for set filters

Returns:

True, if there is a filter, false otherwise.

isFollowingFeedAndUnfiltered

public boolean isFollowingFeedAndUnfiltered()

Returns:

True, if the following feed is set and there are no filters set for the following feed.

isNotificationFeed

public boolean isNotificationFeed()

Returns:

True, if the user notification filter is set.

isThreadedView

public boolean isThreadedView()

Returns:

true if it is a threaded view

setOriginalPostId

public void setOriginalPostId(String originalPostId)

Parameters:

originalPostId - the originalPostId to set

setRetrieveOnlyNotesAfterDate

public void setRetrieveOnlyNotesAfterDate(Date retrieveOnlyNotesAfterDate)

Parameters:

retrieveOnlyNotesAfterDate - Date, which is used to get another note, if the original note for RetrieveOnlyNotesAfterId was deleted. This should be the same date as the creation date of the original note.

setRetrieveOnlyNotesAfterId

public void setRetrieveOnlyNotesAfterId(Long noteId)

Note: If also the lowerTagDate filter is set and the lowerTagDate > creationDate of retrieveOnlyNotesBeforeId a standard filtering for lowerTagDate will be done.

Parameters:

noteId - All returning notes will have a higher id than this one.

setRetrieveOnlyNotesBeforeDate

public void setRetrieveOnlyNotesBeforeDate(Date retrieveOnlyNotesBeforeDate)

Filter to restrict the result to notes that were created before this date. In case the discussion filter mode is set DiscussionFilterMode.IS_ROOT this date is checked against the lastNoteCreationDate of the discussion. Note: If also the upperTagDate filter is set and the upperTagDate < retrieveOnlyNotesBeforeDate a standard filtering for upperTagDate will be done.

Parameters:

retrieveOnlyNotesBeforeDate - Date for restricting the result to notes that were create before this date

setRetrieveOnlyNotesBeforeId

public void setRetrieveOnlyNotesBeforeId(Long noteId)

Filter to restrict the result to notes that have an ID that is lower than this one. In case the discussion filter mode is set to DiscussionFilterMode.IS_ROOT this ID should be a discussion ID.

Parameters:

noteId - note ID to use for restricting the result to notes with an ID smaller than this

setSortByDate

public void setSortByDate(QueryParameters.OrderDirection orderDirection)

Method to set the date sorting.

Parameters:

orderDirection - Sets the type of date sorting. Set null to disable ordering for the date.

setSortById

public void setSortById(QueryParameters.OrderDirection sortById)

Method to set the id sorting.

Parameters:

sortById - Sets the type of id sorting. Set null to disable ordering for the id.

setStatus

public void setStatus(NoteStatus status)

Parameters:

status - the status to set

setTimelineFilterViewType

public void setTimelineFilterViewType(TimelineFilterViewType timelineFilterViewType)

Parameters:

timelineFilterViewType - the view type to use. The view type defines mainly the result but also has impact on the filter. If setting it to COMMENT it will also set the DiscussionFilterMode to IS_ROOT