Package javax.jcr.nodetype

Interface PropertyDefinitionTemplate

  • All Superinterfaces:
    ItemDefinition, PropertyDefinition
    public interface PropertyDefinitionTemplate
extends PropertyDefinition
    The PropertyDefinitionTemplate interface extends PropertyDefinition with the addition of write methods, enabling the characteristics of a child property definition to be set, after which the PropertyDefinitionTemplate is added to a NodeTypeTemplate.

    See the corresponding get methods for each attribute in PropertyDefinition for the default values assumed when a new empty PropertyDefinitionTemplate is created (as opposed to one extracted from an existing NodeType).

    Since:
    JCR 2.0

    • Method Detail

      • setName

        void setName​(java.lang.String name)
      throws ConstraintViolationException
        Sets the name of the property. This must be a JCR name in either qualified or expanded form.
        Parameters:
        name - a JCR name.
        Throws:
        ConstraintViolationException - if name is not a syntactically valid JCR name in either qualified or expanded form.

      • setAutoCreated

        void setAutoCreated​(boolean autoCreated)
        Sets the auto-create status of the property.
        Parameters:
        autoCreated - a boolean.

      • setMandatory

        void setMandatory​(boolean mandatory)
        Sets the mandatory status of the property.
        Parameters:
        mandatory - a boolean.

      • setOnParentVersion

        void setOnParentVersion​(int opv)
        Sets the on-parent-version status of the property.
        Parameters:
        opv - an int constant member of OnParentVersionAction.

      • setProtected

        void setProtected​(boolean protectedStatus)
        Sets the protected status of the property.
        Parameters:
        protectedStatus - a boolean.

      • setRequiredType

        void setRequiredType​(int type)
        Sets the required type of the property.
        Parameters:
        type - an int constant member of PropertyType.

      • setValueConstraints

        void setValueConstraints​(java.lang.String[] constraints)
        Sets the value constraints of the property.
        Parameters:
        constraints - a String array.

      • setDefaultValues

        void setDefaultValues​(Value[] defaultValues)
        Sets the default value (or values, in the case of a multi-value property) of the property.
        Parameters:
        defaultValues - a Value array.

      • setMultiple

        void setMultiple​(boolean multiple)
        Sets the multi-value status of the property.
        Parameters:
        multiple - a boolean.

      • setAvailableQueryOperators

        void setAvailableQueryOperators​(java.lang.String[] operators)
        Sets the queryable status of the property.
        Parameters:
        operators - an array of String constants. See PropertyDefinition.getAvailableQueryOperators() .

      • setFullTextSearchable

        void setFullTextSearchable​(boolean fullTextSearchable)
        Sets the full-text-searchable status of the property.
        Parameters:
        fullTextSearchable - a boolean.

      • setQueryOrderable

        void setQueryOrderable​(boolean queryOrderable)
        Sets the query-orderable status of the property.
        Parameters:
        queryOrderable - a boolean.