|
1 |
|
2 <!DOCTYPE html |
|
3 PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
|
4 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"/><meta name="copyright" content="(C) Copyright 2009"/><meta name="DC.rights.owner" content="(C) Copyright 2009"/><meta name="DC.Type" content="mobileconcept"/><meta name="DC.Title" content="Criteria for retrieving landmark information"/><meta name="DC.Relation" scheme="URI" content="GUID-89A7E790-06F0-488E-B833-AC63B9995E25"/><meta name="DC.Relation" scheme="URI" content="GUID-7C69DDA4-16F1-4A8F-BDB2-4CB0015B4E81"/><meta name="DC.Relation" scheme="URI" content="GUID-65AAF569-D347-462B-B59A-9D7CA184AB9C"/><meta name="DC.Relation" scheme="URI" content="GUID-B8845FF1-D7F6-476A-8651-8B9C12D8789F"/><meta name="DC.Relation" scheme="URI" content="GUID-55591BBC-49F8-407D-98F5-1D2FCD5DFB34"/><meta name="DC.Format" content="XHTML"/><meta name="DC.Identifier" content="GUID-8074E501-A64A-41F8-B598-05D8B496438F"/><title>Criteria for |
|
5 retrieving landmark information </title><script type="text/javascript"> |
|
6 function initPage() {} |
|
7 </script><link href="../PRODUCT_PLUGIN/book.css" rel="stylesheet" type="text/css"/><link href="css/s60/style.css" rel="stylesheet" type="text/css" media="all"/></head><body onload="initPage();"><div class="body"><div class="contentLeft prTxt"><h1 class="pageHeading" id="GUID-8074E501-A64A-41F8-B598-05D8B496438F"><span>Criteria</span> for |
|
8 retrieving landmark information</h1><div> |
|
9 <p>The <code>criteria</code> object specifies what landmark |
|
10 information is returned and how the returned information is sorted.</p> |
|
11 <p>Each <a href="GUID-55591BBC-49F8-407D-98F5-1D2FCD5DFB34.html#GUID-55591BBC-49F8-407D-98F5-1D2FCD5DFB34"><code>GetList</code></a> call |
|
12 targets one type of landmark information:</p> |
|
13 <ul> |
|
14 <li><p>Landmark</p></li> |
|
15 <li><p>Landmark category</p></li> |
|
16 <li><p>Landmark database</p></li> |
|
17 </ul> |
|
18 <p>For more information about the types, see the <a href="GUID-D581028C-06ED-422D-866E-AE6C93075084.html#GUID-D581028C-06ED-422D-866E-AE6C93075084">Landmarks |
|
19 Service overview page</a>.</p> |
|
20 <p>The <code>criteria</code> object has three main properties: <code>Type</code>, <code>Filter</code>, |
|
21 and <code>Sort</code>. These are described in the following table. |
|
22 Properties enclosed in brackets are optional.</p> |
|
23 <div class="tablenoborder"><a name="GUID-B83DB416-E379-4F2E-9728-4C3C1BA3BA3B"><!----></a><table cellpadding="4" cellspacing="0" summary="" id="GUID-B83DB416-E379-4F2E-9728-4C3C1BA3BA3B" frame="border" border="1" rules="all"><caption><strong>Table: </strong><span>Criteria</span> object properties</caption> |
|
24 |
|
25 <thead align="left"> |
|
26 <tr class="title "><th class="cellrowborder" valign="top" width="25%" id="d0e39638"> |
|
27 <p>Property</p> |
|
28 </th><th class="cellrowborder" valign="top" width="25%" id="d0e39643"> |
|
29 <p>Description</p> |
|
30 </th><th class="cellrowborder" valign="top" width="25%" id="d0e39648"> |
|
31 <p>Type</p> |
|
32 </th><th class="cellrowborder" valign="top" width="25%" id="d0e39653"> |
|
33 <p>Value</p> |
|
34 </th></tr> |
|
35 </thead> |
|
36 <tbody> |
|
37 <tr class=""> |
|
38 <td class="cellrowborder" valign="top" width="25%" headers="d0e39638 "> |
|
39 <p><code>criteria.Type</code></p> |
|
40 </td> |
|
41 <td class="cellrowborder" valign="top" width="25%" headers="d0e39643 "> |
|
42 <p>Specifies the type of landmark information to retrieve.</p> |
|
43 <div class="note"><p><strong class="note_title">Note: </strong>The available <code>Filter</code> properties depend on the selected |
|
44 type.</p> |
|
45 </div> |
|
46 </td> |
|
47 <td class="cellrowborder" valign="top" width="25%" headers="d0e39648 "> |
|
48 <p>string</p> |
|
49 </td> |
|
50 <td class="cellrowborder" valign="top" width="25%" headers="d0e39653 "> |
|
51 <p>Possible values:</p> |
|
52 <ul> |
|
53 <li><p><code>"Landmark"</code></p></li> |
|
54 <li><p><code>"Category"</code></p></li> |
|
55 <li><p><code>"Database"</code></p></li> |
|
56 </ul> |
|
57 </td> |
|
58 </tr> |
|
59 <tr class="bg "> |
|
60 <td class="cellrowborder" valign="top" width="25%" headers="d0e39638 "> |
|
61 <p><code>[criteria.Filter]</code></p> |
|
62 </td> |
|
63 <td class="cellrowborder" valign="top" width="25%" headers="d0e39643 "> |
|
64 <p>Specifies how the information to be retrieved is filtered.</p> |
|
65 <p>The properties of this object depend on the specified <code>Type</code>:</p> |
|
66 <ul> |
|
67 <li><p><a href="GUID-7B55EBBB-B61B-4D2A-B93F-752E3488D58B.html#GUID-7B55EBBB-B61B-4D2A-B93F-752E3488D58B">Landmark |
|
68 properties</a></p></li> |
|
69 <li><p><a href="GUID-54D264D2-0E5F-4478-9334-712A9DCD0ABD.html#GUID-54D264D2-0E5F-4478-9334-712A9DCD0ABD">Landmark |
|
70 category properties</a></p></li> |
|
71 <li><p><a href="GUID-60B94D3B-4743-4254-8FD9-EB591DAADA0F.html#GUID-60B94D3B-4743-4254-8FD9-EB591DAADA0F">Landmark |
|
72 database properties</a></p></li> |
|
73 </ul> |
|
74 <p>If the <code>Filter</code> property is not specified, <code>GetList</code> returns |
|
75 a list of all the available landmarks, landmark categories, or landmark databases, |
|
76 depending on the specified <code>Type</code>.</p> |
|
77 </td> |
|
78 <td class="cellrowborder" valign="top" width="25%" headers="d0e39648 "> |
|
79 <p>object</p> |
|
80 </td> |
|
81 <td class="cellrowborder" valign="top" width="25%" headers="d0e39653 "> |
|
82 <p>For example:</p> |
|
83 <p><code>criteria</code><code>.Filter.LandmarkName</code></p> |
|
84 </td> |
|
85 </tr> |
|
86 <tr class=""> |
|
87 <td class="cellrowborder" valign="top" width="25%" headers="d0e39638 "> |
|
88 <p><code>[criteria.Sort]</code></p> |
|
89 </td> |
|
90 <td class="cellrowborder" valign="top" width="25%" headers="d0e39643 "> |
|
91 <p>Specifies how the returned list of information is sorted.</p> |
|
92 </td> |
|
93 <td class="cellrowborder" valign="top" width="25%" headers="d0e39648 "> |
|
94 <p>object</p> |
|
95 </td> |
|
96 <td class="cellrowborder" valign="top" width="25%" headers="d0e39653 "> |
|
97 <p>Object with the properties specified below</p> |
|
98 </td> |
|
99 </tr> |
|
100 <tr class="bg "> |
|
101 <td class="cellrowborder" valign="top" width="25%" headers="d0e39638 "> |
|
102 <p><code>[criteria.Sort.Key]</code></p> |
|
103 </td> |
|
104 <td class="cellrowborder" valign="top" width="25%" headers="d0e39643 "> |
|
105 <p>Specifies the information field (object property) to sort by.</p> |
|
106 </td> |
|
107 <td class="cellrowborder" valign="top" width="25%" headers="d0e39648 "> |
|
108 <p>string</p> |
|
109 </td> |
|
110 <td class="cellrowborder" valign="top" width="25%" headers="d0e39653 "> |
|
111 <p>Possible values:</p> |
|
112 <ul> |
|
113 <li><p>If <code>Type</code> is <code>"Landmark"</code>: <code>"LandmarkName"</code></p> |
|
114 </li> |
|
115 <li><p>If <code>Type</code> is <code>"Category"</code>: <code>"CategoryName"</code></p> |
|
116 </li> |
|
117 <li><p>If <code>Type</code> is <code>"Database"</code>: <code>"DatabaseURI"</code></p> |
|
118 </li> |
|
119 </ul> |
|
120 </td> |
|
121 </tr> |
|
122 <tr class=""> |
|
123 <td class="cellrowborder" valign="top" width="25%" headers="d0e39638 "> |
|
124 <p><code>criteria.Sort.Order</code></p> |
|
125 </td> |
|
126 <td class="cellrowborder" valign="top" width="25%" headers="d0e39643 "> |
|
127 <p>Specifies the sort order.</p> |
|
128 <p>The default value for this property depends on <code>Type</code>:</p> |
|
129 <ul> |
|
130 <li><p>If <code>Type</code> is <code>"Landmark"</code>: <code>"Ascending"</code></p> |
|
131 </li> |
|
132 <li><p>If <code>Type</code> is <code>"Category"</code>: |
|
133 No default value</p></li> |
|
134 <li><p>If <code>Type</code> is <code>"Database"</code>: <code>"Ascending"</code></p> |
|
135 </li> |
|
136 </ul> |
|
137 </td> |
|
138 <td class="cellrowborder" valign="top" width="25%" headers="d0e39648 "> |
|
139 <p>string</p> |
|
140 </td> |
|
141 <td class="cellrowborder" valign="top" width="25%" headers="d0e39653 "> |
|
142 <p>Possible values:</p> |
|
143 <ul> |
|
144 <li><p><code>"Ascending"</code></p></li> |
|
145 <li><p><code>"Descending"</code></p></li> |
|
146 </ul> |
|
147 </td> |
|
148 </tr> |
|
149 </tbody> |
|
150 </table></div></div></div></div><div class="footer"><hr/><div class="copy">© Nokia 2009.</div></div></body></html> |