Interface Report
-
- All Superinterfaces:
XmlSerializable
- All Known Implementing Classes:
AbstractReport,AbstractSecurityReport,AclPrincipalReport,CompareBaselineReport,ExpandPropertyReport,LatestActivityVersionReport,LocateByHistoryReport,PrincipalMatchReport,PrincipalSearchReport,SearchablePropertyReport,VersionTreeReport
public interface Report extends XmlSerializable
TheReportinterface 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
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ReportTypegetType()Returns the registered type of this report.voidinit(DavResource resource, ReportInfo info)Set theDeltaVResourcefor which this report was requested and theReportInfoas 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.booleanisMultiStatusReport()Returns true if thisReportwill send aMultiStatusresponse.
Please note that RFC 3253 that the the response must be a 207 Multi-Status, if a Depth request header is present.-
Methods inherited from interface org.apache.jackrabbit.webdav.xml.XmlSerializable
toXml
-
-
-
-
Method Detail
-
getType
ReportType getType()
Returns the registered type of this report.- Returns:
- the type of this report.
-
isMultiStatusReport
boolean isMultiStatusReport()
Returns true if thisReportwill send aMultiStatusresponse.
Please note that RFC 3253 that the the response must be a 207 Multi-Status, if a Depth request header is present.- Returns:
-
init
void init(DavResource resource, ReportInfo info) throws DavException
Set theDeltaVResourcefor which this report was requested and theReportInfoas 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.- Parameters:
resource-info-- Throws:
DavException
-
-