org.apache.jackrabbit.webdav.version.report
Class ReportInfo

java.lang.Object
  extended byorg.apache.jackrabbit.webdav.version.report.ReportInfo

public class ReportInfo
extends Object

The ReportInfo class encapsulates the body of a REPORT request. RFC 3253 the top Xml element being the name of the requested report. In addition a Depth header may be present (default value: DavConstants.DEPTH_0).


Constructor Summary
ReportInfo(org.jdom.Element reportElement, int depth)
          Create a new ReportInfo object.
 
Method Summary
 int getDepth()
          Returns the depth field.
 DavPropertyNameSet getPropertyNameSet()
          Returns a DavPropertyNameSet providing the property names present in an eventual DavConstants.XML_PROP child element.
 org.jdom.Element getReportElement()
          Returns the Xml element specifying the requested report.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReportInfo

public ReportInfo(org.jdom.Element reportElement,
                  int depth)
Create a new ReportInfo object.

Parameters:
reportElement -
depth - Depth value as retrieved from the DavConstants.HEADER_DEPTH.
Method Detail

getReportElement

public org.jdom.Element getReportElement()
Returns the Xml element specifying the requested report.

Returns:
reportElement

getDepth

public int getDepth()
Returns the depth field. The request must be applied separately to the collection itself and to all members of the collection that satisfy the depth value.

Returns:
depth

getPropertyNameSet

public DavPropertyNameSet getPropertyNameSet()
Returns a DavPropertyNameSet providing the property names present in an eventual DavConstants.XML_PROP child element. If no such child element is present an empty set is returned.

Returns:
DavPropertyNameSet providing the property names present in an eventual DAV:prop child element or an empty set.


Copyright © 2005 . All Rights Reserved.