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+)>
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 and Description |
---|
LocateByHistoryReport() |
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.
|
public ReportType getType()
ReportType.LOCATE_BY_HISTORY
.getType
in interface Report
Report.getType()
public void init(DavResource resource, ReportInfo info) throws DavException
Report
DeltaVResource
for which this report was requested
and the ReportInfo
as specified by the REPORT request body,
that defines the details for this report.init
in interface Report
DavException
Report.init(DavResource, ReportInfo)
public boolean isMultiStatusReport()
true
.isMultiStatusReport
in interface Report
Report.isMultiStatusReport()
public Element toXml(Document document)
toXml
in interface XmlSerializable
document
- Document
representing the report in the required
format.XmlSerializable.toXml(Document)
Copyright © 2004–2021 The Apache Software Foundation. All rights reserved.