org.apache.jackrabbit.webdav.jcr.version.report

Class LocateCorrespondingNodeReport

java.lang.Object

org.apache.jackrabbit.webdav.jcr.version.report.AbstractJcrReport

org.apache.jackrabbit.webdav.jcr.version.report.LocateCorrespondingNodeReport

All Implemented Interfaces:

Report, XmlSerializable

public class LocateCorrespondingNodeReport
extends AbstractJcrReport

LocateCorrespondingNodeReport is used to identify the resource that represents the corresponding node in another workspace.

The request body must be a 'dcr:locate-corresponding-node' XML element, that contains the href of the source workspace, where the corresponding node should be searched:

 <!ELEMENT locate-corresponding-node ( workspace ) >
 <!ELEMENT workspace ( href ) >  (as defined by RFC 3253)
 

The response to a successful report request must be a 'dcr:locate-corresponding-node-report' element that contains the href of the corresponding node in the given source workspace:

 <!ELEMENT locate-corresponding-node-report ( href ) >
 

See Also:

Node.getCorrespondingNodePath(String)

Field Summary

Fields

Modifier and Type	Field and Description
static ReportType	LOCATE_CORRESPONDING_NODE_REPORT The corresponding-node report type

Constructor Summary

Constructors

Constructor and Description
LocateCorrespondingNodeReport()

Method Summary

Modifier and Type	Method and Description
ReportType	getType() Returns LOCATE_CORRESPONDING_NODE_REPORT
void	init(DavResource resource, ReportInfo info) Performs basic validation checks common to all JCR specific reports.
boolean	isMultiStatusReport() Always returns false.
Element	toXml(Document document) Returns the xml representation of the implementing object as Element.

Methods inherited from class java.lang.Object

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

Field Detail

LOCATE_CORRESPONDING_NODE_REPORT

public static final ReportType LOCATE_CORRESPONDING_NODE_REPORT

The corresponding-node report type

Constructor Detail

LocateCorrespondingNodeReport

public LocateCorrespondingNodeReport()

Method Detail

getType

public ReportType getType()

Returns LOCATE_CORRESPONDING_NODE_REPORT

Returns:

always returns LOCATE_CORRESPONDING_NODE_REPORT

See Also:

Report.getType()

isMultiStatusReport

public boolean isMultiStatusReport()

Always returns false.

Returns:

false

See Also:

Report.isMultiStatusReport()

init

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

Description copied from class: AbstractJcrReport

Performs basic validation checks common to all JCR specific reports.

Specified by:

init in interface Report

Overrides:

init in class AbstractJcrReport

Throws:

DavException

See Also:

Report.init(DavResource, ReportInfo)

toXml

public Element toXml(Document document)

Description copied from interface: XmlSerializable

Returns the xml representation of the implementing object as Element. The given Document is used as factory and represents the owner document of the returned DOM element.

Parameters:

document - to be used as factory.

Returns:

a w3c element representing this object

See Also:

XmlSerializable.toXml(Document)