- From: Robin Berjon via cvs-syncmail <cvsmail@w3.org>
- Date: Wed, 06 Apr 2011 15:29:08 +0000
- To: public-dap-commits@w3.org
Update of /sources/public/2009/dap/contacts
In directory hutz:/tmp/cvs-serv11383/contacts
Modified Files:
Overview.html
Log Message:
editorials, section 4
Index: Overview.html
===================================================================
RCS file: /sources/public/2009/dap/contacts/Overview.html,v
retrieving revision 1.123
retrieving revision 1.124
diff -u -d -r1.123 -r1.124
--- Overview.html 6 Apr 2011 14:13:05 -0000 1.123
+++ Overview.html 6 Apr 2011 15:29:06 -0000 1.124
@@ -727,34 +727,27 @@
<h2><a>ContactOrganization</a> interface</h2>
<p>
- The ContactOrganization interface is a reusable component that is used to support contact
- organizations within the <a href='#contact-interface'><code>Contact</code></a> interface.
+ The <a>ContactOrganization</a> interface is a reusable component that is used to support contact
+ organisations within the <a>Contact</a> interface.
</p>
<dl title='[NoInterfaceObject] interface ContactOrganization' class='idl'>
<dt>attribute DOMString name</dt>
-
<dd>
<p>
- This attribute contains the name of the Organization and MUST be assigned a non-null value.
+ The name of the organisation.
</p>
</dd>
-
<dt>attribute DOMString department</dt>
-
<dd>
<p>
- This attribute contains the Job Title information of the Contact associated with this
- Organization.
+ The department within which this <a>Contact</a> works.
</p>
</dd>
-
<dt>attribute DOMString title</dt>
-
<dd>
<p>
- This attribute contains the department information of the Organization associated with this
- Contact.
+ The job title that the <a>Contact</a> holds inside this organisation.
</p>
</dd>
</dl>
@@ -762,45 +755,33 @@
<section>
<h2><a>ContactFindOptions</a> interface</h2>
-
<p>
- The <a href='#contactfindoptions-interface'><code>ContactFindOptions</code></a> interface describes
- the options that can be applied to contact searching. When a <a href=
- '#contactfindoptions-interface'><code>ContactFindOptions</code></a> parameter is provided to the
- <a href="#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a>
- operation, it should be processed according to the provisions detailed in <a href=
- "#options-processing">Options Processing</a>.
+ The <a>ContactFindOptions</a> interface describes the options that can be applied to contact searching.
+ When a <a>ContactFindOptions</a> parameter is provided to the <a>Contacts</a> <a href="#widl-Contacts-find">find()</a>
+ operation, it should be processed according to the provisions detailed in
+ <a href="#options-processing">Options Processing</a>.
</p>
-
<dl title='[NoInterfaceObject] interface ContactFindOptions' class='idl'>
<dt>attribute DOMString? filter</dt>
-
- <dd>A DOMString-based <a>search filter</a> with which to search and initially filter the <a href=
- '#contacts-interface'><code>Contacts</code></a> database.</dd>
-
+ <dd>
+ A string-based <a>search filter</a> with which to search and initially filter the
+ <a>Contacts</a> database.
+ </dd>
<dt>attribute boolean? multiple</dt>
-
<dd>
- A boolean value to indicate whether multiple Contact objects are returnable as part of the
- associated <a href="#contacts-interface"><code>Contacts</code></a> <a href=
- "#widl-Contacts-find">find()</a> operation.
-
- <p>
+ A boolean value to indicate whether multiple Contact objects are wanted as part of the
+ <a>Contacts</a> <a href="#widl-Contacts-find">find()</a> operation.
By default this option is set to <code>true</code>.
- </p>
</dd>
-
<dt>attribute Date? updatedSince</dt>
-
<dd>
<p>
- Return only contact records that have been updated on or after the given time, specified as an
- ECMAScript <code>Date</code> object.
+ 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 applied to the <a href="#widl-Contact-revision"><code>revision</code></a> field
- as defined in <a href="#contact-interface"><code>Contact</code></a>.
+ This filter is applied to the <a href="#widl-Contact-revision"><code>revision</code></a> field
+ as defined in <a>Contact</a>.
</p>
</dd>
</dl>
@@ -808,46 +789,40 @@
<section>
<h2><a>ContactFindCB</a> interface</h2>
+ <p>
+ This is the wrapper interface for callbacks indicating success of the <a href="#widl-Contacts-find">find()</a>
+ operation.
+ </p>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ContactFindCB : EventTarget' class='idl'>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ContactFindCB' class='idl'>
<dt>void onsuccess ()</dt>
-
<dd>
- <!-- interface description here -->
-
<dl class='parameters'>
<dt>Contact[] contactObjs</dt>
-
- <dd>The Contact objects resulting from the given <a href=
- "#contacts-interface"><code>Contacts</code></a> <a href="#widl-Contacts-find">find()</a> method.
- <a href="#contacts-interface"><code>Contacts</code></a> <a href=
- "#widl-Contacts-find">find()</a></dd>
+ <dd>
+ An array of <a>Contact</a> objects resulting from the given <a>Contacts</a>
+ <a href="#widl-Contacts-find">find()</a> operation.
+ </dd>
</dl>
</dd>
</dl>
<section>
<h3>Event Handler Attributes</h3>
-
<p>
- The following is the <a>event handler attribute</a> (and its corresponding <a>event handler event
- type</a>) that MUST be supported as a DOM attribute by the <a href=
- "#contactfindcb-interface"><code>ContactFindCB</code></a> object.
+ The following is the <a>event handler attribute</a> (and its corresponding <a>event handler event
+ type</a>) that MUST be supported as a DOM attribute by the <a>ContactFindCB</a> object.
</p>
-
<table class='simple'>
<thead>
<tr>
<th><a>event handler attribute</a></th>
-
<th><a>event handler event type</a></th>
</tr>
</thead>
-
<tbody>
<tr>
- <td><strong><code><strong>onsuccess</strong></code></strong></td>
-
+ <td><strong><code>onsuccess</code></strong></td>
<td><code>success</code></td>
</tr>
</tbody>
@@ -856,44 +831,39 @@
</section>
<section>
- <h2><a>ContactErrorCB</a> interface</h2><!-- interface intro here -->
+ <h2><a>ContactErrorCB</a> interface</h2>
+ <p>
+ This is the wrapper interface for callbacks indicating failure of the <a href="#widl-Contacts-find">find()</a>
+ operation.
+ </p>
- <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ContactErrorCB : EventTarget' class='idl'>
+ <dl title='[Callback=FunctionOnly, NoInterfaceObject] interface ContactErrorCB' class='idl'>
<dt>void onerror ()</dt>
-
<dd>
- <!-- interface description here -->
-
<dl class='parameters'>
<dt>ContactError error</dt>
-
- <dd>The Contact API related error object.</dd>
+ <dd>The <a>ContactError</a> object capturing the type of the error.</dd>
</dl>
</dd>
</dl>
<section>
<h3>Event Handler Attributes</h3>
-
<p>
- The following is the <a>event handler attribute</a> (and its corresponding <a>event handler event
- type</a>) that MUST be supported as a DOM attribute by the <a href=
- "#contacterrorcb-interface"><code>ContactErrorCB</code></a> object.
+ The following is the <a>event handler attribute</a> (and its corresponding <a>event handler event
+ type</a>) that MUST be supported as a DOM attribute by the <a>ContactErrorCB</a> object.
</p>
<table class='simple'>
<thead>
<tr>
<th><a>event handler attribute</a></th>
-
<th><a>event handler event type</a></th>
</tr>
</thead>
-
<tbody>
<tr>
<td><strong><code><strong>onerror</strong></code></strong></td>
-
<td><code>error</code></td>
</tr>
</tbody>
@@ -903,51 +873,40 @@
<section>
<h2><a>ContactError</a> interface</h2>
-
<p>
- The <a href='#contacterror-interface'><code>ContactError</code></a> interface encapsulates all
- errors in the manipulation of <a href='#contact-interface'><code>Contact</code></a> objects in the
- Contacts API.
+ The <a>ContactError</a> interface encapsulates all errors in the manipulation of
+ <a>Contact</a> objects.
</p>
<dl title='[NoInterfaceObject] interface ContactError' class='idl'>
<dt>const unsigned short UNKNOWN_ERROR = 0</dt>
-
<dd>An unknown error occurred.</dd>
<dt>const unsigned short INVALID_ARGUMENT_ERROR = 1</dt>
-
<dd>An invalid parameter was provided when the requested method was invoked.</dd>
<dt>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 = 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>
+ <dd>There is already a <a>task</a> in the <a>device task source</a>.</dd>
<dt>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 = 5</dt>
-
<dd>The requested method is not supported by the current implementation.</dd>
<dt>const unsigned short PERMISSION_DENIED_ERROR = 20</dt>
-
- <dd>Access to the requested method was denied at the implementation or by the user.</dd>
+ <dd>Access to the requested information was denied by the implementation or by the user.</dd>
<dt>readonly attribute unsigned short code</dt>
-
<dd>An error code assigned by an implementation when an error has occurred in Contacts API
processing.</dd>
</dl>
</section>
- </section><!-- end api description section -->
+ </section>
<section>
<h2><a>Contact Search Processing</a></h2>
Received on Wednesday, 6 April 2011 15:29:10 UTC