- From: Richard Tibbett via cvs-syncmail <cvsmail@w3.org>
- Date: Tue, 03 Aug 2010 11:00:27 +0000
- To: public-dap-commits@w3.org
Update of /sources/public/2009/dap/contacts
In directory hutz:/tmp/cvs-serv17509/contacts
Modified Files:
Overview.html
Log Message:
Folder ContactProperties in to Contact. No need to have seperate objects for these elements as searching rules and processes apply to both interfaces equally.
Index: Overview.html
===================================================================
RCS file: /sources/public/2009/dap/contacts/Overview.html,v
retrieving revision 1.68
retrieving revision 1.69
diff -u -d -r1.68 -r1.69
--- Overview.html 3 Aug 2010 10:51:35 -0000 1.68
+++ Overview.html 3 Aug 2010 11:00:25 -0000 1.69
@@ -253,10 +253,10 @@
</p>
<p>
Multiple contact groups can be represented within this unified address book by specifying consistent <a
- href='#widl-ContactProperties-tags'><code>tags</code></a> value(s) as part of individual <a
+ href='#widl-Contact-tags'><code>tags</code></a> value(s) as part of individual <a
href="#contact-interface"><code>Contact</code></a> objects. Multiple contact groups can be displayed by filtering on the
required <a
- href='#widl-ContactProperties-tags'><code>tags</code></a> value(s) via the <code>Contacts</code> <a
+ href='#widl-Contact-tags'><code>tags</code></a> value(s) via the <code>Contacts</code> <a
href='#widl-Contacts-find'>find()</a> function.
</p>
<dl
@@ -323,10 +323,23 @@
<h2>
<a>Contact</a> interface
</h2>
+ <p
+ class="note">
+ The use of Portable Contacts schema as the format for contacts is subject to further discussions in the group.
+ </p>
<p>
The <a
- href="#contact-interface"><code>Contact</code></a> interface captures a single contact item. This interface extends <a
- href='#contactproperties-interface'><code>ContactProperties</code></a> attributes.
+ href="#contact-interface"><code>Contact</code></a> interface captures the properties of a contact object.
+ All properties included in this interface have a corresponding definition in [[!POCO-SCHEMA]].
+ </p>
+ <p>
+ In addition to the properties defined in this interface, a conforming implementation MUST support both the Singular and Plural
+ OpenSocial fields defined in [[!POCO-SCHEMA]].
+ </p>
+ <p
+ class="note">
+ The inclusion of OpenSocial fields in the paragraph above needs further explanation, particularly in relation to contact database
+ searching and sorting.
</p>
<p>
All <a
@@ -339,7 +352,7 @@
href="#contact-interface"><code>Contact</code></a> object and MUST have a value of <code>null</code>.
</p>
<dl
- title='[NoInterfaceObject] interface Contact : ContactProperties'
+ title='[NoInterfaceObject] interface Contact'
class='idl'>
<dt>
readonly attribute DOMString id
@@ -357,34 +370,7 @@
See [[[!POCO-SCHEMA]] Section 7.2.1. <code>id</code>] for additional definition of this attribute.
</p>
</dd>
- </dl>
- </section>
- <section>
- <h2>
- <a>ContactProperties</a> interface
- </h2>
- <p
- class="note">
- The use of Portable Contacts schema as the format for contacts is subject to further discussions in the group.
- </p>
- <p>
- The <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> interface captures the settable properties of a contact.
- All properties included in this interface have a corresponding definition in [[!POCO-SCHEMA]].
- </p>
- <p>
- In addition to the properties defined in this interface, a conforming implementation MUST support both the Singular and Plural
- OpenSocial fields defined in [[!POCO-SCHEMA]].
- </p>
- <p
- class="note">
- The inclusion of OpenSocial fields in the paragraph above needs further explanation, particularly in relation to contact database
- searching and sorting.
- </p>
- <dl
- title='[NoInterfaceObject] interface ContactProperties'
- class='idl'>
- <dt>
+ <dt>
attribute DOMString displayName
</dt>
<dd>
@@ -633,7 +619,7 @@
</h2>
<p>
The ContactField interface is a reusable component that is used to support contact fields within the <a
- href='#contactproperties-interface'><code>ContactProperties</code></a> interface.
+ href='#contact-interface'><code>Contact</code></a> interface.
</p>
<dl
title='[NoInterfaceObject] interface ContactField'
@@ -670,7 +656,7 @@
</h2>
<p>
The ContactAddress interface is a reusable component that is used to support contact addresses within the <a
- href='#contactproperties-interface'><code>ContactProperties</code></a> interface.
+ href='#contact-interface'><code>Contact</code></a> interface.
</p>
<dl
title='[NoInterfaceObject] interface ContactAddress'
@@ -731,7 +717,7 @@
</h2>
<p>
The ContactOrganization interface is a reusable component that is used to support contact organizations within the <a
- href='#contactproperties-interface'><code>ContactProperties</code></a> interface.
+ href='#contact-interface'><code>Contact</code></a> interface.
</p>
<dl
title='[NoInterfaceObject] interface ContactOrganization'
@@ -800,7 +786,7 @@
</h2>
<p>
The ContactAccount interface is a reusable component that is used to support contact accounts within the <a
- href='#contactproperties-interface'><code>ContactProperties</code></a> interface.
+ href='#contact-interface'><code>Contact</code></a> interface.
</p>
<dl
title='[NoInterfaceObject] interface ContactAccount'
@@ -886,8 +872,8 @@
</p>
<p>
This filter is based on the <a
- href="#widl-ContactProperties-updated"><code>updated</code></a> field as defined in <a
- href="#contactproperties-interface"><code>ContactProperties</code></a>.
+ href="#widl-Contact-updated"><code>updated</code></a> field as defined in <a
+ href="#contact-interface"><code>Contact</code></a>.
</p>
</dd>
</dl>
@@ -1034,7 +1020,7 @@
</h3>
<p>
The <dfn>search qualifier</dfn> provides an application with a way to request the specific subset of <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> it wishes to obtain in any resulting successful callback.
+ href="#contact-interface"><code>Contact</code></a> properties it wishes to obtain in any resulting successful callback.
The <a>search qualifier</a> is deployed to minimize the data that needs to be shared with an application in order to let that
application fulfill its function on behalf of the user. The <a>search qualifier</a> is included within a <a
href="#contacts-interface"><code>Contacts</code></a> <a
@@ -1049,19 +1035,19 @@
If the <a>search qualifier</a> provided is of <em>zero-length</em> then the current <a
href="#contacts-interface"><code>Contacts</code></a> <a
href="#widl-Contacts-find">find()</a> operation MUST NOT return any <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> within any resulting <a
+ href="#contact-interface"><code>Contact</code></a> properties within any resulting <a
href="#contact-interface"><code>Contact</code></a> object(s).
</p>
<p>
In the case that the <a>search qualifier</a> provided is of <em>non-zero-length</em> then the current <a
href="#contacts-interface"><code>Contacts</code></a> <a
href="#widl-Contacts-find">find()</a> operation MUST return only the matching <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> within any resulting <a
+ href="#contact-interface"><code>Contact</code></a> properties within any resulting <a
href="#contact-interface"><code>Contact</code></a> object(s).
</p>
<p>
If a provided <a>search qualifier</a> element (<code>filter[x]</code>) does not match a <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> attribute, <code>filter[x]</code> SHOULD be ignored when
+ href="#contact-interface"><code>Contact</code></a> attribute, <code>filter[x]</code> SHOULD be ignored when
executing the current <a
href="#contacts-interface"><code>Contacts</code></a> <a
href="#widl-Contacts-find">find()</a> operation.
@@ -1072,21 +1058,21 @@
</h3>
<p>
Certain <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> attributes can be considered complex by the fact that
+ href="#contact-interface"><code>Contact</code></a> attributes can be considered complex by the fact that
the information they contain is available only through child DOMString-based attributes of a complex Object object.
</p>
<p>
In such cases, a requesting application MUST be able to request both the full complex <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> attribute and also be able to request individual parts
+ href="#contact-interface"><code>Contact</code></a> attribute and also be able to request individual parts
of a complex <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> attribute in the <a>search qualifier</a> provided to 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
- href="#contactproperties-interface"><code>ContactProperties</code></a> is defined to be of complex type <a
+ 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="#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.
<code>name.formatted</code>, <code>name.familyName</code>, <code>name.givenName</code>, <code>name.middleName</code>,
@@ -1096,13 +1082,13 @@
</p>
<p>
In the case that a complex <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> attribute is defined as a sequence or array of complex
+ 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 individual attribute to be retrieved.
</p>
<p>
For example, the <code>addresses</code> attribute of <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> allows multiple <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.
</p>
@@ -1131,9 +1117,9 @@
<ol>
<li>
Return only the valid <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> requested in the provided <a>search qualifier</a>
+ href="#contact-interface"><code>Contact</code></a> attributes requested in the provided <a>search qualifier</a>
(<code>name</code>, <code>emails.value</code> - <code>friends</code> is not a valid <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> attribute so ignore this element).
+ href="#contact-interface"><code>Contact</code></a> attribute so ignore this element).
</li>
</ol>
</section>
@@ -1202,7 +1188,7 @@
<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="#contactproperties-interface"><code>ContactProperties</code></a> field are defined in <a
+ href="#contact-interface"><code>Contact</code></a> attribute are defined in <a
href="#search-weights">Appendix B</a>.
</p>
<p>
@@ -1232,13 +1218,12 @@
</p>
<p>
A <a>search filter</a> is used to search <a
- href='#contactproperties-interface'><code>ContactProperties</code></a> within the <a
+ href='#contact-interface'><code>Contact</code></a> attributes within the <a
href="#contacts-interface"><code>Contacts</code></a> database and represents the logical union, or <code>∪</code>, of
provided values that are matched therein.
</p>
<p>
- All contact searching MUST apply a <dfn>loose-matching policy</dfn> to the <a>search filter</a> provided. If a <a
- href='#contactproperties-interface'><code>ContactProperties</code></a> attribute being searched in a <a
+ All contact searching MUST apply a <dfn>loose-matching policy</dfn> to the <a>search filter</a> provided. If an attribute being searched in a <a
href='#contact-interface'><code>Contact</code></a> object, stored within the <a
href='#contacts-interface'><code>Contacts</code></a> database, is a <a>partial value match</a> of the input <code>filter</code> value, that
<a
@@ -1442,7 +1427,7 @@
</li>
<li>
Return only the valid <a
- href="#contactproperties-interface"><code>ContactProperties</code></a> requested in the provided <a>search qualifier</a>
+ href="#contact-interface"><code>Contact</code></a> properties requested in the provided <a>search qualifier</a>
(<code>name</code>, <code>addresses.locality</code>, <code>addresses.country</code>, <code>phoneNumbers</code>,
<code>emails</code>) and only for the <a
href="#contact-interface"><code>Contact</code></a> objects returned from the <a>rules for processing search filters</a>
Received on Tuesday, 3 August 2010 11:00:29 UTC