- From: Richard Tibbett via cvs-syncmail <cvsmail@w3.org>
- Date: Tue, 21 Sep 2010 08:49:39 +0000
- To: public-dap-commits@w3.org
Update of /sources/public/2009/dap/contacts
In directory hutz:/tmp/cvs-serv29677/contacts
Modified Files:
Overview.html
Log Message:
Updates according to feedback at http://lists.w3.org/Archives/Public/public-device-apis/2010Sep/0072.html
Index: Overview.html
===================================================================
RCS file: /sources/public/2009/dap/contacts/Overview.html,v
retrieving revision 1.86
retrieving revision 1.87
diff -u -d -r1.86 -r1.87
--- Overview.html 15 Sep 2010 09:07:24 -0000 1.86
+++ Overview.html 21 Sep 2010 08:49:37 -0000 1.87
@@ -805,29 +805,14 @@
href="#widl-Contacts-find">find()</a> operation.
</dd>
<dt>
- attribute unsigned short? limit
- </dt>
- <dd>
- <p>
- The maximum number of results to return from the contacts search.
- </p>
- <p>
- This parameter only applies in the case that the associated <code>multiple</code> attribute is equal to <code>true</code>.
- </p>
- <p>
- If no value is provided, the search will return all <a
- href='#contact-interface'><code>Contact</code></a> object results.
- </p>
- </dd>
- <dt>
- attribute DOMString updatedSince
+ attribute Date? updatedSince
</dt>
<dd>
<p>
- Return only contact records that have been updated on or after the given time, specified as an xs:dateTime.
+ Return only contact records that have been updated on or after the given time, specified as an ECMAScript <code>Date</code> object.
</p>
<p>
- This filter is based on the <a
+ This filter is applied to the <a
href="#widl-Contact-updated"><code>updated</code></a> field as defined in <a
href="#contact-interface"><code>Contact</code></a>.
</p>
@@ -913,32 +898,26 @@
An invalid parameter was provided when the requested method was invoked.
</dd>
<dt>
- const unsigned short NOT_FOUND_ERROR = 2
- </dt>
- <dd>
- If no response information can be provided from the requested method.
- </dd>
- <dt>
- const unsigned short TIMEOUT_ERROR = 3
+ const unsigned short TIMEOUT_ERROR = 2
</dt>
<dd>
The requested method timed out before it could be completed.
</dd>
<dt>
- const unsigned short PENDING_OPERATION_ERROR = 4
+ const unsigned short PENDING_OPERATION_ERROR = 3
</dt>
<dd>
If the <a>user agent</a> is currently waiting for a callback on a current find() operation, as defined in
this specification.
</dd>
<dt>
- const unsigned short IO_ERROR = 5
+ const unsigned short IO_ERROR = 4
</dt>
<dd>
An error occurred in communication with the underlying implementation that meant the requested method could not complete.
</dd>
<dt>
- const unsigned short NOT_SUPPORTED_ERROR = 6
+ const unsigned short NOT_SUPPORTED_ERROR = 5
</dt>
<dd>
The requested method is not supported by the current implementation.
@@ -1010,40 +989,40 @@
</p>
<section>
<h3>
- Complex Search Qualifiers
+ Advanced Search Qualifiers
</h3>
- <p>We call <dfn>complex</dfn> attributes <a
- href="#contact-interface"><code>Contact</code></a> attributes which
- contain information only available only through child DOMString-based attributes of an object.
+ <p>We call <dfn>composed attributes</dfn> <a
+ href="#contact-interface"><code>Contact</code></a> attributes of types <code>object</code>, <code>sequence</code>, <code>array</code> or <code>any</code> which
+ contain information only available only through child attributes of that object.
</p>
<p>
- A requesting application MUST be able to request both the full complex <a
- href="#contact-interface"><code>Contact</code></a> attribute and also be able to request individual parts of a complex <a
+ A requesting application MUST be able to request both the full composed <a
+ href="#contact-interface"><code>Contact</code></a> attribute and also be able to request individual parts of a composed <a
href="#contact-interface"><code>Contact</code></a> attribute in the <a>search qualifier</a> provided to a <a
href="#contacts-interface"><code>Contacts</code></a> <a
href="#widl-Contacts-find">find()</a> operation.
</p>
<p>
For example, the <code>name</code> attribute of a <a
- href="#contact-interface"><code>Contact</code></a> object is defined to be of complex type <a
+ href="#contact-interface"><code>Contact</code></a> object is defined to be of composed type <a
href="#contactname-interface"><code>ContactName</code></a>. Therefore, a requesting application may request either the full
- complex attribute (i.e. <code>name</code>) or specific individual attributes of this complex attribute (i.e.
+ composed attribute (i.e. <code>name</code>) or specific individual attributes of this composed attribute (i.e.
<code>name.formatted</code>, <code>name.familyName</code>, <code>name.givenName</code>, <code>name.middleName</code>,
<code>name.honorificPrefix</code>, <code>name.honorificSuffix</code>) as part of a <a
href="#contacts-interface"><code>Contacts</code></a> <a
href="#widl-Contacts-find">find()</a> operation's <a>search qualifier</a>.
</p>
<p>
- In the case that a complex <a
- href="#contact-interface"><code>Contact</code></a> attribute is defined as a sequence or array of complex objects, specific
- individual attributes can be referenced by using the complex attribute name, a dot (<code>.</code>) character and the
+ In the case that a composed <a
+ href="#contact-interface"><code>Contact</code></a> attribute is defined as a sequence or array of composed objects, specific
+ individual attributes can be referenced by using the composed attribute name, a dot (<code>.</code>) character and the
individual attribute to be retrieved.
</p>
<p>
For example, the <code>addresses</code> attribute of <a
href="#contact-interface"><code>Contact</code></a> allows multiple <a
href="#contactaddress-interface"><code>ContactAddress</code></a> objects to be defined. To request individual attributes of
- this complex attribute an application would request e.g. <code>addresses.locality</code>, <code>addresses.region</code>, etc.
+ this composed attribute an application would request e.g. <code>addresses.locality</code>, <code>addresses.region</code>, etc.
</p>
</section>
<div class="example">
@@ -1098,58 +1077,6 @@
href="#contact-interface"><code>Contact</code></a> objects, accessible as part of the sequence returned in the <a
href="#contactfindsuccesscb-interface"><code>ContactFindSuccessCB</code></a> callback function.
</p>
- <p>
- An implementation MUST specify a suitable integer-based <dfn>upper cardinality limit</dfn> to limit the maximum number of
- Contact objects that may be returned in the case that the <code>multiple</code> flag is <code>true</code> and the
- <code>limit</code> flag is <a>out of bounds</a>.
- </p>
- <p>
- If a <a
- href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is provided to the <a
- href="#contacts-interface"><code>Contacts</code></a> <a
- href="#widl-Contacts-find">find()</a> operation and its <code>limit</code> attribute is greater than zero and less than or
- equal to the implementation's <a>upper cardinality limit</a>, then <var>[X]</var> MUST be set to the provided
- <code>limit</code> value.
- </p>
- <p>
- The <code>limit</code> attribute is <dfn>out of bounds</dfn> if a <a
- href="#contactfindoptions-interface"><code>ContactFindOptions</code></a> object is provided to the <a
- href="#contacts-interface"><code>Contacts</code></a> <a
- href="#widl-Contacts-find">find()</a> operation and its <code>limit</code> attribute is less than or equal to zero or greater
- than the implementation's <a>upper cardinality limit</a>. In this case <var>[X]</var> MUST be set to the
- implementation's <a>upper cardinality limit</a>.
- </p>
- </section>
- <section>
- <h4>
- Search Sorting
- </h4>
- <p>
- The <a
- href="#contacts-interface"><code>Contacts</code></a> <a
- href="#widl-Contacts-find">find()</a> operation must return successful callback results according to the sorting guidelines
- defined in this section.
- </p>
- <p>
- A <dfn>search weight</dfn> is a numeric value defined for each attribute in a <a
- href="#contact-interface"><code>Contact</code></a> object. A lower value denotes a higher placing in the ultimate sorting of
- <a
- href="#contacts-interface"><code>Contacts</code></a> <a
- href="#widl-Contacts-find">find()</a> results. The <dfn>search weights</dfn> for each <a
- href="#contact-interface"><code>Contact</code></a> attribute are defined in <a
- href="#search-weights">Appendix B</a>.
- </p>
- <p>
- For example, if a <a>search filter</a> of 'Bob' matches to <code>name.givenName</code> in Object A and to
- <code>displayName</code> in Object B, Object B will be the first result object returned from the successCB of the given <a
- href="#contacts-interface"><code>Contacts</code></a> <a
- href="#widl-Contacts-find">find()</a> operation, followed by Object A.
- </p>
- <p
- class="note">
- Include UNICODE guidelines for intra-attribute sorting of results (where multiple Contact objects match on the same
- attribute)... [[!UNICODE]] DUCET
- </p>
</section>
<section>
<h3>
@@ -1186,7 +1113,7 @@
qualifier</a> contains 'name' and 'displayName', then the <a>rules for processing search filters</a> should
only be applied to all sub-fields of the <code>name</code> attribute (i.e. <code>name.formatted</code>,
<code>name.firstName</code>, <code>name.givenName</code>, <code>name.middleName</code>, <code>name.honorificPrefix</code>,
- <code>name.honorificSuffix</code>) and the <code>displayName</code> attribute.
+ <code>name.honorificSuffix</code>), the <code>displayName</code> attribute and the <code>id</code> attribute.
</p>
<p>
A <dfn>partial value match</dfn> refers to both syntactic and semantic partial matching of an input filter value with a
@@ -1223,7 +1150,7 @@
href="#contacts-interface"><code>Contacts</code></a> database.
<p>
Let <var
- title="contactsresult">contactsresult</var> be initially an empty Object object.
+ title="contactsresult">contactsresult</var> be initially an empty Array object.
</p>
</dd>
<dt>
@@ -1254,11 +1181,6 @@
Go to step 1.
</li>
<li>
- Sort <var
- title="contactsresult">contactsresult</var> according to the guidelines in <a
- href="#search-sorting">Search Sorting</a>.
- </li>
- <li>
Return <var
title="contactsresult">contactsresult</var>.
</li>
@@ -1365,14 +1287,11 @@
</pre>
<br>
All searches are case-insensitive and apply a <a>loose-matching policy</a> as defined in <a
- href="#search-filters">Search Filters</a>. Search ordering is sorted according to <a>search weights</a> defined in <a
- href="#search-filters">Search Filters</a> and described in <a
- href="#search-weights">Appendix B</a>.<br>
- <br>
- The <code>id</code> attribute is implicitly appended along with any <a>search filter</a> attributes provided, regardless
- of whether it was provided as a <a>search qualifier</a> from the requesting application, as defined in <a
href="#search-filters">Search Filters</a>.<br>
<br>
+ As noted in <a href="#search-filters">Search Filters</a>, the <code>id</code> attribute is implicitly appended along with any <a>search filter</a> attributes provided, regardless
+ of whether it was provided as a <a>search qualifier</a> from the requesting application.<br>
+ <br>
</li>
<li>
Return only the valid <a
@@ -1478,9 +1397,6 @@
The text components are separated by the SEMI-COLON character
(ASCII decimal 59).
-
- The property can include the "PREF" parameter to indicate the
- preferred account when more than one account is specified.
ABNF:
@@ -1613,504 +1529,6 @@
</p>
</section>
</section>
- <section
- class="appendix">
- <h2>
- Search Weights
- </h2>
- <p>
- The following table defines the <a>search weight</a> values for each <a>search qualifier</a> provided in this specification.
- </p>
- <table
- class="simple"
- summary="Search Weights by Search Qualifier">
- <thead>
- <tr>
- <th>
- <a>Search Qualifier</a>
- </th>
- <th>
- <a>Search Weight</a>
- </th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>
- <code>displayName</code>
- </td>
- <td>
- 1
- </td>
- </tr>
- <tr>
- <td>
- <code>name.formatted</code>
- </td>
- <td>
- 2
- </td>
- </tr>
- <tr>
- <td>
- <code>nickname</code>
- </td>
- <td>
- 3
- </td>
- </tr>
- <tr>
- <td>
- <code>tags.value</code>
- </td>
- <td>
- 4
- </td>
- </tr>
- <tr>
- <td>
- <code>phoneNumbers.value</code>
- </td>
- <td>
- 5
- </td>
- </tr>
- <tr>
- <td>
- <code>addresses.formatted</code>
- </td>
- <td>
- 6
- </td>
- </tr>
- <tr>
- <td>
- <code>organizations.name</code>
- </td>
- <td>
- 7
- </td>
- </tr>
- <tr>
- <td>
- <code>emails.value</code>
- </td>
- <td>
- 8
- </td>
- </tr>
- <tr>
- <td>
- <code>ims.value</code>
- </td>
- <td>
- 9
- </td>
- </tr>
- <tr>
- <td>
- <code>name.familyName</code>
- </td>
- <td>
- 10
- </td>
- </tr>
- <tr>
- <td>
- <code>name.givenName</code>
- </td>
- <td>
- 11
- </td>
- </tr>
- <tr>
- <td>
- <code>name.middleName</code>
- </td>
- <td>
- 12
- </td>
- </tr>
- <tr>
- <td>
- <code>addresses.country</code>
- </td>
- <td>
- 13
- </td>
- </tr>
- <tr>
- <td>
- <code>addresses.region</code>
- </td>
- <td>
- 14
- </td>
- </tr>
- <tr>
- <td>
- <code>addresses.streetAddress</code>
- </td>
- <td>
- 15
- </td>
- </tr>
- <tr>
- <td>
- <code>addresses.locality</code>
- </td>
- <td>
- 16
- </td>
- </tr>
- <tr>
- <td>
- <code>addresses.postalCode</code>
- </td>
- <td>
- 17
- </td>
- </tr>
- <tr>
- <td>
- <code>organizations.department</code>
- </td>
- <td>
- 18
- </td>
- </tr>
- <tr>
- <td>
- <code>organizations.title</code>
- </td>
- <td>
- 19
- </td>
- </tr>
- <tr>
- <td>
- <code>organizations.startDate</code>
- </td>
- <td>
- 20
- </td>
- </tr>
- <tr>
- <td>
- <code>organizations.endDate</code>
- </td>
- <td>
- 21
- </td>
- </tr>
- <tr>
- <td>
- <code>organizations.location</code>
- </td>
- <td>
- 22
- </td>
- </tr>
- <tr>
- <td>
- <code>organizations.description</code>
- </td>
- <td>
- 23
- </td>
- </tr>
- <tr>
- <td>
- <code>photos.value</code>
- </td>
- <td>
- 24
- </td>
- </tr>
- <tr>
- <td>
- <code>relationships.value</code>
- </td>
- <td>
- 25
- </td>
- </tr>
- <tr>
- <td>
- <code>urls.value</code>
- </td>
- <td>
- 26
- </td>
- </tr>
- <tr>
- <td>
- <code>gender</code>
- </td>
- <td>
- 27
- </td>
- </tr>
- <tr>
- <td>
- <code>birthday</code>
- </td>
- <td>
- 28
- </td>
- </tr>
- <tr>
- <td>
- <code>anniversary</code>
- </td>
- <td>
- 29
- </td>
- </tr>
- <tr>
- <td>
- <code>updated</code>
- </td>
- <td>
- 30
- </td>
- </tr>
- <tr>
- <td>
- <code>utcOffset</code>
- </td>
- <td>
- 31
- </td>
- </tr>
- <tr>
- <td>
- <code>notes</code>
- </td>
- <td>
- 32
- </td>
- </tr>
- <tr>
- <td>
- <code>name.honorificPrefix</code>
- </td>
- <td>
- 33
- </td>
- </tr>
- <tr>
- <td>
- <code>name.honorificSuffix</code>
- </td>
- <td>
- 34
- </td>
- </tr>
- <tr>
- <td>
- <code>phoneNumbers.type</code>
- </td>
- <td>
- 35
- </td>
- </tr>
- <tr>
- <td>
- <code>addresses.type</code>
- </td>
- <td>
- 36
- </td>
- </tr>
- <tr>
- <td>
- <code>emails.type</code>
- </td>
- <td>
- 37
- </td>
- </tr>
- <tr>
- <td>
- <code>ims.type</code>
- </td>
- <td>
- 38
- </td>
- </tr>
- <tr>
- <td>
- <code>tags.type</code>
- </td>
- <td>
- 39
- </td>
- </tr>
- <tr>
- <td>
- <code>photos.type</code>
- </td>
- <td>
- 40
- </td>
- </tr>
- <tr>
- <td>
- <code>relationships.type</code>
- </td>
- <td>
- 41
- </td>
- </tr>
- <tr>
- <td>
- <code>urls.type</code>
- </td>
- <td>
- 42
- </td>
- </tr>
- <tr>
- <td>
- <code>id</code>
- </td>
- <td>
- 43
- </td>
- </tr>
- <tr>
- <td>
- <code>phoneNumbers.primary</code>
- </td>
- <td>
- n/a (boolean attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>addresses.primary</code>
- </td>
- <td>
- n/a (boolean attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>emails.primary</code>
- </td>
- <td>
- n/a (boolean attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>ims.primary</code>
- </td>
- <td>
- n/a (boolean attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>tags.primary</code>
- </td>
- <td>
- n/a (boolean attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>photos.primary</code>
- </td>
- <td>
- n/a (boolean attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>relationships.primary</code>
- </td>
- <td>
- n/a (boolean attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>urls.primary</code>
- </td>
- <td>
- n/a (boolean attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>phoneNumbers</code>
- </td>
- <td>
- n/a (complex attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>addresses</code>
- </td>
- <td>
- n/a (complex attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>emails</code>
- </td>
- <td>
- n/a (complex attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>ims</code>
- </td>
- <td>
- n/a (complex attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>photos</code>
- </td>
- <td>
- n/a (complex attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>tags</code>
- </td>
- <td>
- n/a (complex attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>relationships</code>
- </td>
- <td>
- n/a (complex attribute)
- </td>
- </tr>
- <tr>
- <td>
- <code>urls</code>
- </td>
- <td>
- n/a (complex attribute)
- </td>
- </tr>
- </tbody>
- </table>
- <br>
- </section>
</body>
</html>
Received on Tuesday, 21 September 2010 08:49:42 UTC