src/main/generic/interfaces/ICommittable.js

/**
 * This interface represents an object store (roughly corresponding to a table in a relational database).
 * It stores key-value pairs where the key is generally considered to be a string and the value is any object.
 * The key is the entry's primary key. Other keys within the object may be accessed by indices as offered by the store.
 * @interface
 */
class ICommittable {
    /**
     * Is used to commit the state of an open transaction.
     * A user only needs to call this method on Transactions without arguments.
     * The optional tx argument is only used internally, in order to commit a transaction to the underlying store.
     * If the commit was successful, the method returns true, and false otherwise.
     * @abstract
     * @param {Transaction} [tx] The transaction to be applied, only used internally.
     * @returns {Promise.<boolean>} A promise of the success outcome.
     */
    async commit(tx) {} // eslint-disable-line no-unused-vars

    /**
     * Is used to abort an open transaction.
     * A user only needs to call this method on Transactions without arguments.
     * The optional tx argument is only used internally, in order to abort a transaction on the underlying store.
     * @abstract
     * @param {Transaction} [tx] The transaction to be aborted, only used internally.
     * @returns {Promise} The promise resolves after successful abortion of the transaction.
     */
    async abort(tx) {} // eslint-disable-line no-unused-vars

    /**
     * Is used to probe whether a transaction can be committed.
     * This, for example, includes a check whether another transaction has already been committed.
     * @abstract
     * @protected
     * @param {Transaction} [tx] The transaction to be applied, if not given checks for the this transaction.
     * @returns {boolean} Whether a commit will be successful.
     */
    _isCommittable(tx) {} // eslint-disable-line no-unused-vars

    /**
     * Is used to check constraints before committing.
     * If a constraint is not satisfied, the commitable is aborted and an exception is thrown.
     * @abstract
     * @returns {Promise.<boolean>}
     * @throws
     * @protected
     */
    async _checkConstraints() {}

    /**
     * Is used to commit the transaction.
     * @abstract
     * @protected
     * @param {Transaction} tx The transaction to be applied.
     * @returns {Promise} A promise that resolves upon successful application of the transaction.
     */
    async _commitInternal(tx) {} // eslint-disable-line no-unused-vars

    /**
     * Commits the transaction to the backend.
     * @abstract
     * @returns {Promise.<boolean>} A promise of the success outcome.
     * @protected
     */
    async _commitBackend() {} // eslint-disable-line no-unused-vars

    /**
     * Aborts a transaction on the backend.
     * @abstract
     * @returns {Promise.<boolean>} A promise of the success outcome.
     */
    async _abortBackend() {} // eslint-disable-line no-unused-vars

    /**
     * Sets the state to aborted.
     * @abstract
     */
    _setAborted() {} // eslint-disable-line no-unused-vars

    /**
     * Allows to change the backend of a Transaction when the state has been flushed.
     * @abstract
     * @param parent
     * @protected
     */
    _setParent(parent) {} // eslint-disable-line no-unused-vars

    /**
     * Retrieve a transactions immediate parent.
     * @abstract
     * @type {IObjectStore}
     * @protected
     */
    get _parent() { return null; } // eslint-disable-line no-unused-vars

    /**
     * Sets a new CombinedTransaction as dependency.
     * @param {CombinedTransaction} dependency
     * @protected
     */
    set _dependency(dependency) {} // eslint-disable-line no-unused-vars

    /**
     * @type {CombinedTransaction} If existent, a combined transaction encompassing this object.
     */
    get dependency() { return null; } // eslint-disable-line no-unused-vars

    /**
     * Returns the object store this transaction belongs to.
     * @tyoe {ObjectStore}
     */
    get objectStore() { return null; } // eslint-disable-line no-unused-vars
}