@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/hidden/javax/jcr/Property/index.d.ts

@@ -0,0 +1,801 @@
+import Value from "../Value";
+import Binary from "../Binary";
+import Node from "../Node";
+import PropertyDefinition from "../nodetype/PropertyDefinition";
+
+/**
+ * A <code>Property</code> object represents the smallest granularity of content
+ * storage. It has a single parent node and no children. A property consists of
+ * a name and a value, or in the case of multi-value properties, a set of values
+ * all of the same type. See <code>{@link Value}</code>.Sets the value of this property to <code>value</code>. If this property's
+ * property type is not constrained by the node type of its parent node,
+ * then the property type is changed to that of the supplied
+ * <code>value</code>. If the property type is constrained, then a
+ * best-effort conversion is attempted.
+ * <p>
+ * This method is a session-write and therefore requires a <code>save</code>
+ * to dispatch the change.
+ * <p>
+ * A <code>ConstraintViolationException</code> will be thrown either
+ * immediately, on dispatch, or on persist, if the change would violate a
+ * node type or implementation-specific constraint. Implementations may
+ * differ on when this validation is performed.
+ * <p>
+ * A <code>VersionException</code> will be thrown either immediately, on
+ * dispatch, or on persist, if this property belongs to a node that is
+ * versionable and checked-in or is non-versionable but whose nearest
+ * versionable ancestor is checked-in. Implementations may differ on when
+ * this validation is performed.
+ * <p>
+ * A <code>LockException</code> will be thrown either immediately, on
+ * dispatch, or on persist, if a lock prevents the setting of the value.
+ * Implementations may differ on when this validation is performed.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Sets the value of this property to the <code>values</code> array. If this
+ * property's property type is not constrained by the node type of its
+ * parent node, then the property type may be changed. If the property type
+ * is constrained, then a best-effort conversion is attempted, according to
+ * an implemention-dependent definition of "best effort". The change will be
+ * persisted (if valid) on <code>save</code>.
+ * <p>
+ * A <code>ConstraintViolationException</code> will be thrown either
+ * immediately, on dispatch, or on persist, if the change would violate a
+ * node type or implementation-specific constraint. Implementations may
+ * differ on when this validation is performed.
+ * <p>
+ * A <code>VersionException</code> will be thrown either immediately, on
+ * dispatch, or on persist, if this property belongs to a node that is
+ * read-only due to a checked-in node. Implementations may differ on when
+ * this validation is performed.
+ * <p>
+ * A <code>LockException</code> will be thrown either immediately, on
+ * dispatch, or on persist, if a lock prevents the setting of the value.
+ * Implementations may differ on when this validation is performed.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Sets the value of this property to <code>value</code>. Same as
+ * <code>{@link #setValue(Value value)}</code> except that the value is
+ * specified as a <code>String</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Sets the value of this property to the <code>values</code> array. Same as
+ * <code>{@link #setValue(Value[] values)}</code> except that the values are
+ * specified as a <code>String[]</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Sets the value of this property to <code>value</code>. Same as
+ * <code>{@link #setValue(Value value)}</code> except that the value is
+ * specified as an <code>InputStream</code>.
+ * <p>
+ * The passed stream is closed before this method returns either normally or
+ * because of an exception.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Sets the value of this property to <code>value</code>. Same as
+ * <code>{@link #setValue(Value value)}</code> except that the value is
+ * specified as a <code>Binary</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Sets the value of this property to <code>value</code>. Same as
+ * <code>{@link #setValue(Value value)}</code> except that the value is
+ * specified as a <code>long</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Sets the value of this property to <code>value</code>. Same as
+ * <code>{@link #setValue(Value value)}</code> except that the value is
+ * specified as a <code>double</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Sets the value of this property to <code>value</code>. Same as
+ * <code>{@link #setValue(Value value)}</code> except that the value is
+ * specified as a <code>BigDecimal</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Sets the value of this property to <code>value</code>. Same as
+ * <code>{@link #setValue(Value value)}</code> except that the value is
+ * specified as a <code>Calendar</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Sets the value of this property to <code>value</code>. Same as
+ * <code>{@link #setValue(Value value)}</code> except that the value is
+ * specified as a <code>boolean</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Sets this <code>REFERENCE</code> or <code>WEAKREFERNCE</code> property to
+ * refer to the specified node.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+ * <code>sv:simpleUser</code></p>Returns the value of this  property as a <code>Value</code> object.
+ * <p>
+ * The object returned is a copy of the stored value and is immutable.Returns an array of all the values of this property. Used to access
+ * multi-value properties. The array returned is a copy of the stored
+ * values, so changes to it are not reflected in internal storage.Returns a <code>String</code> representation of the value of this
+ * property. A shortcut for <code>Property.getValue().getString()</code>.Returns an <code>InputStream</code> representation of the value of this
+ * property. A shortcut for <code>Property.getValue().getStream()</code>.
+ * <p>
+ * It is the responsibility of the caller to close the returned
+ * InputStream.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns a <code>Binary</code> representation of the value of this
+ * property. A shortcut for <code>Property.getValue().getBinary()</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Limited to the <code>URL</code> and <code>URI</code> properties of nodes with primary
+ * {@link javax.jcr.nodetype.NodeType} <code>sv:file</code> and <code>sv:image</code> and to any {@link javax.jcr.PropertyType#WEAKREFERENCE}
+ * pointing to a <code>Node</code> of type <code>sv:file</code> or <code>sv:image</code></p>Returns a <code>long</code> representation of the value of this property.
+ * A shortcut for <code>Property.getValue().getLong()</code>.Returns a <code>double</code> representation of the value of this
+ * property. A shortcut for <code>Property.getValue().getDouble()</code>.Returns a <code>BigDecimal</code> representation of the value of this
+ * property. A shortcut for <code>Property.getValue().getDecimal()</code>.Returns a <code>Calendar</code> representation of the value of this
+ * property. A shortcut for <code>Property.getValue().getDate()</code>.Returns a <code>boolean</code> representation of the value of this
+ * property. A shortcut for <code>Property.getValue().getBoolean()</code>.If this property is of type <code>REFERENCE</code>,
+ * <code>WEAKREFERENCE</code> or <code>PATH</code> (or convertible to one of
+ * these types) this method returns the <code>Node</code> to which this
+ * property refers.
+ * <p>
+ * If this property is of type <code>PATH</code> and it contains a relative
+ * path, it is interpreted relative to the parent node of this property. For
+ * example "<code>.</code>" refers to the parent node itself,
+ * "<code>..</code>" to the parent of the parent node and "<code>foo</code>"
+ * to a sibling node of this property.If this property is of type <code>PATH</code> (or convertible to this
+ * type) this method returns the <code>Property</code> to which <i>this</i>
+ * property refers.
+ * <p>
+ * If this property contains a relative path, it is interpreted relative to
+ * the parent node of this property. Therefore, when resolving such a
+ * relative path, the segment "<code>.</code>" refers to
+ * the parent node itself, "<code>..</code>" to the parent of the parent
+ * node and "<code>foo</code>" to a sibling property of this property or
+ * this property itself.
+ * <p>
+ * For example, if this property is located at
+ * <code>/a/b/c</code> and it has a value of "<code>../d</code>" then this
+ * method will return the property at <code>/a/d</code> if such exists.
+ * <p>
+ * If this property is multi-valued, this method throws a
+ * <code>ValueFormatException</code>.
+ * <p>
+ * If this property cannot be converted to a <code>PATH</code> then a
+ * <code>ValueFormatException</code> is thrown.
+ * <p>
+ * If this property is currently part of the frozen state of a version in
+ * version storage, this method will throw a <code>ValueFormatException</code>.Returns the length of the value of this property.
+ * <p>
+ * For a <code>BINARY</code> property, <code>getLength</code> returns the
+ * number of bytes. For other property types, <code>getLength</code> returns
+ * the same value that would be returned by calling {@link
+ * java.lang.String#length()} on the value when it has been converted to a
+ * <code>STRING</code> according to standard JCR property type conversion.
+ * <p>
+ * Returns -1 if the implementation cannot determine the length.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns an array holding the lengths of the values of this (multi-value)
+ * property in bytes where each is individually calculated as described in
+ * {@link #getLength()}.
+ * <p>
+ * Returns a <code>-1</code> in the appropriate position if the
+ * implementation cannot determine the length of a value.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns the property definition that applies to this property. In some
+ * cases there may appear to be more than one definition that could apply to
+ * this node. However, it is assumed that upon creation or change of this
+ * property, a single particular definition is chosen by the implementation.
+ * It is <i>that</i> definition that this method returns. How this governing
+ * definition is selected upon property creation or change from among others
+ * which may have been applicable is an implementation issue and is not
+ * covered by this specification.Returns the type of this <code>Property</code>. One of: <ul>
+ * <li><code>PropertyType.STRING</code></li> <li><code>PropertyType.BINARY</code></li>
+ * <li><code>PropertyType.DATE</code></li> <li><code>PropertyType.DOUBLE</code></li>
+ * <li><code>PropertyType.LONG</code></li> <li><code>PropertyType.BOOLEAN</code></li>
+ * <li><code>PropertyType.NAME</code></li> <li><code>PropertyType.PATH</code></li>
+ * <li><code>PropertyType.REFERENCE</code></li> <li><code>PropertyType.WEAKREFERENCE</code></li>
+ * <li><code>PropertyType.URI</code></li> </ul> The type returned is that
+ * which was set at property creation. Note that for some property
+ * <code>p</code>, the type returned by <code>p.getType()</code> will differ
+ * from the type returned by <code>p.getDefinition.getRequiredType()</code>
+ * only in the case where the latter returns <code>UNDEFINED</code>. The
+ * type of a property instance is never <code>UNDEFINED</code> (it must
+ * always have some actual type).Returns <code>true</code> if this property is multi-valued and
+ * <code>false</code> if this property is single-valued.A constant for the property name <code>jcr:primaryType</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_BASE
+ * nt:base}.A constant for the property name <code>jcr:mixinTypes</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_BASE
+ * nt:base}.A constant for the property name <code>jcr:content</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_LINKED_FILE
+ * nt:linkedFile}. Note, <code>jcr:content</code> is also the name of a
+ * child node declared in {@link javax.jcr.nodetype.NodeType#NT_FILE
+ * nt:file}.A constant for the property name <code>jcr:data</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_RESOURCE
+ * nt:resource}.A constant for the property name <code>jcr:protocol</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_ADDRESS
+ * nt:address}.A constant for the property name <code>jcr:host</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_ADDRESS
+ * nt:address}.A constant for the property name <code>jcr:port</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_ADDRESS
+ * nt:address}.A constant for the property name <code>jcr:repository</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_ADDRESS
+ * nt:address}.A constant for the property name <code>jcr:workspace</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_ADDRESS
+ * nt:address}.A constant for the property name <code>jcr:path</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_ADDRESS
+ * nt:address}.A constant for the property name <code>jcr:id</code> (in expanded form),
+ * declared in node type {@link javax.jcr.nodetype.NodeType#NT_ADDRESS
+ * nt:address}.A constant for the property name <code>jcr:uuid</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_REFERENCEABLE
+ * mix:referenceable}.A constant for the property name <code>jcr:title</code> (in expanded
+ * form), declared in node types {@link javax.jcr.nodetype.NodeType#MIX_TITLE
+ * mix:title} and {@link javax.jcr.nodetype.NodeType#NT_ACTIVITY
+ * nt:activity}.A constant for the property name <code>jcr:description</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_TITLE
+ * mix:title}.A constant for the property name <code>jcr:created</code> (in expanded
+ * form), declared in node types {@link javax.jcr.nodetype.NodeType#MIX_CREATED
+ * mix:created} and {@link javax.jcr.nodetype.NodeType#NT_VERSION
+ * nt:version}.A constant for the property name <code>jcr:createdBy</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_CREATED
+ * mix:created}.A constant for the property name <code>jcr:lastModified</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_LAST_MODIFIED
+ * mix:lastModified}.A constant for the property name <code>jcr:lastModifiedBy</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_LAST_MODIFIED
+ * mix:lastModified}.A constant for the property name <code>jcr:language</code> (in expanded
+ * form), declared in node types {@link javax.jcr.nodetype.NodeType#MIX_LANGUAGE
+ * mix:language} and {@link javax.jcr.nodetype.NodeType#NT_QUERY nt:query}.A constant for the property name <code>jcr:mimeType</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_MIMETYPE
+ * mix:mimeType}.A constant for the property name <code>jcr:encoding</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_MIMETYPE
+ * mix:mimeType}.A constant for the property name <code>jcr:nodeTypeName</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_NODE_TYPE
+ * nt:nodeType}.A constant for the property name <code>jcr:supertypes</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_NODE_TYPE
+ * nt:nodeType}.A constant for the property name <code>jcr:isAbstract</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_NODE_TYPE
+ * nt:nodeType}.A constant for the property name <code>jcr:isMixin</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_NODE_TYPE
+ * nt:nodeType}.A constant for the property name <code>jcr:hasOrderableChildNodes</code>
+ * (in expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_NODE_TYPE
+ * nt:nodeType}.A constant for the property name <code>jcr:primaryItemName</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_NODE_TYPE
+ * nt:nodeType}.A constant for the property name <code>jcr:name</code> (in expanded
+ * form), declared in node types {@link javax.jcr.nodetype.NodeType#NT_PROPERTY_DEFINITION
+ * nt:propertyDefinition} and {@link javax.jcr.nodetype.NodeType#NT_CHILD_NODE_DEFINITION
+ * nt:childNodeDefinition}.A constant for the property name <code>jcr:autoCreated</code> (in
+ * expanded form), declared in node types {@link javax.jcr.nodetype.NodeType#NT_PROPERTY_DEFINITION
+ * nt:propertyDefinition} and {@link javax.jcr.nodetype.NodeType#NT_CHILD_NODE_DEFINITION
+ * nt:childNodeDefinition}.A constant for the property name <code>jcr:mandatory</code> (in expanded
+ * form), declared in node types {@link javax.jcr.nodetype.NodeType#NT_PROPERTY_DEFINITION
+ * nt:propertyDefinition} and {@link javax.jcr.nodetype.NodeType#NT_CHILD_NODE_DEFINITION
+ * nt:childNodeDefinition}.A constant for the property name <code>jcr:protected</code> (in expanded
+ * form), declared in node types {@link javax.jcr.nodetype.NodeType#NT_PROPERTY_DEFINITION
+ * nt:propertyDefinition} and {@link javax.jcr.nodetype.NodeType#NT_CHILD_NODE_DEFINITION
+ * nt:childNodeDefinition}.A constant for the property name <code>jcr:onParentVersion</code> (in
+ * expanded form), declared in node types {@link javax.jcr.nodetype.NodeType#NT_PROPERTY_DEFINITION
+ * nt:propertyDefinition} and {@link javax.jcr.nodetype.NodeType#NT_CHILD_NODE_DEFINITION
+ * nt:childNodeDefinition}.A constant for the property name <code>jcr:requiredType</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_PROPERTY_DEFINITION
+ * nt:propertyDefinition}.A constant for the property name <code>jcr:valueConstraints</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_PROPERTY_DEFINITION
+ * nt:propertyDefinition}.A constant for the property name <code>jcr:defaultValues</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_PROPERTY_DEFINITION
+ * nt:propertyDefinition}.A constant for the property name <code>jcr:multiple</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_PROPERTY_DEFINITION
+ * nt:propertyDefinition}.A constant for the property name <code>jcr:requiredPrimaryTypes</code>
+ * (in expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_CHILD_NODE_DEFINITION
+ * nt:childNodeDefinition}.A constant for the property name <code>jcr:defaultPrimaryType</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_CHILD_NODE_DEFINITION
+ * nt:childNodeDefinition}.A constant for the property name <code>jcr:sameNameSiblings</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_CHILD_NODE_DEFINITION
+ * nt:childNodeDefinition}.A constant for the property name <code>jcr:lockOwner</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_LOCKABLE
+ * mix:lockable}.A constant for the property name <code>jcr:lockIsDeep</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_LOCKABLE
+ * mix:lockable}.A constant for the property name <code>jcr:lifecyclePolicy</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_LIFECYCLE
+ * mix:lifecycle}.A constant for the property name <code>jcr:currentLifecycleState</code>
+ * (in expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_LIFECYCLE
+ * mix:lifecycle}.A constant for the property name <code>jcr:isCheckedOut</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_SIMPLE_VERSIONABLE
+ * mix:simpleVersionable}.A constant for the property name <code>jcr:frozenPrimaryType</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_FROZEN_NODE
+ * nt:frozenNode}.A constant for the property name <code>jcr:frozenMixinTypes</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_FROZEN_NODE
+ * nt:frozenNode}.A constant for the property name <code>jcr:frozenUuid</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_FROZEN_NODE
+ * nt:frozenNode}.A constant for the property name <code>jcr:versionHistory</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_VERSIONABLE
+ * mix:versionable}.A constant for the property name <code>jcr:baseVersion</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_VERSIONABLE
+ * mix:versionable}.A constant for the property name <code>jcr:predecessors</code> (in
+ * expanded form), declared in node types {@link javax.jcr.nodetype.NodeType#MIX_VERSIONABLE
+ * mix:versionable} and {@link javax.jcr.nodetype.NodeType#NT_VERSION
+ * nt:version}.A constant for the property name <code>jcr:mergeFailed</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_VERSIONABLE
+ * mix:versionable}.A constant for the property name <code>jcr:activity</code> (in expanded
+ * form), declared in node types {@link javax.jcr.nodetype.NodeType#MIX_VERSIONABLE
+ * mix:versionable} and {@link javax.jcr.nodetype.NodeType#NT_VERSION
+ * nt:version}.A constant for the property name <code>jcr:configuration</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#MIX_VERSIONABLE
+ * mix:versionable}.A constant for the property name <code>jcr:versionableUuid</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_VERSION
+ * nt:version}.A constant for the property name <code>jcr:copiedFrom</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_VERSION
+ * nt:version}.A constant for the property name <code>jcr:successors</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_VERSION
+ * nt:versione}.A constant for the property name <code>jcr:childVersionHistory</code> (in
+ * expanded form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_VERSIONED_CHILD
+ * nt:versionedChild}.A constant for the property name <code>jcr:root</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_CONFIGURATION
+ * nt:configuration}.A constant for the property name <code>jcr:statement</code> (in expanded
+ * form), declared in node type {@link javax.jcr.nodetype.NodeType#NT_QUERY
+ * nt:query}.
+  
+    */
+interface Property {
+  /**
+   * Sets the value of this property to <code>value</code>. If this property's
+   * property type is not constrained by the node type of its parent node,
+   * then the property type is changed to that of the supplied
+   * <code>value</code>. If the property type is constrained, then a
+   * best-effort conversion is attempted.
+   * <p>
+   * This method is a session-write and therefore requires a <code>save</code>
+   * to dispatch the change.
+   * <p>
+   * A <code>ConstraintViolationException</code> will be thrown either
+   * immediately, on dispatch, or on persist, if the change would violate a
+   * node type or implementation-specific constraint. Implementations may
+   * differ on when this validation is performed.
+   * <p>
+   * A <code>VersionException</code> will be thrown either immediately, on
+   * dispatch, or on persist, if this property belongs to a node that is
+   * versionable and checked-in or is non-versionable but whose nearest
+   * versionable ancestor is checked-in. Implementations may differ on when
+   * this validation is performed.
+   * <p>
+   * A <code>LockException</code> will be thrown either immediately, on
+   * dispatch, or on persist, if a lock prevents the setting of the value.
+   * Implementations may differ on when this validation is performed.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param value The new value to set the property to.
+   * @throws ValueFormatException if the type or format of the specified value is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setValue(value: Value): void;
+
+  /**
+   * Sets the value of this property to the <code>values</code> array. If this
+   * property's property type is not constrained by the node type of its
+   * parent node, then the property type may be changed. If the property type
+   * is constrained, then a best-effort conversion is attempted, according to
+   * an implemention-dependent definition of "best effort". The change will be
+   * persisted (if valid) on <code>save</code>.
+   * <p>
+   * A <code>ConstraintViolationException</code> will be thrown either
+   * immediately, on dispatch, or on persist, if the change would violate a
+   * node type or implementation-specific constraint. Implementations may
+   * differ on when this validation is performed.
+   * <p>
+   * A <code>VersionException</code> will be thrown either immediately, on
+   * dispatch, or on persist, if this property belongs to a node that is
+   * read-only due to a checked-in node. Implementations may differ on when
+   * this validation is performed.
+   * <p>
+   * A <code>LockException</code> will be thrown either immediately, on
+   * dispatch, or on persist, if a lock prevents the setting of the value.
+   * Implementations may differ on when this validation is performed.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param values The new values to set the property to.
+   * @throws ValueFormatException if the type or format of the specified values is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setValue(values: Value): void;
+
+  /**
+   * Sets the value of this property to <code>value</code>. Same as
+   * <code>{@link #setValue(Value value)}</code> except that the value is
+   * specified as a <code>String</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param value The new value to set the property to.
+   * @throws ValueFormatException if the type or format of the specified values is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setValue(value: string): void;
+
+  /**
+   * Sets the value of this property to the <code>values</code> array. Same as
+   * <code>{@link #setValue(Value[] values)}</code> except that the values are
+   * specified as a <code>String[]</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param values The new values to set the property to.
+   * @throws ValueFormatException if the type or format of one or more of the specified values is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setValue(values: string): void;
+
+  /**
+   * Sets the value of this property to <code>value</code>. Same as
+   * <code>{@link #setValue(Value value)}</code> except that the value is
+   * specified as an <code>InputStream</code>.
+   * <p>
+   * The passed stream is closed before this method returns either normally or
+   * because of an exception.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param value The new value to set the property to.
+   * @throws ValueFormatException if the type or format of the specified value is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   * @deprecated As of JCR 2.0, {@link #setValue(Binary)} should be used instead.
+   */
+  setValue(value: unknown): void;
+
+  /**
+   * Sets the value of this property to <code>value</code>. Same as
+   * <code>{@link #setValue(Value value)}</code> except that the value is
+   * specified as a <code>Binary</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @param value The new value to set the property to.
+   * @throws ValueFormatException if the type or format of the specified value is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   * @since JCR 2.0
+   */
+  setValue(value: Binary): void;
+
+  /**
+   * Sets the value of this property to <code>value</code>. Same as
+   * <code>{@link #setValue(Value value)}</code> except that the value is
+   * specified as a <code>long</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param value The new value to set the property to.
+   * @throws ValueFormatException if the type or format of the specified value is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setValue(value: number): void;
+
+  /**
+   * Sets the value of this property to <code>value</code>. Same as
+   * <code>{@link #setValue(Value value)}</code> except that the value is
+   * specified as a <code>double</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param value The new value to set the property to.
+   * @throws ValueFormatException if the type or format of the specified value is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setValue(value: number): void;
+
+  /**
+   * Sets the value of this property to <code>value</code>. Same as
+   * <code>{@link #setValue(Value value)}</code> except that the value is
+   * specified as a <code>BigDecimal</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param value The new value to set the property to.
+   * @throws ValueFormatException if the type or format of the specified value is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   * @since JCR 2.0
+   */
+  setValue(value: unknown): void;
+
+  /**
+   * Sets the value of this property to <code>value</code>. Same as
+   * <code>{@link #setValue(Value value)}</code> except that the value is
+   * specified as a <code>Calendar</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param value The new value to set the property to.
+   * @throws ValueFormatException if the type or format of the specified value is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setValue(value: unknown): void;
+
+  /**
+   * Sets the value of this property to <code>value</code>. Same as
+   * <code>{@link #setValue(Value value)}</code> except that the value is
+   * specified as a <code>boolean</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param value The new value to set the property to.
+   * @throws ValueFormatException if the type or format of the specified value is incompatible with the type of this property.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setValue(value: boolean): void;
+
+  /**
+   * Sets this <code>REFERENCE</code> or <code>WEAKREFERNCE</code> property to
+   * refer to the specified node.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to nodes of primary {@link javax.jcr.nodetype.NodeType}
+   * <code>sv:simpleUser</code></p>
+   * @param value The node to which this property will refer.
+   * @throws ValueFormatException if the type or format of the specified value is incompatible with the type of this property the specified node is not referenceable.
+   * @throws VersionException if this property belongs to a node that is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the setting of the value and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if the change would violate a node-type or other constraint and this implementation performs this validation immediately.
+   * @throws RepositoryException if another error occurs.
+   */
+  setValue(value: Node): void;
+
+  /**
+   * Returns the value of this  property as a <code>Value</code> object.
+   * <p>
+   * The object returned is a copy of the stored value and is immutable.
+   * @return the <code>Value</code>.
+   * @throws ValueFormatException if the property is multi-valued.
+   * @throws RepositoryException if another error occurs.
+   */
+  getValue(): Value;
+
+  /**
+   * Returns an array of all the values of this property. Used to access
+   * multi-value properties. The array returned is a copy of the stored
+   * values, so changes to it are not reflected in internal storage.
+   * @return a <code>Value</code> array.
+   * @throws ValueFormatException if the property is single-valued.
+   * @throws RepositoryException if another error occurs.
+   */
+  getValues(): Value;
+
+  /**
+   * Returns a <code>String</code> representation of the value of this
+   * property. A shortcut for <code>Property.getValue().getString()</code>.
+   * @return A string representation of the value of this property.
+   * @throws ValueFormatException if conversion to a <code>String</code> is not possible or if the property is multi-valued.
+   * @throws RepositoryException if another error occurs.
+   * @see Value
+   */
+  getString(): string;
+
+  /**
+   * Returns an <code>InputStream</code> representation of the value of this
+   * property. A shortcut for <code>Property.getValue().getStream()</code>.
+   * <p>
+   * It is the responsibility of the caller to close the returned
+   * InputStream.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @return A stream representation of the value of this property.
+   * @throws ValueFormatException if the property is multi-valued.
+   * @throws RepositoryException if another error occurs
+   * @see Value
+   * @deprecated As of JCR 2.0, {@link #getBinary()} should be used instead.
+   */
+  getStream(): unknown;
+
+  /**
+   * Returns a <code>Binary</code> representation of the value of this
+   * property. A shortcut for <code>Property.getValue().getBinary()</code>.
+   *
+   * <p><strong>Sitevision note:</strong> Limited to the <code>URL</code> and <code>URI</code> properties of nodes with primary
+   * {@link javax.jcr.nodetype.NodeType} <code>sv:file</code> and <code>sv:image</code> and to any {@link javax.jcr.PropertyType#WEAKREFERENCE}
+   * pointing to a <code>Node</code> of type <code>sv:file</code> or <code>sv:image</code></p>
+   * @return A <code>Binary</code> representation of the value of this property.
+   * @throws ValueFormatException if the property is multi-valued.
+   * @throws RepositoryException if another error occurs.
+   * @see Value
+   * @see Binary
+   * @since JCR 2.0
+   * @since Sitevision 3.5
+   */
+  getBinary(): Binary;
+
+  /**
+   * Returns a <code>long</code> representation of the value of this property.
+   * A shortcut for <code>Property.getValue().getLong()</code>.
+   * @return A <code>long</code> representation of the value of this property.
+   * @throws ValueFormatException if conversion to a <code>long</code> is not possible or if the property is multi-valued.
+   * @throws RepositoryException if another error occurs.
+   * @see Value
+   */
+  getLong(): number;
+
+  /**
+   * Returns a <code>double</code> representation of the value of this
+   * property. A shortcut for <code>Property.getValue().getDouble()</code>.
+   * @return A <code>double</code> representation of the value of this property.
+   * @throws ValueFormatException if conversion to a <code>double</code> is not possible or if the property is multi-valued.
+   * @throws RepositoryException if another error occurs.
+   * @see Value
+   */
+  getDouble(): number;
+
+  /**
+   * Returns a <code>BigDecimal</code> representation of the value of this
+   * property. A shortcut for <code>Property.getValue().getDecimal()</code>.
+   * @return A <code>BigDecimal</code> representation of the value of this property.
+   * @throws ValueFormatException if conversion to a <code>BigDecimal</code> is not possible or if the property is multi-valued.
+   * @throws RepositoryException if another error occurs
+   * @see Value
+   * @since JCR 2.0
+   */
+  getDecimal(): unknown;
+
+  /**
+   * Returns a <code>Calendar</code> representation of the value of this
+   * property. A shortcut for <code>Property.getValue().getDate()</code>.
+   * @return A <code>Calendar</code> representation of the value of this property.
+   * @throws ValueFormatException if conversion to a string is not possible or if the property is multi-valued.
+   * @throws RepositoryException if another error occurs.
+   * @see Value
+   */
+  getDate(): unknown;
+
+  /**
+   * Returns a <code>boolean</code> representation of the value of this
+   * property. A shortcut for <code>Property.getValue().getBoolean()</code>.
+   * @return A <code>boolean</code> representation of the value of this property.
+   * @throws ValueFormatException if conversion to a <code>boolean</code> is not possible or if the property is multi-valued.
+   * @throws RepositoryException if another error occurs.
+   * @see Value
+   */
+  getBoolean(): boolean;
+
+  /**
+   * If this property is of type <code>REFERENCE</code>,
+   * <code>WEAKREFERENCE</code> or <code>PATH</code> (or convertible to one of
+   * these types) this method returns the <code>Node</code> to which this
+   * property refers.
+   * <p>
+   * If this property is of type <code>PATH</code> and it contains a relative
+   * path, it is interpreted relative to the parent node of this property. For
+   * example "<code>.</code>" refers to the parent node itself,
+   * "<code>..</code>" to the parent of the parent node and "<code>foo</code>"
+   * to a sibling node of this property.
+   * @return the referenced Node
+   * @throws ValueFormatException if this property cannot be converted to a referring type (<code>REFERENCE</code>, <code>WEAKREFERENCE</code> or <code>PATH</code>), if the property is multi-valued or if this property is a referring type but is currently part of the frozen state of a version in version storage.
+   * @throws ItemNotFoundException If this property is of type <code>PATH</code> or <code>WEAKREFERENCE</code> and no target node accessible by the current <code>Session</code> exists in this workspace. Note that this applies even if the property is a <code>PATHS</code> and a <i>property</i> exists at the specified location. To dereference to a target property (as opposed to a target node), the method <code>Property.getProperty</code> is used.
+   * @throws RepositoryException if another error occurs.
+   */
+  getNode(): Node;
+
+  /**
+   * If this property is of type <code>PATH</code> (or convertible to this
+   * type) this method returns the <code>Property</code> to which <i>this</i>
+   * property refers.
+   * <p>
+   * If this property contains a relative path, it is interpreted relative to
+   * the parent node of this property. Therefore, when resolving such a
+   * relative path, the segment "<code>.</code>" refers to
+   * the parent node itself, "<code>..</code>" to the parent of the parent
+   * node and "<code>foo</code>" to a sibling property of this property or
+   * this property itself.
+   * <p>
+   * For example, if this property is located at
+   * <code>/a/b/c</code> and it has a value of "<code>../d</code>" then this
+   * method will return the property at <code>/a/d</code> if such exists.
+   * <p>
+   * If this property is multi-valued, this method throws a
+   * <code>ValueFormatException</code>.
+   * <p>
+   * If this property cannot be converted to a <code>PATH</code> then a
+   * <code>ValueFormatException</code> is thrown.
+   * <p>
+   * If this property is currently part of the frozen state of a version in
+   * version storage, this method will throw a <code>ValueFormatException</code>.
+   * @return the referenced property
+   * @throws ValueFormatException if this property cannot be converted to a <code>PATH</code>, if the property is multi-valued or if this property is a referring type but is currently part of the frozen state of a version in version storage.
+   * @throws ItemNotFoundException If no property accessible by the current <code>Session</code> exists in this workspace at the specified path. Note that this applies even if a <i>node</i> exists at the specified location. To dereference to a target node, the method <code>Property.getNode</code> is used.
+   * @throws RepositoryException if another error occurs.
+   * @since JCR 2.0
+   */
+  getProperty(): Property;
+
+  /**
+   * Returns the length of the value of this property.
+   * <p>
+   * For a <code>BINARY</code> property, <code>getLength</code> returns the
+   * number of bytes. For other property types, <code>getLength</code> returns
+   * the same value that would be returned by calling {@link
+   * java.lang.String#length()} on the value when it has been converted to a
+   * <code>STRING</code> according to standard JCR property type conversion.
+   * <p>
+   * Returns -1 if the implementation cannot determine the length.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @return an <code>long</code>.
+   * @throws ValueFormatException if this property is multi-valued.
+   * @throws RepositoryException if another error occurs.
+   */
+  getLength(): number;
+
+  /**
+   * Returns an array holding the lengths of the values of this (multi-value)
+   * property in bytes where each is individually calculated as described in
+   * {@link #getLength()}.
+   * <p>
+   * Returns a <code>-1</code> in the appropriate position if the
+   * implementation cannot determine the length of a value.
+   *
+   * <p><strong>Sitevision note:</strong> Unsupported operation</p>
+   * @return an array of lengths
+   * @throws ValueFormatException if this property is single-valued.
+   * @throws RepositoryException if another error occurs.
+   */
+  getLengths(): number;
+
+  /**
+   * Returns the property definition that applies to this property. In some
+   * cases there may appear to be more than one definition that could apply to
+   * this node. However, it is assumed that upon creation or change of this
+   * property, a single particular definition is chosen by the implementation.
+   * It is <i>that</i> definition that this method returns. How this governing
+   * definition is selected upon property creation or change from among others
+   * which may have been applicable is an implementation issue and is not
+   * covered by this specification.
+   * @return a <code>PropertyDefinition</code> object.
+   * @throws RepositoryException if an error occurs.
+   * @see javax.jcr.nodetype.NodeType#getPropertyDefinitions
+   */
+  getDefinition(): PropertyDefinition;
+
+  /**
+   * Returns the type of this <code>Property</code>. One of: <ul>
+   * <li><code>PropertyType.STRING</code></li> <li><code>PropertyType.BINARY</code></li>
+   * <li><code>PropertyType.DATE</code></li> <li><code>PropertyType.DOUBLE</code></li>
+   * <li><code>PropertyType.LONG</code></li> <li><code>PropertyType.BOOLEAN</code></li>
+   * <li><code>PropertyType.NAME</code></li> <li><code>PropertyType.PATH</code></li>
+   * <li><code>PropertyType.REFERENCE</code></li> <li><code>PropertyType.WEAKREFERENCE</code></li>
+   * <li><code>PropertyType.URI</code></li> </ul> The type returned is that
+   * which was set at property creation. Note that for some property
+   * <code>p</code>, the type returned by <code>p.getType()</code> will differ
+   * from the type returned by <code>p.getDefinition.getRequiredType()</code>
+   * only in the case where the latter returns <code>UNDEFINED</code>. The
+   * type of a property instance is never <code>UNDEFINED</code> (it must
+   * always have some actual type).
+   * @return an int
+   * @throws RepositoryException if an error occurs
+   */
+  getType(): number;
+
+  /**
+   * Returns <code>true</code> if this property is multi-valued and
+   * <code>false</code> if this property is single-valued.
+   * @return <code>true</code> if this property is multi-valued; <code>false</code> otherwise.
+   * @throws RepositoryException if an error occurs.
+   */
+  isMultiple(): boolean;
+}
+
+export default Property;