More documentation - almost all Models done
https://github.com/oqtane/oqtane.framework/issues/1382 Should not contain any code changes, just docs
This commit is contained in:
@ -1,25 +1,88 @@
|
||||
using System;
|
||||
using System;
|
||||
|
||||
namespace Oqtane.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// Definition of a Job / Task which is run on the server.
|
||||
/// When Jobs run, they create a <see cref="JobLog"/>
|
||||
/// </summary>
|
||||
public class Job : IAuditable
|
||||
{
|
||||
/// <summary>
|
||||
/// Internal ID
|
||||
/// </summary>
|
||||
public int JobId { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Name for simple identification
|
||||
/// </summary>
|
||||
public string Name { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// What kind of Job this is
|
||||
/// </summary>
|
||||
public string JobType { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Unit used in how often the job should run - expects a character like `m` (minutes), `H` (hours) etc.
|
||||
/// </summary>
|
||||
public string Frequency { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// How often the Job should run - see also <see cref="Frequency"/>
|
||||
/// </summary>
|
||||
public int Interval { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// When the Job is to be run the first time. See also <see cref="EndDate"/>.
|
||||
/// </summary>
|
||||
public DateTime? StartDate { get; set; }
|
||||
|
||||
|
||||
/// <summary>
|
||||
/// When the job is to be run the last time. See also <see cref="StartDate"/>.
|
||||
/// </summary>
|
||||
public DateTime? EndDate { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Determines if the Job is activated / enabled.
|
||||
/// </summary>
|
||||
public bool IsEnabled { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// If the Job has ever started running
|
||||
/// </summary>
|
||||
public bool IsStarted { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// If the Job is executing right now.
|
||||
/// </summary>
|
||||
public bool IsExecuting { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// When the Job will run again next time.
|
||||
/// </summary>
|
||||
public DateTime? NextExecution { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Todo: todoc - unsure what this does
|
||||
/// </summary>
|
||||
public int RetentionHistory { get; set; }
|
||||
|
||||
#region IAuditable Properties
|
||||
|
||||
/// <inheritdoc/>
|
||||
public string CreatedBy { get; set; }
|
||||
|
||||
/// <inheritdoc/>
|
||||
public DateTime CreatedOn { get; set; }
|
||||
|
||||
/// <inheritdoc/>
|
||||
public string ModifiedBy { get; set; }
|
||||
|
||||
/// <inheritdoc/>
|
||||
public DateTime ModifiedOn { get; set; }
|
||||
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
|
Reference in New Issue
Block a user