MACROMEDIA BREEZE-USING THE BREEZE XML WEB SERVICES Use Manual page 22

Using the breeze xml web services
Table of Contents

Advertisement

Filter examples
The following is a simple example to help illustrate the general concept of filters. The web service
API
report-my-courses
a filter on the course name, for example
retrieves your courses with the specified text in the name, in this case "Java". If you add a sort
filter such as
report-my-course&filter-like-name=Java&sort-date-begin=desc
sorts your Java courses and displays the course you started first.
In these examples, there are two types of filters: filter and sort. The basic filter uses the
modifier on the
courses with the exact name Java instead of courses with Java in the name. Using the sort filter
without a modifier on the
The following table lists a few more examples that are helpful for understanding filter basics:
Filter
filter-name=Goals Review
filter-like-name=Goals
filter-out-name=Status
filter-like-name=Goals &filter-
out-status=active
filter-gt-date-begin=2004-05-
01&sort-name=asc
filter-gt-date-begin=2004-05-
01&filter-lt-date-begin=2004-05-31
About date formatting
In Breeze, dates are a special type of field value that follow the ISO 8601 format. For example,
May 28, 2004 is expressed as
28T16:23:00.000
the best result. Using a value of
not a good use of filters. You can retrieve everything that happened in a month by specifying the
year and month. You add as much of the date as you need to select the most accurate data from
the server.
22
Chapter 2: Working with Filters
returns the list of courses you are enrolled in. This same API used with
field with a value
name
date-begin
2004-05-28
. Starting with the year, you may use as much of the date as you need to filter
returns all items that match the same year, which is probably
2004
report-my-courses&filter-like-name=Java
. If you omit the
Java
field with a value
desc
Description
Returns items from the server that have the specific
name "Goals Review." This may apply to meetings,
courses, or any items with a name field.
Returns all items with "Goals" in the name such as
"Goals Review" or "Quarterly Goals."
Filters out or excludes any items with the word "Status"
in the name field.
Returns all items with "Goals" in the name that are no
longer active; for example, to find previous
presentations on "Goals" from previous quarters.
Returns all items with a begin date later than
May 1, 2004, sorted by name in ascending order.
Returns all items started in the month of May, 2004.
and 4:23pm on May 28, 2004 is expressed
modifier, Breeze would return
like
specifies a descending order.
,
, Breeze
like
2004-05-

Advertisement

Table of Contents
loading

This manual is also suitable for:

Breeze

Table of Contents