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

Class NodeTypesReport

java.lang.Object

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

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

All Implemented Interfaces:

org.apache.jackrabbit.commons.webdav.NodeTypeConstants, org.apache.jackrabbit.webdav.version.report.Report, org.apache.jackrabbit.webdav.xml.XmlSerializable

public class NodeTypesReport
extends AbstractJcrReport
implements org.apache.jackrabbit.commons.webdav.NodeTypeConstants

NodeTypesReport allows to retrieve the definition of a single or multiple node types. The request body must be a 'dcr:nodetypes' element:

 <!ELEMENT nodetypes ( nodetype+ | all-nodetypes | mixin-nodetypes | primary-nodetypes ) >

 <!ELEMENT nodetype ( nodetypename ) >
 <!ELEMENT nodetypename (#PCDATA) >

 <!ELEMENT all-nodetypes EMPTY >
 <!ELEMENT mixin-nodetypes EMPTY >
 <!ELEMENT primary-nodetypes EMPTY >
 

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.jackrabbit.webdav.version.report.ReportType	NODETYPES_REPORT The registered type of this report.

Fields inherited from interface org.apache.jackrabbit.commons.webdav.NodeTypeConstants

AUTOCREATED_ATTRIBUTE, AVAILABLE_QUERY_OPERATOR_ELEMENT, AVAILABLE_QUERY_OPERATORS_ELEMENT, CHILDNODEDEFINITION_ELEMENT, DECLARINGNODETYPE_ATTRIBUTE, DEFAULTPRIMARYTYPE_ATTRIBUTE, DEFAULTVALUE_ELEMENT, DEFAULTVALUES_ELEMENT, FULL_TEXT_SEARCHABLE_ATTRIBUTE, HASORDERABLECHILDNODES_ATTRIBUTE, ISABSTRACT_ATTRIBUTE, ISMIXIN_ATTRIBUTE, ISQUERYABLE_ATTRIBUTE, MANDATORY_ATTRIBUTE, MULTIPLE_ATTRIBUTE, NAME_ATTRIBUTE, NODETYPE_ELEMENT, NODETYPES_ELEMENT, ONPARENTVERSION_ATTRIBUTE, PRIMARYITEMNAME_ATTRIBUTE, PROPERTYDEFINITION_ELEMENT, PROTECTED_ATTRIBUTE, QUERY_ORDERABLE_ATTRIBUTE, REQUIREDPRIMARYTYPE_ELEMENT, REQUIREDPRIMARYTYPES_ELEMENT, REQUIREDTYPE_ATTRIBUTE, SAMENAMESIBLINGS_ATTRIBUTE, SUPERTYPE_ELEMENT, SUPERTYPES_ELEMENT, VALUECONSTRAINT_ELEMENT, VALUECONSTRAINTS_ELEMENT, XML_NODETYPE, XML_NODETYPENAME, XML_NODETYPES, XML_REPORT_ALLNODETYPES, XML_REPORT_MIXINNODETYPES, XML_REPORT_PRIMARYNODETYPES

Constructor Summary

Constructors

Constructor and Description
NodeTypesReport()

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.jackrabbit.webdav.version.report.ReportType	getType() Returns NODETYPES_REPORT type.
void	init(org.apache.jackrabbit.webdav.DavResource resource, org.apache.jackrabbit.webdav.version.report.ReportInfo info) Performs basic validation checks common to all JCR specific reports.
boolean	isMultiStatusReport() Always returns false.
Element	toXml(Document document) Returns a Xml representation of the node type definition(s) according to the info object.

Methods inherited from class java.lang.Object

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

Field Detail

NODETYPES_REPORT

public static final org.apache.jackrabbit.webdav.version.report.ReportType NODETYPES_REPORT

The registered type of this report.

Constructor Detail

NodeTypesReport

public NodeTypesReport()

Method Detail

getType

public org.apache.jackrabbit.webdav.version.report.ReportType getType()

Returns NODETYPES_REPORT type.

Specified by:

getType in interface org.apache.jackrabbit.webdav.version.report.Report

Returns:

NODETYPES_REPORT

See Also:

Report.getType()

isMultiStatusReport

public boolean isMultiStatusReport()

Always returns false.

Specified by:

isMultiStatusReport in interface org.apache.jackrabbit.webdav.version.report.Report

Returns:

false

See Also:

Report.isMultiStatusReport()

init

public void init(org.apache.jackrabbit.webdav.DavResource resource,
        org.apache.jackrabbit.webdav.version.report.ReportInfo info)
          throws org.apache.jackrabbit.webdav.DavException

Description copied from class: AbstractJcrReport

Performs basic validation checks common to all JCR specific reports.

Specified by:

init in interface org.apache.jackrabbit.webdav.version.report.Report

Overrides:

init in class AbstractJcrReport

Throws:

org.apache.jackrabbit.webdav.DavException

See Also:

Report.init(DavResource, ReportInfo)

toXml

public Element toXml(Document document)

Returns a Xml representation of the node type definition(s) according to the info object.

Specified by:

toXml in interface org.apache.jackrabbit.webdav.xml.XmlSerializable

Parameters:

document -

Returns:

Xml representation of the node type definition(s)

See Also:

XmlSerializable.toXml(Document)