[CalendarServer-changes] [12302] twext/trunk/twext/who/ldap/_constants.py

[source_changes at macosforge.org]

Revision: 12302
          http://trac.calendarserver.org//changeset/12302
Author:   wsanchez at apple.com
Date:     2014-01-11 09:14:57 -0800 (Sat, 11 Jan 2014)
Log Message:
-----------
Docs

Modified Paths:
--------------
    twext/trunk/twext/who/ldap/_constants.py

Modified: twext/trunk/twext/who/ldap/_constants.py
===================================================================
--- twext/trunk/twext/who/ldap/_constants.py	2014-01-11 16:36:26 UTC (rev 12301)
+++ twext/trunk/twext/who/ldap/_constants.py	2014-01-11 17:14:57 UTC (rev 12302)
@@ -30,6 +30,18 @@
     """
     Constants for native LDAP match types.
 
+    For each constant defined, if there is an equivalent L{MatchType} constant,
+    the attribute C{matchType} reference that constant.  It is otherwise unset.
+
+    For each constant defined, the attribute C{queryString} will be a
+    L{unicode} format string that, when formatted, is an LDAP query string
+    (eg. C{(attribute=value)}).  The format string may reference the following
+    names:
+
+      - C{notOp} for the "not" operator, which may be C{u"!"} or C{u""}.
+      - C{attribute} for the name of the LDAP attribute to match.
+      - C{value} for the value to match against.
+
     @cvar any: Attribute has any value.
     @cvar equals: Attribute equals value.
     @cvar startsWith: Attribute starts with value.
@@ -39,7 +51,6 @@
     @cvar greaterThan: Attribute is greater than value.
     @cvar lessThanOrEqualTo: Attribute is less than or equal to value.
     @cvar greaterThanOrEqualTo: Attribute is greater than or equal to value.
-
     """
 
     any = NamedConstant()
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20140312/473ba6b8/attachment.html>