Updated API docs, added AuthenticatedUser, ExternalMethod, MailHost,
PropertySheet, PropertySheets, Request, Response and
ZSQLMethod. (adding to trunk)...

lib/python/Products/OFSP/help/ExternalMethod.py

+##############################################################################
+# 
+# Zope Public License (ZPL) Version 1.0
+# -------------------------------------
+# 
+# Copyright (c) Digital Creations.  All rights reserved.
+# 
+# This license has been certified as Open Source(tm).
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+# 1. Redistributions in source code must retain the above copyright
+#    notice, this list of conditions, and the following disclaimer.
+# 
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions, and the following disclaimer in
+#    the documentation and/or other materials provided with the
+#    distribution.
+# 
+# 3. Digital Creations requests that attribution be given to Zope
+#    in any manner possible. Zope includes a "Powered by Zope"
+#    button that is installed by default. While it is not a license
+#    violation to remove this button, it is requested that the
+#    attribution remain. A significant investment has been put
+#    into Zope, and this effort will continue if the Zope community
+#    continues to grow. This is one way to assure that growth.
+# 
+# 4. All advertising materials and documentation mentioning
+#    features derived from or use of this software must display
+#    the following acknowledgement:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    In the event that the product being advertised includes an
+#    intact Zope distribution (with copyright and license included)
+#    then this clause is waived.
+# 
+# 5. Names associated with Zope or Digital Creations must not be used to
+#    endorse or promote products derived from this software without
+#    prior written permission from Digital Creations.
+# 
+# 6. Modified redistributions of any form whatsoever must retain
+#    the following acknowledgment:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    Intact (re-)distributions of any official Zope release do not
+#    require an external acknowledgement.
+# 
+# 7. Modifications are encouraged but must be packaged separately as
+#    patches to official Zope releases.  Distributions that do not
+#    clearly separate the patches from the original work must be clearly
+#    labeled as unofficial distributions.  Modifications which do not
+#    carry the name Zope may be packaged in any form, as long as they
+#    conform to all of the clauses above.
+# 
+# 
+# Disclaimer
+# 
+#   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
+#   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+#   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
+#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#   SUCH DAMAGE.
+# 
+# 
+# This software consists of contributions made by Digital Creations and
+# many individuals on behalf of Digital Creations.  Specific
+# attributions are listed in the accompanying credits file.
+# 
+##############################################################################
+
+
+class ExternalMethod:
+    """
+
+    Web-callable functions that encapsulate external python functions.
+
+    The function is defined in an external file.  This file is treated
+    like a module, but is not a module.  It is not imported directly,
+    but is rather read and evaluated.  The file must reside in the
+    'Extensions' subdirectory of the Zope installation, or in an
+    'Extensions' subdirectory of a product directory.
+
+    Due to the way ExternalMethods are loaded, it is not *currently*
+    possible to use Python modules that reside in the 'Extensions'
+    directory.  It is possible to load modules found in the
+    'lib/python' directory of the Zope installation, or in
+    packages that are in the 'lib/python' directory.
+
+    """
+
+    def manage_edit(self, title, module, function, REQUEST=None):
+        """
+
+        Change the external method
+
+        See the description of manage_addExternalMethod for a
+        descriotion of the arguments 'module' and 'function'.
+
+        Note that calling 'manage_edit' causes the "module" to be
+        effectively reloaded.  This is useful during debugging to see
+        the effects of changes, but can lead to problems of functions
+        rely on shared global data.
+
+        """
+
+    def __call__(self, *args, **kw):
+
+        """
+
+        Call an ExternalMethod
+
+        Calling an External Method is roughly equivalent to calling
+        the original actual function from Python.  Positional and
+        keyword parameters can be passed as usual.  Note however that
+        unlike the case of a normal Python method, the "self" argument
+        must be passed explicitly.  An exception to this rule is made
+        if:
+
+        - The supplied number of arguments is one less than the
+          required number of arguments, and
+
+        - The name of the function\'s first argument is 'self'.
+
+        In this case, the URL parent of the object is supplied as the
+        first argument.
+
+        """

lib/python/Products/OFSP/help/MailHost.py

