SocialGroupResultFilter Type

Type Template

<...>
    <creationDateRangeMax>xs:dateTime</creationDateRangeMax>
    <creationDateRangeMin>xs:dateTime</creationDateRangeMin>
    <moderationRangeMax>Integer</moderationRangeMax>
    <moderationRangeMin>Integer</moderationRangeMin>
    <modificationDateRangeMax>xs:dateTime</modificationDateRangeMax>
    <modificationDateRangeMin>xs:dateTime</modificationDateRangeMin>
    <numResults>Integer</numResults>
    <recursive>xs:boolean</recursive>
    <resolutionDateRangeMin>Integer</resolutionDateRangeMin>
    <!-- List of ... -->
    <resolutionStates>xs:string</resolutionStates>
    <resolutionnDateRangeMax>Integer</resolutionnDateRangeMax>
    <sortField>xs:int</sortField>
    <sortOrder>xs:int</sortOrder>
    <startIndex>xs:int</startIndex>
    <!-- List of ... -->
    <tags>xs:string</tags>
    <userID>Long</userID>
    <prefix>xs:string</prefix>
<...>

Note: Element descriptions are split into information that's relevant when you're creating an instance of this type and information relevant when you're receiving an instance of it. Occasionally these will differ.

Elements

Element Description
creationDateRangeMax
Setting
Sets a date that represents the upper boundry for messages or threads to be selected by the result filter. If this value is not set the results filter will be unbounded for the latest creation date selected.

Setting a date range for a ResultFilter is a potential performance bottleneck. For example, if the argument for the date range is "new Date()" then the corresponding database query will map to an accuracy of a particular millesecond in time. This means that the results can't be cached. A better solution is to round dates to the nearest minute, hour, etc (whatever accuracy you need).

Getting
creationDateRangeMin
Setting
Sets the date that represents the lower boundary for messages or threads to be selected by the result filter. If this value is not set the results filter will be unbounded for the earliest creation date selected.

Setting a date range for a ResultFilter is a potential performance bottleneck. For example, if the argument for the date range is "new Date()" then the corresponding database query will map to an accuracy of a particular millesecond in time. This means that the results can't be cached. A better solution is to round dates to the nearest minute, hour, etc (whatever accuracy you need).

Getting
moderationRangeMax
Setting
Sets the upper bound for the moderation value that will pass the result filter. If this value is not set, or is set to ResultFilter.NULL_INT there will be no upper bound on moderation values.
Getting
moderationRangeMin
Setting
Sets the moderation value that represents the lower bound for messages or threads to be selected by the result filter. If this value is not set, the lower bound will default to 1 (visible)
Getting
modificationDateRangeMax
Setting
Sets a date that represents the upper boundry for messages or threads to be selected by the result filter. If this value is not set the results filter will be unbounded for the latest modified date selected.

Setting a date range for a ResultFilter is a potential performance bottleneck. For example, if the argument for the date range is "new Date()" then the corresponding database query will map to an accuracy of a particular millesecond in time. This means that the results can't be cached. A better solution is to round dates to the nearest minute, hour, etc (whatever accuracy you need).

Getting
modificationDateRangeMin
Setting
Sets a date that represents the lower boundary for messages or threads to be selected by the result filter. If this value is not set the results filter will be unbounded for the earliest modified date selected.

Setting a date range for a ResultFilter is a potential performance bottleneck. For example, if the argument for the date range is "new Date()" then the corresponding database query will map to an accuracy of a particular millesecond in time. This means that the results can't be cached. A better solution is to round dates to the nearest minute, hour, etc (whatever accuracy you need).

Getting
numResults
Setting
Sets the limit on the number of results to be returned.
Getting
prefix
Setting
Getting
recursive
Setting
Sets the recursive value of queries. If set to true then database results will be done over an entire tree of communities, rather than in a specific community.

The default value of this is false which means only one community (and not its children) will be considered in results.

Getting
resolutionDateRangeMin
Setting
Getting
resolutionStates
Setting
Getting
resolutionnDateRangeMax
Setting
Getting
sortField
Setting
Sets the sort field to use. The default value is 9 (MODIFICATION_DATE) .

Valid sort fields for object types are as follows:

  • Communities -- 9 (MODIFICATION_DATE) , 8 (CREATION_DATE) , 16 (COMMUNITY_NAME)

  • Threads -- 9 (MODIFICATION_DATE) , 8 (CREATION_DATE) , 5 (THREAD_NAME)
  • Messages -- 9 (MODIFICATION_DATE) , 8 (CREATION_DATE) , 6 (MESSAGE_SUBJECT)
Getting
sortOrder
Setting
Sets the sort type. Valid arguments are ResultFilter.ASCENDING for ascending sorting or ResultFilter.DESCENDING for descending sorting. Descending sorting is: 3, 2, 1, etc. Ascending sorting is 1, 2, 3, etc.
Getting
startIndex
Setting
Sets the index of the first result to return. For example, if the start index is set to 20, the Iterator returned will start at the 20th result in the query. This method can be used in combination with setNumResults(int) to perform pagination of results.
Getting
tags
Setting
Sets the ContentTag s to filter on. Only results with at least one of the tags will be returned.
Getting
userID
Setting
Sets the userID that results will be filtered on. If you'd like to filter on "anonymous" users, pass in an id of -1. By default, no filtering on userID's will take place. If you'd like to change so that no filtering is performed, pass in ResultFilter.NULL_INT.
Getting