<?xml version="1.0" encoding="iso-8859-1"?>
<module name="Ft.Server.Client.Core.ResourceMetaDataClient" file="/work/a/ports/textproc/py-4suite/work/4Suite-1.0b1/build/lib.freebsd-8.0-RELEASE-p2-i386-2.4/Ft/Server/Client/Core/ResourceMetaDataClient.py">
  <modification-date>2005-03-28 11:27:38</modification-date>
  <abstract>ResourceMetaData repository resource client class.</abstract>
  <description>Copyright 2005 Fourthought, Inc. (USA).
Detailed license and copyright information: http://4suite.org/COPYRIGHT
Project home, documentation, distributions: http://4suite.org/</description>
  <classes>
    <class name="ResourceMetaDataClient" public="yes">
      <bases>
      </bases>
      <abstract>Every repository resource inherits from this class in order to
store and provide access to information about its existence.</abstract>
      <description/>
      <method-resolution-order>
        <base name="ResourceMetaDataClient" module="Ft.Server.Client.Core.ResourceMetaDataClient"/>
      </method-resolution-order>
      <methods documented="yes" class="ResourceMetaDataClient" module="Ft.Server.Client.Core.ResourceMetaDataClient" inherited="no">
        <method public="no" name="__cmp__" id="ResourceMetaDataClient-__cmp__">
          <abstract/>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="other"/>
          </arguments>
        </method>
        <method public="no" name="__hash__" id="ResourceMetaDataClient-__hash__">
          <abstract/>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="no" name="__init__" id="ResourceMetaDataClient-__init__">
          <abstract/>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="path"/>
            <arg name="connection"/>
            <arg name="resourceType"/>
            <arg name="root"/>
          </arguments>
        </method>
        <method public="no" name="__str__" id="ResourceMetaDataClient-__str__">
          <abstract>##########################################
#String interfaces
##########################################</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="addAcl" id="ResourceMetaDataClient-addAcl">
          <abstract>Add an acl identifier to the acl key.
If the specified key does not exist on the resource
this function has the same functionality of setAcl.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="aclKey"/>
            <arg name="aclIdent"/>
            <arg default="1" name="allowed"/>
          </arguments>
        </method>
        <method public="yes" name="addAlias" id="ResourceMetaDataClient-addAlias">
          <abstract>Adds an alias for this resource to the repository.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="path"/>
            <arg default="None" name="docDef"/>
          </arguments>
        </method>
        <method public="yes" name="addLiteralProperty" id="ResourceMetaDataClient-addLiteralProperty">
          <abstract>Adds a statement about this repository object,
with a literal property, to the model</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="predicate"/>
            <arg name="object"/>
            <arg default="''" name="scope"/>
            <arg default="''" name="statementUri"/>
          </arguments>
        </method>
        <method public="yes" name="addResourceProperty" id="ResourceMetaDataClient-addResourceProperty">
          <abstract>Adds a statement about this repository object, with a resource
property, to the model</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="predicate"/>
            <arg name="object"/>
            <arg default="''" name="scope"/>
            <arg default="''" name="statementUri"/>
          </arguments>
        </method>
        <method public="yes" name="applyXslt" id="ResourceMetaDataClient-applyXslt">
          <abstract>applies the specified chain of stylesheets (with the specified
transformation parameters) using the &quot;self&quot; object as source
chain - can be a list of transforms, in which case only one
        transform run will execute, with the list of transforms
        all used such that [a.xsl, b.xsl] is equivalent to
        adding an import of b.xsl to a.xsl and applying a.xsl
        can also be a list of lists of transforms, in which case
        a chain of transforms is run,
        one pass for each inner list.  The output of each
        step in the chain is fed as the input to the next
params - a dictionary giving the overridden top-level parameters
        for the transforms
ignorePis - whether or not to ignore &lt;xml-stylesheet processing
        instructions in the source document
extParams - a special dictionary of parameters that allows the
        processor to communicate special values back to the caller
extModules - a list of modules containing extension function and
        element implementations</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="chain"/>
            <arg default="None" name="params"/>
            <arg default="1" name="ignorePis"/>
            <arg default="None" name="extParams"/>
            <arg default="None" name="extModules"/>
          </arguments>
        </method>
        <method public="yes" name="asDom" id="ResourceMetaDataClient-asDom">
          <abstract>Return this object as a non-live DOM instance.
This means that any mutations to the returned DOM object will
not affect the content of this resource.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg default="None" name="stripElements"/>
          </arguments>
        </method>
        <method public="yes" name="delete" id="ResourceMetaDataClient-delete">
          <abstract>Delete this object from the repository</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="fetchResource" id="ResourceMetaDataClient-fetchResource">
          <abstract>Fetch a resource from the system.
