import type { TimeSpan } from 'src/NodeJS/types';
import { IJob } from './IJob';
import { IJobBase } from './IJobBase';
import { JobState } from './JobState';
/** A base repository to use for generic job management. */
export interface IJobRepository<TParams, TResult> {
    /**
    * Adds a new job to the database.
    *
    * @param type The type of the job.
    * @param dueDate The date when the job should be executed. If not given current date is used.
    * @param parameters The parameters of the job.
    * @param cancellationToken A token to cancel the operation.
    * @returns The added job.
    */
    addJobAsync(type: string, dueDate: Date | undefined, parameters?: TParams, cancellationToken?: AbortSignal): Promise<IJob<TParams, TResult>>;
    /**
    * Adds the given amount to successful or failed items of the job to indicate progress.
    *
    * @param job The job.
    * @param items The amount of items to add. Defaults to 1.
    * @param failed If <see langword="true" />, amount is added to failed items instead of successful items.
    * @param cancellationToken A token to cancel the operation.
    * @returns A task indicating when the operation is complete.
    */
    addProgressAsync(job: IJobBase, items?: number, failed?: boolean, cancellationToken?: AbortSignal): Promise<void>;
    /**
    * Counts the jobs in the database optionally filtered by type or state.
    *
    * @param type The type of the job.
    * @param state The state of the job.
    * @param cancellationToken A token to cancel the operation.
    * @returns The amount of jobs in the database.
    */
    countJobsAsync(type: string, state?: JobState, cancellationToken?: AbortSignal): Promise<number>;
    /**
    * Deletes jobs from the database filtered by type, state, last updated date or a combination of these.
    *
    * @param type The type of the job.
    * @param state The state of the job.
    * @param lastUpdatedBefore The date until when the job was last updated.
    * @param cancellationToken A token to cancel the operation.
    * @returns The amount of jobs that were deleted.
    */
    deleteJobsAsync(type: string, state?: JobState, lastUpdatedBefore?: Date | undefined, cancellationToken?: AbortSignal): Promise<number>;
    /**
    * Checks if a job with the given conditions already exists and returns it if so.
    *
    * @param type The type of the job.
    * @param dueDate The date until when the job should be done.
    * @param parameters The parameters of the job.
    * @param includeStarted If <see langword="true" /> job will also be found if state is <see cref="F:DroidSolutions.Oss.JobService.JobState.Started" />, else only jobs that are            <see cref="F:DroidSolutions.Oss.JobService.JobState.Requested" /> are found.
    * @param cancellationToken A token to cancel the operation.
    * @returns The job if found or null if not.
    */
    findExistingJobAsync(type: string, dueDate: Date | undefined, parameters?: TParams, includeStarted?: boolean, cancellationToken?: AbortSignal): Promise<IJob<TParams, TResult> | undefined>;
    /**
    * Marks the job complete, sets the result and optionally adds a new job.
    *
    * @param job The job to complete.
    * @param addNextJobIn An optional timespan when the next job should be run.
    * @param cancellationToken A token to cancel the operation.
    * @returns A task indicating when the operation is completed.
    */
    finishJobAsync(job: IJob<TParams, TResult>, addNextJobIn: TimeSpan | undefined, cancellationToken?: AbortSignal): Promise<void>;
    /**
    * Checks the jobs table for a job that is requested and the due date passed and the given type matches. If any
    *             exist the one with the oldest due date is grabbed and updated. The state is set to Started. if no job with the
    *             given conditions exist, null is returned.
    *
    * @param type The type of the job.
    * @param runner The unique name of the runner. Should contain the name, version number and a unique string.
    * @param cancellationToken A token to cancel the operation.
    * @returns The job with the oldest due date that matched the filter or null if no job matched.
    */
    getAndStartFirstPendingJobAsync(type: string, runner: string, cancellationToken?: AbortSignal): Promise<IJob<TParams, TResult> | undefined>;
    /**
    * Resets a job back to the requested state.
    *
    * @param job The job.
    * @param cancellationToken A token to cancel the operation.
    * @returns A task indicating when the operation is complete.
    */
    resetJobAsync(job: IJob<TParams, TResult>, cancellationToken?: AbortSignal): Promise<void>;
    /**
    * Sets the amount of total items of the job.
    *
    * @param job The job.
    * @param total The amount of items to process in the scope of this job.
    * @param cancellationToken A token to cancel the operation.
    * @returns A task indicating when the operation is complete.
    */
    setTotalItemsAsync(job: IJobBase, total: number, cancellationToken?: AbortSignal): Promise<void>;
}