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

java.lang.Object
  org.apache.jackrabbit.webdav.version.report.LocateByHistoryReport

All Implemented Interfaces:

DeltaVConstants, Report

public class LocateByHistoryReport

extends Object

implements Report, DeltaVConstants

LocateByHistoryReport encapsulates the DAV:locate-by-hisotry report, that may be used to locate a version-controlled resource for that version history. The DAV:locate-by-history report can be applied to a collection to locate the collection member that is a version-controlled resource for a specified version history resource.

 <!ELEMENT locate-by-history (version-history-set, prop)>
 <!ELEMENT version-history-set (href+)>
 

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

LocateByHistoryReport()

Method Summary

ReportType	getType() Returns the registered type of this report.
void	setInfo(ReportInfo info) Set the ReportInfo
void	setResource(DeltaVResource resource) Set the DeltaVResource.
org.jdom.Document	toXml() Run the report.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocateByHistoryReport

public LocateByHistoryReport()

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:

See Also:

Report.getType()

setResource

public void setResource(DeltaVResource resource)
                 throws IllegalArgumentException

Set the DeltaVResource.

Specified by:

setResource in interface Report

Parameters:

resource -

Throws:

IllegalArgumentException - if the specified resource is not a VersionControlledResource.

See Also:

Report.setResource(org.apache.jackrabbit.webdav.version.DeltaVResource)

setInfo

public void setInfo(ReportInfo info)
             throws IllegalArgumentException

Set the ReportInfo

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

Run the report.

Specified by:

toXml in interface Report

Returns:

Xml Document representing the report in the required format.

Throws:

DavException

See Also:

Report.toXml()