org.apache.jackrabbit.webdav.version.report

Class LocateByHistoryReport

java.lang.Object

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

All Implemented Interfaces:

DeltaVConstants, Report, XmlSerializable

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, 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
LocateByHistoryReport()

Method Summary

Modifier and Type	Method and Description
ReportType	getType() Returns ReportType.LOCATE_BY_HISTORY.
void	init(DavResource resource, ReportInfo info) Set the DeltaVResource for which this report was requested and the ReportInfo as specified by the REPORT request body, that defines the details for this report. Please note that this methods should perform basic validation checks in order to prevent exceptional situations during the xml serialization.
boolean	isMultiStatusReport() Always returns true.
Element	toXml(Document document) 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()

Returns ReportType.LOCATE_BY_HISTORY.

Specified by:

getType in interface Report

Returns:

the type of this report.

See Also:

Report.getType()

init

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

Description copied from interface: Report

Set the DeltaVResource for which this report was requested and the ReportInfo as specified by the REPORT request body, that defines the details for this report.
Please note that this methods should perform basic validation checks in order to prevent exceptional situations during the xml serialization.

Specified by:

init in interface Report

Throws:

DavException

See Also:

Report.init(DavResource, ReportInfo)

isMultiStatusReport

public boolean isMultiStatusReport()

Always returns true.

Specified by:

isMultiStatusReport in interface Report

Returns:

true

See Also:

Report.isMultiStatusReport()

toXml

public Element toXml(Document document)

Run the report.

Specified by:

toXml in interface XmlSerializable

Parameters:

document -

Returns:

Xml Document representing the report in the required format.

See Also:

XmlSerializable.toXml(Document)