|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ItemDefinition
Superclass of NodeDefinition
and PropertyDefinition
.
Method Summary | |
---|---|
NodeType |
getDeclaringNodeType()
Gets the node type that contains the declaration of this ItemDefinition . |
java.lang.String |
getName()
Gets the name of the child item. |
int |
getOnParentVersion()
Gets the OnParentVersion status of the child item. |
boolean |
isAutoCreated()
Reports whether the item is to be automatically created when its parent node is created. |
boolean |
isMandatory()
Reports whether the item is mandatory. |
boolean |
isProtected()
Reports whether the child item is protected. |
Method Detail |
---|
NodeType getDeclaringNodeType()
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
.
NodeType
object.java.lang.String getName()
"*"
, 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
.
String
denoting the name or "*"
.boolean isAutoCreated()
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
.
boolean
.boolean isMandatory()
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.
boolean
int getOnParentVersion()
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.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
PropertyDefinitionTemplate
or NodeDefinitionTemplate
,
then this method will return OnParentVersionAction.COPY
.
int
constant member of OnParentVersionAction
.boolean isProtected()
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
.
boolean
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |