phpcr/src/PHPCR/NodeType/NodeDefinitionTemplateInterface.php

In other words, whether the parent node can have more than one child node of this name. If this NodeDefinition is actually a NodeDefinitionTemplate that is not part of a registered node type, then this method will return the same name siblings status as set in that template. If that template is a newly-created empty one, then this method will return false.

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.

This node type must be a subtype of (or the same type as) the node types returned by getRequiredPrimaryTypes. If null is returned this indicates that no default primary type is specified and that therefore an attempt to create this node without specifying a node type will throw a ConstraintViolationException. In implementations that support node type registration an NodeDefinition object may be acquired (in the form of a NodeDefinitionTemplate) that is not attached to a live NodeType. In such cases this method returns null.

If this NodeDefinition is acquired from a live NodeType this list will reflect the NodeType returned by getDefaultPrimaryType, above.

If this NodeDefinition is actually a NodeDefinitionTemplate that is not part of a registered node type, then this method will return the required primary types as set in that template. If that template is a newly-created empty one, then this method will return null.

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.

This governs what occurs (in implementations that support versioning) when the parent node of this item is checked-in. One of:

• OnParentVersionAction::COPY
• OnParentVersionAction::VERSION
• OnParentVersionAction::IGNORE
• OnParentVersionAction::INITIALIZE
• OnParentVersionAction::COMPUTE
• OnParentVersionAction::ABORT

In implementations that support node type registration, if this ItemDefinition object is actually a newly-created empty PropertyDefinitionTemplateInterface or NodeDefinitionTemplateInterface, then this method will return OnParentVersionAction::COPY.

If this NodeDefinition is acquired from a live NodeType this list will reflect the node types returned by getRequiredPrimaryTypes, above.

If this NodeDefinition is actually a NodeDefinitionTemplate that is not part of a registered node type, then this method will return the required primary types as set in that template. If that template is a newly-created empty one, then this method will return null.

Returns an array to support those implementations with multiple inheritance. This method never returns an empty array. If this node definition places no requirements on the primary node type, then this method will return an array containing only the NodeType object representing nt:base, which is the base of all primary node types and therefore constitutes the least restrictive node type requirement. Note that any particular node instance still has only one assigned primary node type, but in multiple-inheritance- supporting implementations the RequiredPrimaryTypes attribute can be used to restrict that assigned node type to be a subtype of all of a specified set of node types. In implementations that support node type registration an NodeDefinition object may be acquired (in the form of a NodeDefinitionTemplate) that is not attached to a live NodeType. In such cases this method returns null.

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 non-protected item must be created immediately when its parent node is created in the transient session space. Creation of autocreated non-protected items is never delayed until save.

An autocreated protected item should be created immediately when its parent node is created in the transient session space. Creation of autocreated protected items should not be delayed until save, though doing so does not violate JCR compliance.

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 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.

In level 2 implementations, a protected item is one that cannot be removed (except by removing its parent) or modified through the the standard write methods of this API (that is, ItemInterface::remove(), NodeInterface::addNode(), NodeInterface::setProperty() and PropertyInterface::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 PropertyDefinitionTemplateInterface or NodeDefinitionTemplateInterface, then this method will return false.