Skip navigation links

oracle.ocs.jcr.nodetype
Interface OraclePropertyDefinition

All Superinterfaces:

javax.jcr.nodetype.ItemDefinition, javax.jcr.nodetype.PropertyDefinition

public interface OraclePropertyDefinition

extends javax.jcr.nodetype.PropertyDefinition

A property definition. Used in node type definitions.

Method Summary

javax.jcr.Value[]	getDefaultValues() Gets the default value(s) of the property.
int	getRequiredType() Gets the required type of the property.
java.lang.String[]	getValueConstraints() Gets the array of constraint strings.
boolean	isMultiple() Reports whether this property can have multiple values.

Methods inherited from interface javax.jcr.nodetype.ItemDefinition

getDeclaringNodeType, getName, getOnParentVersion, isAutoCreated, isMandatory, isProtected

Method Detail

getRequiredType

int getRequiredType()

Gets the required type of the property. One of:

• PropertyType.STRING
• PropertyType.DATE
• PropertyType.BINARY
• PropertyType.DOUBLE
• PropertyType.LONG
• PropertyType.BOOLEAN
• PropertyType.NAME
• PropertyType.PATH
• PropertyType.REFERENCE
• PropertyType.UNDEFINED

PropertyType.UNDEFINED is returned if this property may be of any type.

Specified by:

getRequiredType in interface javax.jcr.nodetype.PropertyDefinition

Returns:

an int

getValueConstraints

java.lang.String[] getValueConstraints()

Gets the array of constraint strings. Each string in the array specifies a constraint on the value of the property. The constraints are OR-ed together, meaning that in order to be valid, the value must meet at least one of the constraints. For example, a constraint array of ["constraint1", "constraint2", "constraint3"] has the interpretation: "the value of this property must meet either constraint1, constraint2 or constraint3".

Returning an empty array, indicates that value constraint information is available and that no constraints are placed on this value.

The constraint strings themselves having differing formats and interpretations depending on the type of the property in question. The following describes the value constraint syntax for Reference property type since only they have ValueConstraints in the current implementation. All other property types have no constraints on their value:

• REFERENCE: The constraint string is a JCR name in prefix form. This name is interpreted as a node type name and the REFERENCE property is restricted to referring only to nodes that have at least the indicated node type. For example, a constraint of "mytype:document" would indicate that the REFERENCE property in question can only refer to nodes that have at least the node type mytype:document. No wildcards or other pattern matching are supported. The string returned must reflect the namespace mapping in the current Session. Constraint strings for REFERENCE properties should be stored in fully-qualified form (using the actual URI instead of the prefix) and then be converted to prefix form according to the current mapping.

• Specified by:

  getValueConstraints in interface javax.jcr.nodetype.PropertyDefinition

  Returns:

  a String array.

  getDefaultValues

  javax.jcr.Value[] getDefaultValues()
  

  Gets the default value(s) of the property. These are the values that the property defined by this PropertyDefinition will be assigned if it is automatically created (that is, if ItemDefinition.isAutoCreated() returns true).

  This method returns an array of Value objects. If the property is multi-valued, then this array represents the full set of values that the property will be assigned upon being auto-created. Note that this could be the empty array. If the property is single-valued, then the array returned will be of size 1. <p/> If null is returned, then the property has no fixed default value.

  Specified by:

  getDefaultValues in interface javax.jcr.nodetype.PropertyDefinition

  Returns:

  an array of Value objects.

  isMultiple

  boolean isMultiple()
  

  Reports whether this property can have multiple values.

  Specified by:

  isMultiple in interface javax.jcr.nodetype.PropertyDefinition

  Returns:

  a boolean