@sitevision/api 1.0.20 → 1.1.0-alpha.1

package/hidden/javax/jcr/observation/Event/index.d.ts

@@ -0,0 +1,133 @@
+/**
+ * An event fired by the observation mechanism.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns the type of this event: a constant defined by this interface. One
+ * of: <ul> <li><code>NODE_ADDED</code></li> <li><code>NODE_REMOVED</code></li>
+ * <li><code>PROPERTY_ADDED</code></li> <li><code>PROPERTY_REMOVED</code></li>
+ * <li><code>PROPERTY_CHANGED</code></li> <li><code>NODE_MOVED</code></li>
+ * <li><code>PERSIST</code></li> </ul>Returns the absolute path associated with this event or <code>null</code>
+ * if this event has no associated identifier. The meaning of the associated
+ * path depends upon the type of the event. See event type constants above.Returns the user ID connected with this event. This is the string
+ * returned by {@link javax.jcr.Session#getUserID} of the session that
+ * caused the event.Returns the identifier associated with this event or <code>null</code> if
+ * this event has no associated identifier. The meaning of the associated
+ * identifier depends upon the type of the event. See event type constants
+ * above.Returns the information map associated with this event. The meaning of
+ * the map depends upon the type of the event. See event type constants
+ * above.Returns the user data set through {@link ObservationManager#setUserData}
+ * on the <code>ObservationManager</code> bound to the <code>Session</code>
+ * that caused the event.Returns the date when the change was persisted that caused this event.
+ * The date is represented as a millisecond value that is an offset from the
+ * Epoch, January 1, 1970 00:00:00.000 GMT (Gregorian). The granularity of
+ * the returned value is implementation dependent.Generated on persist when a node is added. <ul> <li>{@link #getPath}
+ * returns the absolute path of the node that was added.</li> <li>{@link
+ * #getIdentifier} returns the identifier of the node that was added.</li>
+ * <li>{@link #getInfo} returns an empty <code>Map</code> object.</li>
+ * </ul>Generated on persist when a node is removed. <ul> <li>{@link #getPath}
+ * returns the absolute path of the node that was removed.</li> <li>{@link
+ * #getIdentifier} returns the identifier of the node that was removed.</li>
+ * <li>{@link #getInfo} returns an empty <code>Map</code> object.</li>
+ * </ul>Generated on persist when a property is added. <ul> <li>{@link #getPath}
+ * returns the absolute path of the property that was added.</li> <li>{@link
+ * #getIdentifier} returns the identifier of the parent node of the property
+ * that was added. <li>{@link #getInfo} returns an empty <code>Map</code>
+ * object.</li> </ul>Generated on persist when a property is removed. <ul> <li>{@link
+ * #getPath} returns the absolute path of the property that was
+ * removed.</li> <li>{@link #getIdentifier} returns the identifier of the
+ * parent node of the property that was removed. <li>{@link #getInfo}
+ * returns an empty <code>Map</code> object.</li> </ul>Generated on persist when a property is changed. <ul> <li>{@link
+ * #getPath} returns the absolute path of the property that was
+ * changed.</li> <li>{@link #getIdentifier} returns the identifier of the
+ * parent node of the property that was changed. <li>{@link #getInfo}
+ * returns an empty <code>Map</code> object.</li> </ul>Generated on persist when a node is moved. <ul> <li>{@link #getPath}
+ * returns the absolute path of the destination of the move.</li> <li>{@link
+ * #getIdentifier} returns the identifier of the moved node. <li> {@link
+ * #getInfo} If the method that caused this event was a {@link
+ * javax.jcr.Session#move Session.move} or {@link javax.jcr.Workspace#move
+ * Workspace.move} then the returned {@link java.util.Map Map} has keys
+ * <code>srcAbsPath</code> and <code>destAbsPath</code> with values
+ * corresponding to the parameters passed to the <code>move</code> method.
+ * <p>
+ * If the method that caused this event was a {@link
+ * javax.jcr.Node#orderBefore Node.orderBefore} then the returned
+ * <code>Map</code> has keys <code>srcChildRelPath</code> and
+ * <code>destChildRelPath</code> with values corresponding to the parameters
+ * passed to the <code>orderBefore</code> method. </li> </ul>If event bundling is supported, this event is used to indicate a bundle
+ * boundary within the event journal. <ul> <li>{@link #getPath} returns
+ * <code>null</code>.</li> <li>{@link #getIdentifier} returns
+ * <code>null</code>.</li> <li>{@link #getInfo} returns an empty
+ * <code>Map</code> object.</li> </ul>
+  
+    */
+interface Event {
+  /**
+   * Returns the type of this event: a constant defined by this interface. One
+   * of: <ul> <li><code>NODE_ADDED</code></li> <li><code>NODE_REMOVED</code></li>
+   * <li><code>PROPERTY_ADDED</code></li> <li><code>PROPERTY_REMOVED</code></li>
+   * <li><code>PROPERTY_CHANGED</code></li> <li><code>NODE_MOVED</code></li>
+   * <li><code>PERSIST</code></li> </ul>
+   * @return the type of this event.
+   */
+  getType(): number;
+
+  /**
+   * Returns the absolute path associated with this event or <code>null</code>
+   * if this event has no associated identifier. The meaning of the associated
+   * path depends upon the type of the event. See event type constants above.
+   * @return the absolute path associated with this event or <code>null</code>.
+   * @throws RepositoryException if an error occurs.
+   */
+  getPath(): string;
+
+  /**
+   * Returns the user ID connected with this event. This is the string
+   * returned by {@link javax.jcr.Session#getUserID} of the session that
+   * caused the event.
+   * @return the user ID.
+   */
+  getUserID(): string;
+
+  /**
+   * Returns the identifier associated with this event or <code>null</code> if
+   * this event has no associated identifier. The meaning of the associated
+   * identifier depends upon the type of the event. See event type constants
+   * above.
+   * @return the identifier associated with this event or <code>null</code>.
+   * @throws RepositoryException if an error occurs.
+   * @since JCR 2.0
+   */
+  getIdentifier(): string;
+
+  /**
+   * Returns the information map associated with this event. The meaning of
+   * the map depends upon the type of the event. See event type constants
+   * above.
+   * @return A <code>Map</code> containing parameter information for instances of a <code>NODE_MOVED</code> event.
+   * @throws RepositoryException if an error occurs.
+   * @since JCR 2.0
+   */
+  getInfo(): Record<unknown, unknown>;
+
+  /**
+   * Returns the user data set through {@link ObservationManager#setUserData}
+   * on the <code>ObservationManager</code> bound to the <code>Session</code>
+   * that caused the event.
+   * @return The user data string.
+   * @throws RepositoryException if an error occurs.
+   * @since JCR 2.0
+   */
+  getUserData(): string;
+
+  /**
+   * Returns the date when the change was persisted that caused this event.
+   * The date is represented as a millisecond value that is an offset from the
+   * Epoch, January 1, 1970 00:00:00.000 GMT (Gregorian). The granularity of
+   * the returned value is implementation dependent.
+   * @return the date when the change was persisted that caused this event.
+   * @throws RepositoryException if an error occurs.
+   * @since JCR 2.0
+   */
+  getDate(): number;
+}
+
+export default Event;