path is a string.  The traverseAliases parameter is deprecated
and the new &quot;;traverse&quot; path arguments should be used.  As an
example, where before you could call:
resource.fetchResource('path', 1) now you would call
resource.fetchResource('path;traverse')</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="path"/>
          </arguments>
        </method>
        <method public="yes" name="getAbsolutePath" id="ResourceMetaDataClient-getAbsolutePath">
          <abstract>Get the full path into the system</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getAbsolutePathAsUri" id="ResourceMetaDataClient-getAbsolutePathAsUri">
          <abstract>Get the full path into the system, as an absolute URI string.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getAcl" id="ResourceMetaDataClient-getAcl">
          <abstract>Get a list of users and groups specified by the aclKey.
If an aclKey is specified, then the results will be a
list of dictionaries keyed by acl identifiers and with
values of ALLOWED or DISALLOWED (from AclConstants).  The
values in the list of dictionaries could be inherited from
the parent object. If no aclKey is specified, then the
results will be a nested dictionary.  The outer dictionary
is keyed by all of the defined acl keys on this resource.
Each value of the outer dictionary will be a dictionary
identical to when this method is called with a aclKey.
These results will not return any inherited values.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg default="None" name="aclKey"/>
          </arguments>
        </method>
        <method public="yes" name="getAclIdent" id="ResourceMetaDataClient-getAclIdent">
          <abstract>Get the ACL identifier for the current user (without expansion).</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getAclIdentifiers" id="ResourceMetaDataClient-getAclIdentifiers">
          <abstract>Get a list of all acl identifiers for the current users.
This is equivalent to performing an &quot;expandGroups&quot; of the
current user. It will also add things such as &quot;WORLD-GROUP&quot;
or &quot;USER-GROUP&quot; if they exist.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getAliases" id="ResourceMetaDataClient-getAliases">
          <abstract>Get a list of alias objects that reference this object</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getBasePath" id="ResourceMetaDataClient-getBasePath">
          <abstract>Get the base path of this object.
The only difference between this and getPath is that for all
non-container objects it will return the parent's path.
For a container object it will return its path.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getContent" id="ResourceMetaDataClient-getContent">
          <abstract>Get the string content of this resource</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getContentResource" id="ResourceMetaDataClient-getContentResource">
          <abstract>Get the resource the represents the content of this object</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getContentSlice" id="ResourceMetaDataClient-getContentSlice">
          <abstract>Get a piece of our content.  Really only makes sense for large raw files</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg default="None" name="start"/>
            <arg default="None" name="end"/>
          </arguments>
        </method>
        <method public="yes" name="getCreationDate" id="ResourceMetaDataClient-getCreationDate">
          <abstract>Get the date that this resource was created.
The date will be an ISO 8601 string like u'2002-08-16T22:49:56Z'.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getDisplayPath" id="ResourceMetaDataClient-getDisplayPath">
          <abstract>Get the path relative to the document root</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getImt" id="ResourceMetaDataClient-getImt">
          <abstract>Returns the Internet Media Type of the raw file resource</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getLastModifiedDate" id="ResourceMetaDataClient-getLastModifiedDate">
          <abstract>Get the date that this resource was last modified.
The date will be an ISO 8601 string like u'2002-08-16T22:49:56Z'.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getMetaDataResource" id="ResourceMetaDataClient-getMetaDataResource">
          <abstract>Get the string meta data of this resource</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getModel" id="ResourceMetaDataClient-getModel">
          <abstract>Retrieves the common model associated w/ the repository</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getName" id="ResourceMetaDataClient-getName">
          <abstract>Get the name of the resource.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getOwner" id="ResourceMetaDataClient-getOwner">
          <abstract>Get the owner of this resource</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getParent" id="ResourceMetaDataClient-getParent">
          <abstract>Get the parent container of this resource</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getPath" id="ResourceMetaDataClient-getPath">
          <abstract>Get the path of this resource</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getResourceType" id="ResourceMetaDataClient-getResourceType">
          <abstract>Get the type of this resource.
Types are defined in Ft.Server.Common.ResourceTypes.ResourceType.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getRoot" id="ResourceMetaDataClient-getRoot">
          <abstract>Get a reference to the system repository</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getSize" id="ResourceMetaDataClient-getSize">
          <abstract>Get the size of the content</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getStatementsAbout" id="ResourceMetaDataClient-getStatementsAbout">
          <abstract>Returns all statements about this object in the model</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getStatementsGeneratedBy" id="ResourceMetaDataClient-getStatementsGeneratedBy">
          <abstract>Returns all statements in the model generated by this object</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="getValidationInfo" id="ResourceMetaDataClient-getValidationInfo">
          <abstract>Get the validation information associated with this resource.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="hasResource" id="ResourceMetaDataClient-hasResource">
          <abstract>Query if the system has a resource specified by the path.
