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

java.lang.Object
  extended byorg.apache.jackrabbit.webdav.jcr.version.report.NodeTypesReport
All Implemented Interfaces:
NodeTypeConstants, org.apache.jackrabbit.webdav.version.report.Report

public class NodeTypesReport
extends Object
implements org.apache.jackrabbit.webdav.version.report.Report, 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 ( nodetype-name ) >
 <!ELEMENT nodetype-name (#PCDATA) >

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

See Also:
NodeTypeConstants.NAMESPACE

Field Summary
static org.apache.jackrabbit.webdav.version.report.ReportType NODETYPES_REPORT
          The registered type of this report.
 
Fields inherited from interface org.apache.jackrabbit.webdav.jcr.nodetype.NodeTypeConstants
AUTOCREATED_ATTRIBUTE, CHILDNODEDEFINITION_ELEMENT, DEFAULTPRIMARYTYPE_ATTRIBUTE, DEFAULTVALUE_ELEMENT, DEFAULTVALUES_ELEMENT, HASORDERABLECHILDNODES_ATTRIBUTE, ISMIXIN_ATTRIBUTE, MANDATORY_ATTRIBUTE, MULTIPLE_ATTRIBUTE, NAME_ATTRIBUTE, NAMESPACE, NODETYPE_ELEMENT, NODETYPES_ELEMENT, ONPARENTVERSION_ATTRIBUTE, PRIMARYITEMNAME_ATTRIBUTE, PROPERTYDEFINITION_ELEMENT, PROTECTED_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
NodeTypesReport()
           
 
Method Summary
 org.apache.jackrabbit.webdav.version.report.ReportType getType()
          Returns NODETYPES_REPORT type.
 void setInfo(org.apache.jackrabbit.webdav.version.report.ReportInfo info)
           
 void setResource(org.apache.jackrabbit.webdav.version.DeltaVResource resource)
           
 org.jdom.Document toXml()
          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()

setResource

public void setResource(org.apache.jackrabbit.webdav.version.DeltaVResource resource)
Specified by:
setResource in interface org.apache.jackrabbit.webdav.version.report.Report
Parameters:
resource -
Throws:
IllegalArgumentException - if the resource or the session retrieved from the specified resource is null
See Also:
Report.setResource(org.apache.jackrabbit.webdav.version.DeltaVResource)

setInfo

public void setInfo(org.apache.jackrabbit.webdav.version.report.ReportInfo info)
Specified by:
setInfo in interface org.apache.jackrabbit.webdav.version.report.Report
Parameters:
info -
Throws:
IllegalArgumentException - if the specified info does not contain a dcr:nodetypes element.
See Also:
Report.setInfo(org.apache.jackrabbit.webdav.version.report.ReportInfo)

toXml

public org.jdom.Document toXml()
                        throws org.apache.jackrabbit.webdav.DavException
Returns a Xml representation of the node type definition(s) according to the info object.

Specified by:
toXml in interface org.apache.jackrabbit.webdav.version.report.Report
Returns:
Xml representation of the node type definition(s)
Throws:
org.apache.jackrabbit.webdav.DavException - if the specified nodetypes are not known or if another error occurs while retrieving the nodetype definitions.
See Also:
Report.toXml()


Copyright © 2005 . All Rights Reserved.