BlogPostResultFilter 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>
    <blogID>Long</blogID>
    <onlyPublished>xs:boolean</onlyPublished>
    <publishDateRangeMax>xs:dateTime</publishDateRangeMax>
    <publishDateRangeMin>xs:dateTime</publishDateRangeMin>
<...>

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
blogID
Setting
Sets the blogID that results will be filtered on. By default, no filtering on blogID's will take place. If you'd like to change so that no filtering is performed, pass in ResultFilter.NULL_INT.
Getting
Returns the blogID that results will be filtered on. The method will return NULL_INT if no blog to filter on has been specified.
creationDateRangeMax
Setting
Getting
creationDateRangeMin
Setting
Getting
moderationRangeMax
Setting
Getting
moderationRangeMin
Setting
Getting
modificationDateRangeMax
Setting
Getting
modificationDateRangeMin
Setting
Getting
numResults
Setting
Getting
onlyPublished
Setting
Sets whether the result to be selected by the result filter should include published blog posts. The default value is true, to include only published blog posts.

NOTE: This method only looks at the blog post publish status value and NOT the publish date. Under most circumstances, you'll want to use this method in conjunction with the publish date max and min methods.

Getting
Returns whether the result to be selected by the result filter should include published blog posts. The default value is true, to include only published blog posts.

NOTE: This method only looks at the blog post publish status value and NOT the publish date. Under most circumstances, you'll want to use this method in conjunction with the publish date max and min methods.

publishDateRangeMax
Setting
Sets a date that represents the upper boundry for blog posts to be selected by the result filter. If this value is not set the results filter will be unbounded for the latest publish date selected. Setting a date range for a BlogPostResultFilter 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
Returns a date that represents the upper boundry for blog posts to be selected by the result filter. If this value is not set it will return null and the results filter will be unbounded for the latest publish date selected.
publishDateRangeMin
Setting
Sets the date that represents the lower boundary for blog posts to be selected by the result filter. If this value is not set the results filter will be unbounded for the earliest publish date selected.

Setting a date range for a BlogPostResultFilter 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
Returns the publish date that represents the lower boundary for blog posts to be filtered on. If this value has not been set, the method will return null.
recursive
Setting
Getting
resolutionDateRangeMin
Setting
Getting
resolutionStates
Setting
Getting
resolutionnDateRangeMax
Setting
Getting
sortField
Setting
Getting
sortOrder
Setting
Getting
startIndex
Setting
Getting
tags
Setting
Getting
userID
Setting
Getting