+##############################################################################
+# 
+# Zope Public License (ZPL) Version 1.0
+# -------------------------------------
+# 
+# Copyright (c) Digital Creations.  All rights reserved.
+# 
+# This license has been certified as Open Source(tm).
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+# 1. Redistributions in source code must retain the above copyright
+#    notice, this list of conditions, and the following disclaimer.
+# 
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions, and the following disclaimer in
+#    the documentation and/or other materials provided with the
+#    distribution.
+# 
+# 3. Digital Creations requests that attribution be given to Zope
+#    in any manner possible. Zope includes a "Powered by Zope"
+#    button that is installed by default. While it is not a license
+#    violation to remove this button, it is requested that the
+#    attribution remain. A significant investment has been put
+#    into Zope, and this effort will continue if the Zope community
+#    continues to grow. This is one way to assure that growth.
+# 
+# 4. All advertising materials and documentation mentioning
+#    features derived from or use of this software must display
+#    the following acknowledgement:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    In the event that the product being advertised includes an
+#    intact Zope distribution (with copyright and license included)
+#    then this clause is waived.
+# 
+# 5. Names associated with Zope or Digital Creations must not be used to
+#    endorse or promote products derived from this software without
+#    prior written permission from Digital Creations.
+# 
+# 6. Modified redistributions of any form whatsoever must retain
+#    the following acknowledgment:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    Intact (re-)distributions of any official Zope release do not
+#    require an external acknowledgement.
+# 
+# 7. Modifications are encouraged but must be packaged separately as
+#    patches to official Zope releases.  Distributions that do not
+#    clearly separate the patches from the original work must be clearly
+#    labeled as unofficial distributions.  Modifications which do not
+#    carry the name Zope may be packaged in any form, as long as they
+#    conform to all of the clauses above.
+# 
+# 
+# Disclaimer
+# 
+#   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
+#   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+#   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
+#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#   SUCH DAMAGE.
+# 
+# 
+# This software consists of contributions made by Digital Creations and
+# many individuals on behalf of Digital Creations.  Specific
+# attributions are listed in the accompanying credits file.
+# 
+##############################################################################
+
+
+class MailHost:
+    """
+
+    MailHost objects work as adapters to Simple Mail Transfer Protocol
+    (SMTP) servers.  MailHosts are used by <dtml-sendmail> tags to
+    find the proper host to deliver mail to.
+
+    """
+
+    
+    def send(self, messageText, mto=None, mfrom=None, subject=None,
+             encode=None):
+        """
+
+        Sends mail.
+
+        messageText - Is the body of the mail message.
+
+        mto - is a string or list of recipient(s) of the message.
+
+        mfrom - is the address of the message sender.
+
+        subject - is the subject of the message.
+
+        encode - is the rfc822 defined encoding of the message.  The
+        default of 'None' means no encoding is done.  Valid values are
+        'base64', 'quoted-printable' and 'uuencode'.
+
+        """
+
+
+    

lib/python/Products/OFSP/help/PropertySheet.py

@@ -102,6 +102,8 @@ class PropertySheet:
         there is no default namespace for a given property sheet
         (especially property sheets added in ZClass definitions).
 
+        Permission -
+
         """
 
     def getProperty(self, id, d=None):
@@ -110,6 +112,8 @@ class PropertySheet:
         Get the property 'id', returning the optional second 
         argument or None if no such property is found.
 
+        Permission -
+        
         """
 
     def getPropertyType(self, id):
@@ -118,38 +122,44 @@ class PropertySheet:
         Get the type of property 'id'.  returns None if no such
         property exists.
 
+        Permission -
+        
         """
 
     def hasProperty(self, id):
         """
 
         Returns true if 'self' has a property with the given 'id', 
-        false otherwise. This method is protected by the 'Access 
-        contents information' permission.
+        false otherwise.
+
+        Permission - 'Access contents information'
 
         """
 
     def propertyIds(self):
         """
 
-        Returns a list of property ids. This method is protected by 
-        the 'Access contents information' permission.
+        Returns a list of property ids.
+
+        Permission - 'Access contents information'
 
         """
 
     def propertyValues(self):
         """
 
