| javax.jcr.nodetype.ItemDefinition
| Method Summary | |
| public NodeType | getDeclaringNodeType()
Gets the node type that contains the declaration of this
ItemDefinition.
In implementations that support node type registration an
ItemDefinition object may be acquired (in the form of a
NodeDefinitionTemplate or
PropertyDefinitionTemplate) that is not attached to a live
NodeType. | | public String | getName()
Gets the name of the child item. | | public int | getOnParentVersion()
Gets the OnParentVersion status of the child item. | | public boolean | isAutoCreated()
Reports whether the item is to be automatically created when its parent node is created.
If true, then this ItemDefinition will necessarily not be a residual
set definition but will specify an actual item name (in other words getName() will not
return "*").
An autocreated item is created immediately when its parent node is created
in the transient session space. | | public boolean | isMandatory()
Reports whether the item is mandatory. | | public boolean | isProtected()
Reports whether the child item is protected. |
| getDeclaringNodeType | | public NodeType getDeclaringNodeType()(Code) | | Gets the node type that contains the declaration of this
ItemDefinition.
In implementations that support node type registration an
ItemDefinition object may be acquired (in the form of a
NodeDefinitionTemplate or
PropertyDefinitionTemplate) that is not attached to a live
NodeType. In such cases this method returns null.
a NodeType object. |
| getName | | public String getName()(Code) | | Gets the name of the child item. If "*", this
ItemDefinition defines a residual set of child items. That is,
it defines the characteristics of all those child items with names apart
from the names explicitly used in other child item definitions.
In implementations that support node type registration, if this
ItemDefinition object is actually a newly-created empty
PropertyDefinitionTemplate or
NodeDefinitionTemplate, then this method will return
null.
a String denoting the name or "*". |
| getOnParentVersion | | public int getOnParentVersion()(Code) | | Gets the OnParentVersion status of the child item. This
governs what occurs (in implementations that support versioning) when the
parent node of this item is checked-in. One of:
OnParentVersionAction.COPYOnParentVersionAction.VERSIONOnParentVersionAction.IGNOREOnParentVersionAction.INITIALIZEOnParentVersionAction.COMPUTEOnParentVersionAction.ABORT
In implementations that support node type registration, if this
ItemDefinition object is actually a newly-created empty
PropertyDefinitionTemplate or
NodeDefinitionTemplate, then this method will return
OnParentVersionAction.COPY.
a int constant meber of javax.jcr.version.OnParentVersionAction. |
| isAutoCreated | | public boolean isAutoCreated()(Code) | | Reports whether the item is to be automatically created when its parent node is created.
If true, then this ItemDefinition will necessarily not be a residual
set definition but will specify an actual item name (in other words getName() will not
return "*").
An autocreated item is created immediately when its parent node is created
in the transient session space. Creation of autocreated items is never
delayed until save.
In implementations that support node type registration, if this
ItemDefinition object is actually a newly-created empty
PropertyDefinitionTemplate or
NodeDefinitionTemplate, then this method will return
false.
a boolean. |
| isMandatory | | public boolean isMandatory()(Code) | | Reports whether the item is mandatory. A mandatory item is one that,
if its parent node exists, must also exist.
This means that a mandatory single-value property
must have a value (since there is no such thing a null value).
In the case of multi-value properties this means that the property must exist,
though it can have zero or more values.
An attempt to save a node that has a mandatory child item without first
creating that child item will throw a
ConstraintViolationException on save.
In implementations that support node type registration, if this
ItemDefinition object is actually a newly-created empty
PropertyDefinitionTemplate or
NodeDefinitionTemplate, then this method will return
false.
An item definition cannot be both residual and mandatory.
a boolean |
| isProtected | | public boolean isProtected()(Code) | | Reports whether the child item is protected. In level 2 implementations, a protected item is one that cannot be removed
(xcept by removing its parent) or modified through the the standard write methods of this API (that is, Item.remove,
Node.addNode, Node.setProperty and Property.setValue).
A protected node may be removed or modified (in a level 2 implementation), however, through some
mechanism not defined by this specification or as a side-effect of operations other than
the standard write methods of the API.
In implementations that support node type registration, if this
ItemDefinition object is actually a newly-created empty
PropertyDefinitionTemplate or
NodeDefinitionTemplate, then this method will return
false.
a boolean. |
|
|