package/hidden/javax/jcr/observation/EventIterator/index.d.ts

@@ -0,0 +1,20 @@
+import Event from "../Event";
+
+/**
+ * Allows easy iteration through a list of <code>Event</code>s with
+ * <code>nextEvent</code> as well as a <code>skip</code> method inherited from
+ * <code>RangeIterator</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns the next <code>Event</code> in the iteration.
+  
+    */
+interface EventIterator {
+  /**
+   * Returns the next <code>Event</code> in the iteration.
+   * @return the next <code>Event</code> in the iteration.
+   * @throws java.util.NoSuchElementException if iteration has no more <code>Event</code>s.
+   */
+  nextEvent(): Event;
+}
+
+export default EventIterator;

package/hidden/javax/jcr/observation/EventJournal/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * An <code>EventJournal</code> is an extension of <code>EventIterator</code>
+ * that provides the additional method {@link #skipTo(long)}.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Skip all elements of the iterator earlier than <code>date</code>.
+ * <p>
+ * If an attempt is made to skip past the last element of the iterator, no
+ * exception is thrown but the subsequent {@link #nextEvent()} will fail.
+ * @since JCR 2.0
+ */
+interface EventJournal {
+  /**
+   * Skip all elements of the iterator earlier than <code>date</code>.
+   * <p>
+   * If an attempt is made to skip past the last element of the iterator, no
+   * exception is thrown but the subsequent {@link #nextEvent()} will fail.
+   * @param date a long value that represents an offset in milliseconds from the Epoch, January 1, 1970 00:00:00.000 GMT (Gregorian).
+   */
+  skipTo(date: number): void;
+}
+
+export default EventJournal;

package/hidden/javax/jcr/observation/EventListener/index.d.ts

@@ -0,0 +1,23 @@
+import EventIterator from "../EventIterator";
+
+/**
+ * An event listener.
+ * <p>
+ * An <code>EventListener</code> can be registered via the <code>{@link
+ * javax.jcr.observation.ObservationManager}</code> object. Event listeners are
+ * notified asynchronously, and see events after they occur and the transaction
+ * is committed. An event listener only sees events for which the session that
+ * registered it has sufficient access rights.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>This method is called when a bundle of events is dispatched.
+  
+    */
+interface EventListener {
+  /**
+   * This method is called when a bundle of events is dispatched.
+   * @param events The event set received.
+   */
+  onEvent(events: EventIterator): void;
+}
+
+export default EventListener;

package/hidden/javax/jcr/observation/EventListenerIterator/index.d.ts

@@ -0,0 +1,20 @@
+import EventListener from "../EventListener";
+
+/**
+ * Allows easy iteration through a list of <code>EventListener</code>s with
+ * <code>nextEventListener</code> as well as a <code>skip</code> method
+ * inherited from <code>RangeIterator</code>.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Returns the next <code>EventListener</code> in the iteration.
+  
+    */
+interface EventListenerIterator {
+  /**
+   * Returns the next <code>EventListener</code> in the iteration.
+   * @return the next <code>EventListener</code> in the iteration.
+   * @throws java.util.NoSuchElementException if iteration has no more <code>EventListener</code>s.
+   */
+  nextEventListener(): EventListener;
+}
+
+export default EventListenerIterator;

package/hidden/javax/jcr/observation/ObservationManager/index.d.ts

@@ -0,0 +1,227 @@
+import EventListener from "../EventListener";
+import EventListenerIterator from "../EventListenerIterator";
+import EventJournal from "../EventJournal";
+
+/**
+ * The ObservationManager object.
+ * <p>
+ * Acquired via <code>{@link javax.jcr.Workspace#getObservationManager()}</code>.
+ * Allows for the registration and deregistration of event listeners.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Adds an event listener that listens for the specified
+ * <code>eventTypes</code> (a combination of one or more event types encoded
+ * as a bit mask value).
+ * <p>
+ * The set of events will be further filtered by the access rights of the
+ * current <code>Session</code> as well as the restrictions specified by the
+ * parameters of this method. These restrictions are stated in terms of
+ * characteristics of the <i>associated parent node</i> of the event.
+ * <p>
+ * The associated parent node of an event is the parent node of the item at
+ * (or formerly at) the path returned by {@link Event#getPath}. The
+ * following restrictions are available: <ul> <li> <code>absPath</code>,
+ * <code>isDeep</code>: Only events whose associated parent node is at
+ * <code>absPath</code> (or within its subgraph, if <code>isDeep</code> is
+ * <code>true</code>) will be received. It is permissible to register a
+ * listener for a path where no node currently exists. </li> <li>
+ * <code>uuid</code>: Only events whose associated parent node has one of
+ * the identifiers in this list will be received. If his parameter is
+ * <code>null</code> then no identifier-related restriction is placed on
+ * events received. Note that specifying an empty array instead of
+ * <code>null</code> would result in no nodes being listened to. The term
+ * "UUID" is used for compatibility with JCR 1.0. </li> <li>
+ * <code>nodeTypeName</code>: Only events whose associated parent node has
+ * one of the node types (or a subtype of one of the node types) in this
+ * list will be received. If his parameter is <code>null</code> then no node
+ * type-related restriction is placed on events received. Note that
+ * specifying an empty array instead of <code>null</code> would result in no
+ * nodes types being listened to. </li> </ul> The restrictions are "ANDed"
+ * together. In other words, for a particular node to be "listened to" it
+ * must meet all the restrictions.
+ * <p>
+ * Additionally, if <code>noLocal</code> is <code>true</code>, then events
+ * generated by the session through which the listener was registered are
+ * ignored. Otherwise, they are not ignored.
+ * <p>
+ * The filters of an already-registered <code>EventListener</code> can be
+ * changed at runtime by re-registering the same <code>EventListener</code>
+ * object (i.e. the same actual Java object) with a new set of filter
+ * arguments. The implementation must ensure that no events are lost during
+ * the changeover.
+ * <p>
+ * In addition to the filters placed on a listener above, the scope of
+ * observation support, in terms of which subgraphs are observable, may also
+ * be subject to implementation-specific restrictions. For example, in some
+ * repositories observation of changes in the <code>jcr:system</code>
+ * subgraph may not be supportedDeregisters an event listener.
+ * <p>
+ * A listener may be deregistered while it is being executed. The
+ * deregistration method will block until the listener has completed
+ * executing. An exception to this rule is a listener which deregisters
+ * itself from within the <code>onEvent</code> method. In this case, the
+ * deregistration method returns immediately, but deregistration will
+ * effectively be delayed until the listener completes.Returns all event listeners that have been registered through this
+ * session. If no listeners have been registered, an empty iterator is
+ * returned.Sets the user data information that will be returned by {@link
+ * Event#getUserData}.Retrieves the event journal for this workspace. If journaled observation
+ * is not supported for this workspace, <code>null</code> is returned.
+ * Events recorded in the <code>EventJournal</code> instance will be
+ * filtered according to the current session's access rights as well as any
+ * additional restrictions specified through implemention-specific
+ * configuration.Retrieves the event journal for this workspace.
+ * <p>
+ * If journaled observation
+ * is not supported for this workspace, <code>null</code> is returned.
+ * <p>
+ * Events returned in the <code>EventJournal</code> instance will be
+ * filtered according to the parameters of this method,
+ * the current session's access restrictions as well as any
+ * additional restrictions specified through implemention-specific
+ * configuration.
+ * <p>
+ * The parameters of this method filter the event set in the same way as
+ * they do in {@link #addEventListener}.
+  
+    */
+interface ObservationManager {
+  /**
+   * Adds an event listener that listens for the specified
+   * <code>eventTypes</code> (a combination of one or more event types encoded
+   * as a bit mask value).
+   * <p>
+   * The set of events will be further filtered by the access rights of the
+   * current <code>Session</code> as well as the restrictions specified by the
+   * parameters of this method. These restrictions are stated in terms of
+   * characteristics of the <i>associated parent node</i> of the event.
+   * <p>
+   * The associated parent node of an event is the parent node of the item at
+   * (or formerly at) the path returned by {@link Event#getPath}. The
+   * following restrictions are available: <ul> <li> <code>absPath</code>,
+   * <code>isDeep</code>: Only events whose associated parent node is at
+   * <code>absPath</code> (or within its subgraph, if <code>isDeep</code> is
+   * <code>true</code>) will be received. It is permissible to register a
+   * listener for a path where no node currently exists. </li> <li>
+   * <code>uuid</code>: Only events whose associated parent node has one of
+   * the identifiers in this list will be received. If his parameter is
+   * <code>null</code> then no identifier-related restriction is placed on
+   * events received. Note that specifying an empty array instead of
+   * <code>null</code> would result in no nodes being listened to. The term
+   * "UUID" is used for compatibility with JCR 1.0. </li> <li>
+   * <code>nodeTypeName</code>: Only events whose associated parent node has
+   * one of the node types (or a subtype of one of the node types) in this
+   * list will be received. If his parameter is <code>null</code> then no node
+   * type-related restriction is placed on events received. Note that
+   * specifying an empty array instead of <code>null</code> would result in no
+   * nodes types being listened to. </li> </ul> The restrictions are "ANDed"
+   * together. In other words, for a particular node to be "listened to" it
+   * must meet all the restrictions.
+   * <p>
+   * Additionally, if <code>noLocal</code> is <code>true</code>, then events
+   * generated by the session through which the listener was registered are
+   * ignored. Otherwise, they are not ignored.
+   * <p>
+   * The filters of an already-registered <code>EventListener</code> can be
+   * changed at runtime by re-registering the same <code>EventListener</code>
+   * object (i.e. the same actual Java object) with a new set of filter
+   * arguments. The implementation must ensure that no events are lost during
+   * the changeover.
+   * <p>
+   * In addition to the filters placed on a listener above, the scope of
+   * observation support, in terms of which subgraphs are observable, may also
+   * be subject to implementation-specific restrictions. For example, in some
+   * repositories observation of changes in the <code>jcr:system</code>
+   * subgraph may not be supported
+   * @param listener an {@link EventListener} object.
+   * @param eventTypes A combination of one or more event type constants encoded as a bitmask.
+   * @param absPath an absolute path.
+   * @param isDeep a <code>boolean</code>.
+   * @param uuid array of identifiers.
+   * @param nodeTypeName array of node type names.
+   * @param noLocal a <code>boolean</code>.
+   * @throws RepositoryException If an error occurs.
+   */
+  addEventListener(
+    listener: EventListener,
+    eventTypes: number,
+    absPath: string,
+    isDeep: boolean,
+    uuid: string,
+    nodeTypeName: string,
+    noLocal: boolean
+  ): void;
+
+  /**
+   * Deregisters an event listener.
+   * <p>
+   * A listener may be deregistered while it is being executed. The
+   * deregistration method will block until the listener has completed
+   * executing. An exception to this rule is a listener which deregisters
+   * itself from within the <code>onEvent</code> method. In this case, the
+   * deregistration method returns immediately, but deregistration will
+   * effectively be delayed until the listener completes.
+   * @param listener The listener to deregister.
+   * @throws RepositoryException If an error occurs.
+   */
+  removeEventListener(listener: EventListener): void;
+
+  /**
+   * Returns all event listeners that have been registered through this
+   * session. If no listeners have been registered, an empty iterator is
+   * returned.
+   * @return an <code>EventListenerIterator</code>.
+   * @throws RepositoryException If an error occurs
+   */
+  getRegisteredEventListeners(): EventListenerIterator;
+
+  /**
+   * Sets the user data information that will be returned by {@link
+   * Event#getUserData}.
+   * @param userData the user data
+   * @throws RepositoryException if an error occurs
+   */
+  setUserData(userData: string): void;
+
+  /**
+   * Retrieves the event journal for this workspace. If journaled observation
+   * is not supported for this workspace, <code>null</code> is returned.
+   * Events recorded in the <code>EventJournal</code> instance will be
+   * filtered according to the current session's access rights as well as any
+   * additional restrictions specified through implemention-specific
+   * configuration.
+   * @return an <code>EventJournal</code> or <code>null</code>.
+   * @throws RepositoryException if an error occurs
+   */
+  getEventJournal(): EventJournal;
+
+  /**
+   * Retrieves the event journal for this workspace.
+   * <p>
+   * If journaled observation
+   * is not supported for this workspace, <code>null</code> is returned.
+   * <p>
+   * Events returned in the <code>EventJournal</code> instance will be
+   * filtered according to the parameters of this method,
+   * the current session's access restrictions as well as any
+   * additional restrictions specified through implemention-specific
+   * configuration.
+   * <p>
+   * The parameters of this method filter the event set in the same way as
+   * they do in {@link #addEventListener}.
+   * @param eventTypes A combination of one or more event type constants encoded as a bitmask.
+   * @param absPath an absolute path.
+   * @param isDeep a <code>boolean</code>.
+   * @param uuid array of identifiers.
+   * @param nodeTypeName array of node type names.
+   * @return an <code>EventJournal</code> or <code>null</code>.
+   * @throws RepositoryException If an error occurs.
+   */
+  getEventJournal(
+    eventTypes: number,
+    absPath: string,
+    isDeep: boolean,
+    uuid: string,
+    nodeTypeName: string
+  ): EventJournal;
+}
+
+export default ObservationManager;

package/hidden/javax/jcr/query/Query/index.d.ts

@@ -0,0 +1,201 @@
+import QueryResult from "../QueryResult";
+import Node from "../../Node";
+import Value from "../../Value";
+
+/**
+ * A <code>Query</code> object.
+ *
+ * <p><strong>Sitevision note:</strong> Unsupported operation</p>Executes this query and returns a <code>{@link QueryResult}</code>
+ * object.
+ * <p>
+ * If this <code>Query</code> contains a variable (see {@link
+ * javax.jcr.query.qom.BindVariableValue BindVariableValue}) which has not
+ * been bound to a value (see {@link Query#bindValue}) then this method
+ * throws an <code>InvalidQueryException</code>.Sets the maximum size of the result set to <code>limit</code>.Sets the start offset of the result set to <code>offset</code>.Returns the statement defined for this query.
+ * <p>
+ * If the language of this query is JCR-SQL2 or another string-based
+ * language, this method will return the statement that was used to create
+ * this query.
+ * <p>
+ * If the language of this query is JCR-JQOM, this method will return the
+ * JCR-SQL2 equivalent of the JCR-JQOM object tree. This is the standard
+ * serialization of JCR-JQOM and is also the string stored in the
+ * <code>jcr:statement</code> property if the query is persisted. See {@link
+ * #storeAsNode(String)}.Returns the language set for this query. This will be one of the query
+ * language constants returned by {@link QueryManager#getSupportedQueryLanguages}.If this is a <code>Query</code> object that has been stored using {@link
+ * Query#storeAsNode} (regardless of whether it has been <code>save</code>d
+ * yet) or retrieved using {@link QueryManager#getQuery}), then this method
+ * returns the path of the <code>nt:query</code> node that stores the
+ * query.Creates a node of type <code>nt:query</code> holding this query at
+ * <code>absPath</code> and returns that node.
+ * <p>
+ * This is  a session-write method and therefore requires a
+ * <code>Session.save()</code> to dispatch the change.
+ * <p>
+ * The <code>absPath</code> provided must not have an index on its final
+ * element. If ordering is supported by the node type of the parent node
+ * then the new node is appended to the end of the child node list.
+ * <p>
+ * An <code>ItemExistsException</code> will be thrown either immediately, on
+ * dispatch or on persists, if an item at the specified path already exists
+ * and same-name siblings are not allowed. Implementations may differ on
+ * when this validation is performed.
+ * <p>
+ * A <code>PathNotFoundException</code> will be thrown either immediately,
+ * on dispatch or on persists, if the specified path implies intermediary
+ * nodes that do not exist. Implementations may differ on when this
+ * validation is performed.
+ * <p>
+ * A <code>ConstraintViolationException</code>will be thrown either
+ * immediately, on dispatch or on persists, if adding the node would violate
+ * a node type or implementation-specific constraint or if an attempt is
+ * made to add a node as the child of a property. Implementations may differ
+ * on when this validation is performed.
+ * <p>
+ * A <code>VersionException</code> will be thrown either immediately, on
+ * dispatch or on persists, if the node to which the new child is being
+ * added 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 persists, if a lock prevents the addition of the node.
+ * Implementations may differ on when this validation is performed.Binds the given <code>value</code> to the variable named
+ * <code>varName</code>.Returns the names of the bind variables in this query. If this query does
+ * not contains any bind variables then an empty array is returned.A string constant representing the XPath query language as defined in JCR
+ * 1.0.A string constant representing the SQL query language as defined in JCR
+ * 1.0.A string constant representing the JCR-SQL2 query language.A string constant representing the JCR-JQOM query language.
+  
+    */
+interface Query {
+  /**
+   * Executes this query and returns a <code>{@link QueryResult}</code>
+   * object.
+   * <p>
+   * If this <code>Query</code> contains a variable (see {@link
+   * javax.jcr.query.qom.BindVariableValue BindVariableValue}) which has not
+   * been bound to a value (see {@link Query#bindValue}) then this method
+   * throws an <code>InvalidQueryException</code>.
+   * @return a <code>QueryResult</code> object
+   * @throws InvalidQueryException if the query contains an unbound variable.
+   * @throws RepositoryException if another error occurs.
+   */
+  execute(): QueryResult;
+
+  /**
+   * Sets the maximum size of the result set to <code>limit</code>.
+   * @param limit a <code>long</code>
+   * @since JCR 2.0
+   */
+  setLimit(limit: number): void;
+
+  /**
+   * Sets the start offset of the result set to <code>offset</code>.
+   * @param offset a <code>long</code>
+   * @since JCR 2.0
+   */
+  setOffset(offset: number): void;
+
+  /**
+   * Returns the statement defined for this query.
+   * <p>
+   * If the language of this query is JCR-SQL2 or another string-based
+   * language, this method will return the statement that was used to create
+   * this query.
+   * <p>
+   * If the language of this query is JCR-JQOM, this method will return the
+   * JCR-SQL2 equivalent of the JCR-JQOM object tree. This is the standard
+   * serialization of JCR-JQOM and is also the string stored in the
+   * <code>jcr:statement</code> property if the query is persisted. See {@link
+   * #storeAsNode(String)}.
+   * @return the query statement.
+   */
+  getStatement(): string;
+
+  /**
+   * Returns the language set for this query. This will be one of the query
+   * language constants returned by {@link QueryManager#getSupportedQueryLanguages}.
+   * @return the query language.
+   */
+  getLanguage(): string;
+
+  /**
+   * If this is a <code>Query</code> object that has been stored using {@link
+   * Query#storeAsNode} (regardless of whether it has been <code>save</code>d
+   * yet) or retrieved using {@link QueryManager#getQuery}), then this method
+   * returns the path of the <code>nt:query</code> node that stores the
+   * query.
+   * @return path of the node representing this query.
+   * @throws ItemNotFoundException if this query is not a stored query.
+   * @throws RepositoryException if another error occurs.
+   */
+  getStoredQueryPath(): string;
+
+  /**
+   * Creates a node of type <code>nt:query</code> holding this query at
+   * <code>absPath</code> and returns that node.
+   * <p>
+   * This is  a session-write method and therefore requires a
+   * <code>Session.save()</code> to dispatch the change.
+   * <p>
+   * The <code>absPath</code> provided must not have an index on its final
+   * element. If ordering is supported by the node type of the parent node
+   * then the new node is appended to the end of the child node list.
+   * <p>
+   * An <code>ItemExistsException</code> will be thrown either immediately, on
+   * dispatch or on persists, if an item at the specified path already exists
+   * and same-name siblings are not allowed. Implementations may differ on
+   * when this validation is performed.
+   * <p>
+   * A <code>PathNotFoundException</code> will be thrown either immediately,
+   * on dispatch or on persists, if the specified path implies intermediary
+   * nodes that do not exist. Implementations may differ on when this
+   * validation is performed.
+   * <p>
+   * A <code>ConstraintViolationException</code>will be thrown either
+   * immediately, on dispatch or on persists, if adding the node would violate
+   * a node type or implementation-specific constraint or if an attempt is
+   * made to add a node as the child of a property. Implementations may differ
+   * on when this validation is performed.
+   * <p>
+   * A <code>VersionException</code> will be thrown either immediately, on
+   * dispatch or on persists, if the node to which the new child is being
+   * added 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 persists, if a lock prevents the addition of the node.
+   * Implementations may differ on when this validation is performed.
+   * @param absPath absolute path the query should be stored at
+   * @return the newly created node.
+   * @throws ItemExistsException if an item at the specified path already exists, same-name siblings are not allowed and this implementation performs this validation immediately.
+   * @throws PathNotFoundException if the specified path implies intermediary <code>Node</code>s that do not exist or the last element of <code>relPath</code> has an index, and this implementation performs this validation immediately.
+   * @throws ConstraintViolationException if a node type or implementation-specific constraint is violated or if an attempt is made to add a node as the child of a property and this implementation performs this validation immediately.
+   * @throws VersionException if the node to which the new child is being added is read-only due to a checked-in node and this implementation performs this validation immediately.
+   * @throws LockException if a lock prevents the addition of the node and this implementation performs this validation immediately.
+   * @throws UnsupportedRepositoryOperationException if persistent queries are not supported.
+   * @throws RepositoryException if another error occurs or if the <code>absPath</code> provided has an index on its final element.
+   */
+  storeAsNode(absPath: string): Node;
+
+  /**
+   * Binds the given <code>value</code> to the variable named
+   * <code>varName</code>.
+   * @param varName name of variable in query
+   * @param value value to bind
+   * @throws IllegalArgumentException if <code>varName</code> is not a valid variable in this query.
+   * @throws javax.jcr.RepositoryException if an error occurs.
+   * @since JCR 2.0
+   */
+  bindValue(varName: string, value: Value): void;
+
+  /**
+   * Returns the names of the bind variables in this query. If this query does
+   * not contains any bind variables then an empty array is returned.
+   * @return the names of the bind variables in this query.
+   * @throws RepositoryException if an error occurs.
+   * @since JCR 2.0
+   */
+  getBindVariableNames(): string;
+}
+
+export default Query;