-        Returns a list of actual property values. This method is 
-        protected by the 'Access contents information' permission.
+        Returns a list of actual property values.
+
+        Permission - 'Access contents information'
 
         """
 
     def propertyItems(self):
         """
 
-        Return a list of (id, property) tuples. This method is 
-        protected by the 'Access contents information' permission.
+        Return a list of (id, property) tuples.
+
+        Permission - 'Access contents information'
 
         """
         
@@ -158,6 +168,8 @@ class PropertySheet:
 
         Returns a tuple of mappings, giving meta-data for properties.
 
+        Perimssion - 
+
         """
 
     def propertyInfo(self):
@@ -165,6 +177,8 @@ class PropertySheet:
 
         Returns a mapping containing property meta-data.
 
+        Permission
+
         """
 
     def manage_addProperty(self, id, value, type, REQUEST=None):
@@ -189,8 +203,9 @@ class PropertySheet:
         object will be rendered and returned.
 
         This method may be called via the web, from DTML or from
-        Python code. It is protected by the 'Manage properties'
-        permission.
+        Python code.
+
+        Permission - 'Manage Properties'
 
         """
 
@@ -216,8 +231,9 @@ class PropertySheet:
         success.
 
         This method may be called via the web, from DTML or from
-        Python code. It is protected by the 'Manage properties'
-        permission.
+        Python code.
+
+        Permission - 'Manage Properties'
 
         """
 
@@ -243,8 +259,9 @@ class PropertySheet:
         object will be rendered and returned.
 
         This method may be called via the web, from DTML or from
-        Python code. It is protected by the 'Manage properties'
-        permission.
+        Python code.
+
+        Permission - 'Manage Properties'
 
         """
 

lib/python/Products/OFSP/help/PropertySheets.py

@@ -110,6 +110,8 @@ class PropertySheets:
         Return a sequence of all of the PropertySheet objects for
         in the collection.
 
+        Permission -
+        
         """
 
     def items(self):
@@ -118,6 +120,8 @@ class PropertySheets:
         Return a sequence containing an '(id, object)' tuple for
         each PropertySheet object in the collection.
 
+        Permission - 
+
         """
 
     def get(self, name, default=None):
@@ -126,4 +130,6 @@ class PropertySheets:
         Return the PropertySheet identified by 'name', or the value
         given in 'default' if the named PropertySheet is not found.
 
