org.apache.jackrabbit.webdav.version.report

Class VersionTreeReport

java.lang.Object

org.apache.jackrabbit.webdav.version.report.AbstractReport

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

All Implemented Interfaces:

DeltaVConstants, Report, XmlSerializable

public class VersionTreeReport
extends AbstractReport
implements 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, VERSION_CONTROLLED_CONFIGURATION, 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

Constructors

Constructor and Description
VersionTreeReport()

Method Summary

Modifier and Type	Method and Description
ReportType	getType() Returns ReportType.VERSION_TREE
void	init(DavResource resource, ReportInfo info) Validates the specified resource and info objects.
boolean	isMultiStatusReport() Always returns true.
org.w3c.dom.Element	toXml(org.w3c.dom.Document document) Runs the DAV:version-tree report.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VersionTreeReport

public VersionTreeReport()

Method Detail

getType

public ReportType getType()

Returns ReportType.VERSION_TREE

Specified by:

getType in interface Report

Returns:

ReportType.VERSION_TREE

See Also:

Report.getType()

isMultiStatusReport

public boolean isMultiStatusReport()

Always returns true.

Specified by:

isMultiStatusReport in interface Report

Returns:

true

See Also:

Report.isMultiStatusReport()

init

public void init(DavResource resource,
                 ReportInfo info)
          throws DavException

Validates the specified resource and info objects.

Specified by:

init in interface Report

Parameters:

resource -

info -

Throws:

DavException

See Also:

Report.init(DavResource, ReportInfo)

toXml

public org.w3c.dom.Element toXml(org.w3c.dom.Document document)

Runs the DAV:version-tree report.

Specified by:

toXml in interface XmlSerializable

Parameters:

document -

Returns:

Xml Document representing the report in the required format.

See Also:

XmlSerializable.toXml(Document)