No exception will be raised by this function.  If the current
user cannot access the resource or the resource does not exist
in the repository, then the results will be 0.  If the resource
does exist, then the results will be the integer resource type
of the resource (see
Ft.Server.Common.ResourceTypes.ResourceTypes).</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="path"/>
          </arguments>
        </method>
        <method public="yes" name="inheritAcl" id="ResourceMetaDataClient-inheritAcl">
          <abstract>Remove the entire key from the ACL entry so that it is
inherited again from its parent</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="aclKey"/>
          </arguments>
        </method>
        <method public="yes" name="isResourceType" id="ResourceMetaDataClient-isResourceType">
          <abstract>Determine if this resource is of a certain type</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="testType"/>
          </arguments>
        </method>
        <method public="yes" name="markTemporary" id="ResourceMetaDataClient-markTemporary">
          <abstract>Mark this resource as temporary.  Temporary objects will be removed from the repository when thier
timeToLive has expired and purgeTemporaryResources is called the repository.
Time to live is seconds from now.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="timeToLive"/>
          </arguments>
        </method>
        <method public="yes" name="pprint" id="ResourceMetaDataClient-pprint">
          <abstract/>
          <description/>
          <arguments>
            <arg name="self"/>
          </arguments>
        </method>
        <method public="yes" name="removeAcl" id="ResourceMetaDataClient-removeAcl">
          <abstract>Remove the acl identifier from the acl key.
If the specified aclKey is not present on the resource or the
specified aclIdent is not in the key, then do nothing.
Remember that entries inherited from the parent are *not*
included in the acl on the actual resurce.  In order to
override inherited permissions, set to no access rather than
trying to remove.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="aclKey"/>
            <arg name="aclIdent"/>
          </arguments>
        </method>
        <method public="yes" name="removeAlias" id="ResourceMetaDataClient-removeAlias">
          <abstract>Removes the specified alias for this resource</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="path"/>
          </arguments>
        </method>
        <method public="yes" name="removeLiteralProperty" id="ResourceMetaDataClient-removeLiteralProperty">
          <abstract>Removes a statement about this repository object, with a literal property, from
the model</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="predicate"/>
            <arg name="object"/>
          </arguments>
        </method>
        <method public="yes" name="removeResourceProperty" id="ResourceMetaDataClient-removeResourceProperty">
          <abstract>Remove a statement about this repository object, with a resource preoperty, from
the model</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="predicate"/>
            <arg name="object"/>
          </arguments>
        </method>
        <method public="yes" name="setAcl" id="ResourceMetaDataClient-setAcl">
          <abstract>Replace the aclKey with a single entry of aclIdent.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="aclKey"/>
            <arg name="aclIdent"/>
            <arg default="1" name="allowed"/>
          </arguments>
        </method>
        <method public="yes" name="setContent" id="ResourceMetaDataClient-setContent">
          <abstract>Set the string content of this resource</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="src"/>
          </arguments>
        </method>
        <method public="yes" name="setOwner" id="ResourceMetaDataClient-setOwner">
          <abstract>Change the owner of this resource</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="newOwner"/>
          </arguments>
        </method>
        <method public="yes" name="toXPathContext" id="ResourceMetaDataClient-toXPathContext">
          <abstract>Create an XPath Context with the src of this RawFile.
nss is a dictionary of namespace definitions to include in the
context.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg default="None" name="nss"/>
          </arguments>
        </method>
        <method public="yes" name="verifyAcl" id="ResourceMetaDataClient-verifyAcl">
          <abstract>Test to see whether the current user (and the current users set
of acl identifiers) is allowed to perform the specified action,
aclKey, on the current object.  If verifyTraverse is specified,
then execute premissions are tested on all of the parents of
this resource as well.</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="aclKey"/>
            <arg default="1" name="verifyTraverse"/>
          </arguments>
        </method>
        <method public="yes" name="xUpdate" id="ResourceMetaDataClient-xUpdate">
          <abstract>Allows XML content to be updated with the XUpdate protocol</abstract>
          <description/>
          <arguments>
            <arg name="self"/>
            <arg name="updateSrc"/>
          </arguments>
        </method>
      </methods>
    </class>
  </classes>
</module>
