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

java.lang.Object
  extended byorg.apache.jackrabbit.webdav.version.report.VersionTreeReport
All Implemented Interfaces:
DeltaVConstants, Report

public class VersionTreeReport
extends Object
implements Report, DeltaVConstants

VersionTreeReport encapsulates the DAV:version-tree report. It describes the requested properties of all the versions in the version history of a version. The DAV:version-tree report must be supported by all version resources and all version-controlled resources.


Field Summary
 
Fields inherited from interface org.apache.jackrabbit.webdav.version.DeltaVConstants
ATTR_NAME, ATTR_NAMESPACE, COMMENT, CREATOR_DISPLAYNAME, HEADER_LABEL, HEADER_LOCATION, NAMESPACE, SUPPORTED_LIVE_PROPERTY_SET, SUPPORTED_METHOD_SET, SUPPORTED_REPORT_SET, WORKSPACE, XML_ACTIVITY, XML_ACTIVITY_COLLECTION_SET, XML_BASELINE, XML_CHECKOUT, XML_CHECKOUT_CHECKIN, XML_CHECKOUT_UNLOCK_CHECKIN, XML_EXPAND_PROPERTY, XML_LABEL, XML_LABEL_ADD, XML_LABEL_NAME, XML_LABEL_REMOVE, XML_LABEL_SET, XML_LOCATE_BY_HISTORY, XML_LOCKED_CHECKIN, XML_MERGE, XML_N0_AUTO_MERGE, XML_N0_CHECKOUT, XML_OPTIONS, XML_OPTIONS_RESPONSE, XML_PROPERTY, XML_REPORT, XML_SUPPORTED_METHOD, XML_SUPPORTED_REPORT, XML_UPDATE, XML_VERSION, XML_VERSION_HISTORY, XML_VERSION_HISTORY_SET, XML_VERSION_TREE, XML_VH_COLLECTION_SET, XML_WORKSPACE, XML_WSP_COLLECTION_SET
 
Constructor Summary
VersionTreeReport()
           
 
Method Summary
 ReportType getType()
          Returns the registered type of this report.
 void setInfo(ReportInfo info)
          Set the ReportInfo as specified by the REPORT request body, that defines the details for this report.
 void setResource(DeltaVResource resource)
          Set the DeltaVResource used to register this report.
 org.jdom.Document toXml()
          Runs the DAV:version-tree report.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

VersionTreeReport

public VersionTreeReport()
Method Detail

getType

public ReportType getType()
Description copied from interface: Report
Returns the registered type of this report.

Specified by:
getType in interface Report
Returns:
the type of this report.

setResource

public void setResource(DeltaVResource resource)
                 throws IllegalArgumentException
Set the DeltaVResource used to register this report.

Specified by:
setResource in interface Report
Parameters:
resource -
Throws:
IllegalArgumentException - if the given resource is neither VersionControlledResource nor VersionResource.
See Also:
Report.setResource(org.apache.jackrabbit.webdav.version.DeltaVResource)

setInfo

public void setInfo(ReportInfo info)
             throws IllegalArgumentException
Set the ReportInfo as specified by the REPORT request body, that defines the details for this report.

Specified by:
setInfo in interface Report
Parameters:
info -
Throws:
IllegalArgumentException - if the given ReportInfo does not contain a DAV:version-tree element.
See Also:
Report.setInfo(ReportInfo)

toXml

public org.jdom.Document toXml()
                        throws DavException
Runs the DAV:version-tree report.

Specified by:
toXml in interface Report
Returns:
Xml Document representing the report in the required format.
Throws:
DavException - if the resource or the info field are null or if any other error occurs.
See Also:
Report.toXml()


Copyright © 2005 . All Rights Reserved.