+        Permission -
+        
         """

lib/python/Products/OFSP/help/Request.py

+##############################################################################
+# 
+# Zope Public License (ZPL) Version 1.0
+# -------------------------------------
+# 
+# Copyright (c) Digital Creations.  All rights reserved.
+# 
+# This license has been certified as Open Source(tm).
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+# 1. Redistributions in source code must retain the above copyright
+#    notice, this list of conditions, and the following disclaimer.
+# 
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions, and the following disclaimer in
+#    the documentation and/or other materials provided with the
+#    distribution.
+# 
+# 3. Digital Creations requests that attribution be given to Zope
+#    in any manner possible. Zope includes a "Powered by Zope"
+#    button that is installed by default. While it is not a license
+#    violation to remove this button, it is requested that the
+#    attribution remain. A significant investment has been put
+#    into Zope, and this effort will continue if the Zope community
+#    continues to grow. This is one way to assure that growth.
+# 
+# 4. All advertising materials and documentation mentioning
+#    features derived from or use of this software must display
+#    the following acknowledgement:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    In the event that the product being advertised includes an
+#    intact Zope distribution (with copyright and license included)
+#    then this clause is waived.
+# 
+# 5. Names associated with Zope or Digital Creations must not be used to
+#    endorse or promote products derived from this software without
+#    prior written permission from Digital Creations.
+# 
+# 6. Modified redistributions of any form whatsoever must retain
+#    the following acknowledgment:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    Intact (re-)distributions of any official Zope release do not
+#    require an external acknowledgement.
+# 
+# 7. Modifications are encouraged but must be packaged separately as
+#    patches to official Zope releases.  Distributions that do not
+#    clearly separate the patches from the original work must be clearly
+#    labeled as unofficial distributions.  Modifications which do not
+#    carry the name Zope may be packaged in any form, as long as they
+#    conform to all of the clauses above.
+# 
+# 
+# Disclaimer
+# 
+#   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
+#   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+#   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
+#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#   SUCH DAMAGE.
+# 
+# 
+# This software consists of contributions made by Digital Creations and
+# many individuals on behalf of Digital Creations.  Specific
+# attributions are listed in the accompanying credits file.
+# 
+##############################################################################
+
+
+
+class Request:
+
+    """
+
+    The request object encapsulates all of the information regarding
+    the current request in Zope.  This includes, the input headers,
+    form data, server data, and cookies.
+
+    The request object is a mapping object that represents a
+    collection of variable to value mappings.  In addition, variables
+    are divided into four categories:
+
+      - Environment variables
+
+        These variables include input headers, server data, and other
+        request-related data.  The variable names are as <a
+        href="http://hoohoo.ncsa.uiuc.edu/cgi/env.html">specified</a>
+        in the <a
+        href="http://hoohoo.ncsa.uiuc.edu/cgi/interface.html">CGI
+        specification</a>
+
+      - Form data
+
+        These are data extracted from either a URL-encoded query
+        string or body, if present.
+
+      - Cookies
+
+        These are the cookie data, if present.
+
+      - Other
+
+        Data that may be set by an application object.
+
+    The request object may be used as a mapping object, in which case
+    values will be looked up in the order: environment variables,
+    other variables, form data, and then cookies.
+
+    """
+
+
+    def set(name, value):
+        """
+
+        Create a new name in the REQUEST object and assign it a value.
+        This name and value is stored in the 'Other' category.
+
+        Permission - Always available
+        
+        """
+
+        
+    def get_header(self, name, default=None):
+        """
+
+        Return the named HTTP header, or an optional default argument
+        or None if the header is not found. Note that both original
+        and CGI-ified header names are recognized,
+        e.g. 'Content-Type', 'CONTENT_TYPE' and 'HTTP_CONTENT_TYPE'
+        should all return the Content-Type header, if available.
+
+        Permission - Always available
+        
+        """
+
+
+    def has_key(self, key):
+        """
+
+        Returns a true value if the REQUEST object contains key,
+        returns a false value otherwise.
+
+        Permission - Always available
+        
+        """
+
+
+    def keys(self):
+        """
+
+        Returns a sorted sequence of all keys in the REQUEST object.
+
+        Permission - Always available
+        
+        """
+
+    def items(self):
+        """
+
+        Returns a sequence of (key, value) tuples for all the keys in
+        the REQUEST object.
+
+        Permission - Always available
+        
+        """
+
+    def values(self):
+        """
+
+        Returns a sequence of values for all the keys in the REQUEST
+        object.
+
+        Permission - Always available
+        
+        """

lib/python/Products/OFSP/help/Response.py

+##############################################################################
+# 
+# Zope Public License (ZPL) Version 1.0
+# -------------------------------------
+# 
+# Copyright (c) Digital Creations.  All rights reserved.
+# 
+# This license has been certified as Open Source(tm).
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+# 1. Redistributions in source code must retain the above copyright
+#    notice, this list of conditions, and the following disclaimer.
+# 
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions, and the following disclaimer in
+#    the documentation and/or other materials provided with the
+#    distribution.
+# 
+# 3. Digital Creations requests that attribution be given to Zope
+#    in any manner possible. Zope includes a "Powered by Zope"
+#    button that is installed by default. While it is not a license
+#    violation to remove this button, it is requested that the
+#    attribution remain. A significant investment has been put
+#    into Zope, and this effort will continue if the Zope community
+#    continues to grow. This is one way to assure that growth.
+# 
+# 4. All advertising materials and documentation mentioning
+#    features derived from or use of this software must display
+#    the following acknowledgement:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    In the event that the product being advertised includes an
+#    intact Zope distribution (with copyright and license included)
+#    then this clause is waived.
+# 
+# 5. Names associated with Zope or Digital Creations must not be used to
+#    endorse or promote products derived from this software without
+#    prior written permission from Digital Creations.
+# 
+# 6. Modified redistributions of any form whatsoever must retain
+#    the following acknowledgment:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    Intact (re-)distributions of any official Zope release do not
+#    require an external acknowledgement.
+# 
+# 7. Modifications are encouraged but must be packaged separately as
+#    patches to official Zope releases.  Distributions that do not
+#    clearly separate the patches from the original work must be clearly
+#    labeled as unofficial distributions.  Modifications which do not
+#    carry the name Zope may be packaged in any form, as long as they
+#    conform to all of the clauses above.
+# 
+# 
+# Disclaimer
+# 
+#   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
+#   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+#   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
+#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#   SUCH DAMAGE.
+# 
+# 
+# This software consists of contributions made by Digital Creations and
+# many individuals on behalf of Digital Creations.  Specific
+# attributions are listed in the accompanying credits file.
+# 
+##############################################################################
+
+
+class Response:
+
+    """
+
+    The Response object represents the response to a Zope request.
+
+    """
+
+    def setStatus(self, status, reason=None):
+        '''
+        
+        Sets the HTTP status code of the response; the argument may
+        either be an integer or one of the following strings:
+
+          { OK,
+            Created,
+            Accepted,
+            NoContent,
+            MovedPermanently,
+            MovedTemporarily,
+            NotModified,
+            BadRequest,
+            Unauthorized,
+            Forbidden,
+            NotFound,
+            InternalError,
+            NotImplemented,
+            BadGateway,
+            ServiceUnavailable
+          }
+
+        that will be converted to the correct integer value.
+
+        Permission - Always available
+
+        '''
+
+    def setHeader(self, name, value, literal=0):
+        '''
+        
+        Sets an HTTP return header "name" with value "value", clearing
+        the previous value set for the header, if one exists. If the
+        literal flag is true, the case of the header name is
+        preserved, otherwise word-capitalization will be performed on
+        the header name on output.
+
+        Permission - Always available
+
+        '''
+
+    def addHeader(self, name, value):
+        '''
+        
+        Set a new HTTP return header with the given value, while
+        retaining any previously set headers with the same name.
+
+        Permission - Always available
+        
+        '''
+
+    def setBody(self, body, title='', is_error=0):
+        '''
+        
+        Set the body of the response
+        
+        Sets the return body equal to the (string) argument
+        "body". Also updates the "content-length" return header.
+
+        You can also specify a title, in which case the title and body
+        will be wrapped up in html, head, title, and body tags.
+
+        If the body is a 2-element tuple, then it will be treated as
+        (title,body)
+        
+        If is_error is true then the HTML will be formatted as a Zope
+        error message instead of a generic HTML page.
+
+        Permission - Always available
+        
+        '''
+
+    def setBase(self,base):
+        """
+
+        Set the base URL for the returned document.
+
+        Permission - Always available
+        
+        """
+
+    def appendCookie(self, name, value):
+        '''
+        
+        Returns an HTTP header that sets a cookie on cookie-enabled
+        browsers with a key "name" and value "value". If a value for the
+        cookie has previously been set in the response object, the new
+        value is appended to the old one separated by a colon.
+
+        Permission - Always available
+        
+        '''
+
+
+    def expireCookie(self, name, **kw):
+        '''
+        
+        Cause an HTTP cookie to be removed from the browser
+        
+        The response will include an HTTP header that will remove the cookie
+        corresponding to "name" on the client, if one exists. This is
+        accomplished by sending a new cookie with an expiration date
+        that has already passed. Note that some clients require a path
+        to be specified - this path must exactly match the path given
+        when creating the cookie. The path can be specified as a keyword
+        argument.
+
+        Permission - Always available
+        
+        '''
+
+    def setCookie(self,name,value,**kw):
+        '''
+        
+        Set an HTTP cookie on the browser
+
+        The response will include an HTTP header that sets a cookie on
+        cookie-enabled browsers with a key "name" and value
+        "value". This overwrites any previously set value for the
+        cookie in the Response object.
+
+        Permission - Always available
+        
+        '''
+
+    def appendHeader(self, name, value, delimiter=","):
+        '''
+        
+        Append a value to a cookie
+        
+        Sets an HTTP return header "name" with value "value",
+        appending it following a comma if there was a previous value
+        set for the header.
+
+        Permission - Always available
+        
+        '''
+
+    def redirect(self, location):
+        """
+
+        Cause a redirection without raising an error
+
+        Permission - Always available
+        
+        """

lib/python/Products/OFSP/help/ZSQLMethod.py

+##############################################################################
+# 
+# Zope Public License (ZPL) Version 1.0
+# -------------------------------------
+# 
+# Copyright (c) Digital Creations.  All rights reserved.
+# 
+# This license has been certified as Open Source(tm).
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are
+# met:
+# 
+# 1. Redistributions in source code must retain the above copyright
+#    notice, this list of conditions, and the following disclaimer.
+# 
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions, and the following disclaimer in
+#    the documentation and/or other materials provided with the
+#    distribution.
+# 
+# 3. Digital Creations requests that attribution be given to Zope
+#    in any manner possible. Zope includes a "Powered by Zope"
+#    button that is installed by default. While it is not a license
+#    violation to remove this button, it is requested that the
+#    attribution remain. A significant investment has been put
+#    into Zope, and this effort will continue if the Zope community
+#    continues to grow. This is one way to assure that growth.
+# 
+# 4. All advertising materials and documentation mentioning
+#    features derived from or use of this software must display
+#    the following acknowledgement:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    In the event that the product being advertised includes an
+#    intact Zope distribution (with copyright and license included)
+#    then this clause is waived.
+# 
+# 5. Names associated with Zope or Digital Creations must not be used to
+#    endorse or promote products derived from this software without
+#    prior written permission from Digital Creations.
+# 
+# 6. Modified redistributions of any form whatsoever must retain
+#    the following acknowledgment:
+# 
+#      "This product includes software developed by Digital Creations
+#      for use in the Z Object Publishing Environment
+#      (http://www.zope.org/)."
+# 
+#    Intact (re-)distributions of any official Zope release do not
+#    require an external acknowledgement.
+# 
+# 7. Modifications are encouraged but must be packaged separately as
+#    patches to official Zope releases.  Distributions that do not
+#    clearly separate the patches from the original work must be clearly
+#    labeled as unofficial distributions.  Modifications which do not
+#    carry the name Zope may be packaged in any form, as long as they
+#    conform to all of the clauses above.
+# 
+# 
+# Disclaimer
+# 
+#   THIS SOFTWARE IS PROVIDED BY DIGITAL CREATIONS ``AS IS'' AND ANY
+#   EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+#   IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+#   PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL DIGITAL CREATIONS OR ITS
+#   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+#   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+#   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
+#   USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+#   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+#   OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+#   OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+#   SUCH DAMAGE.
+# 
+# 
+# This software consists of contributions made by Digital Creations and
+# many individuals on behalf of Digital Creations.  Specific
+# attributions are listed in the accompanying credits file.
+# 
+##############################################################################
+
+
+class ZSQLMethod:
+    """
+
+    ZSQLMethods abstract SQL code in Zope.
+    
+        They support three important abstractions:
+
+      - Method
+
+        SQL Methods behave like methods of the folders they are
+        accessed in.  In particular, they can be used from other
+        methods, like Documents, ExternalMethods, and even other SQL
+        Methods.
+
+      - Searchability
+
+        Database methods support the Searchable Object Interface.
+        Search interface wizards can be used to build user
+        interfaces to them.  They can be used in joins and
+        unions. They provide meta-data about their input parameters
+        and result data.
+
+        For more information, see the searchable-object interface
+        specification. 
+
+      - Containment
+
+        Database methods support URL traversal to access and invoke
+        methods on individual record objects. For example, suppose you
+        had an 'employees' database method that took a single argument
+        'employee_id'.  Suppose that employees had a 'service_record'
+        method (defined in a record class or acquired from a
+        folder). The 'service_record' method could be accessed with a
+        URL like::
+
+           employees/employee_id/1234/service_record
+
+    """
+
+
+    def __call__(self, REQUEST=None, __ick__=None, src__=0, test__=0, **kw):
+        """
+
+        Call the ZSQLMethod.
+
+        The arguments to the method should be passed via keyword
+        arguments, or in a single mapping object. If no arguments are
+        given, and if the method was invoked through the Web, then the
+        method will try to acquire and use the Web REQUEST object as
+        the argument mapping.
+
+        The returned value is a sequence of record objects.
+
+        """
+