org.apache.jackrabbit.webdav.version.report
Interface Report

All Known Implementing Classes:

ExpandPropertyReport, LocateByHistoryReport, VersionTreeReport

public interface Report

The Report interface defines METHODS needed in order to respond to a REPORT request. The REPORT method is a required feature to all DeltaV resources.

See Also:

DeltaVResource.getReport(ReportInfo)

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 for which this report was requested.
org.jdom.Document	toXml() Returns the report Xml document defined by the this ReportType.

Method Detail

getType

public ReportType getType()

Returns the registered type of this report.

Returns:

the type of this report.

setResource

public void setResource(DeltaVResource resource)

Set the DeltaVResource for which this report was requested.

Parameters:

resource -

setInfo

public void setInfo(ReportInfo info)

Set the ReportInfo as specified by the REPORT request body, that defines the details for this report.

Parameters:

info - providing in detail requirements for this report.

toXml

public org.jdom.Document toXml()
                        throws DavException

Returns the report Xml document defined by the this ReportType. The document will be returned in the response body.

Returns:

Xml Document object representing the generated report in the proper format.

Throws:

DavException - if an error occurs while running the report or creating the Document.