Interface IBatchJob

Represents a batch job.

Syntax
public interface IBatchJob

Properties

End

Gets or sets the end date.

Declaration
[ApiField("END_DATE")]
DateTimeOffset? End { get; set; }

EventName

Gets or sets the event name.

Declaration
[ApiField("EVENT_NAME")]
string? EventName { get; set; }
Property Value
Type Description
string

EventValue

Gets or sets the event value.

Declaration
[ApiField("EVENT_VALUE")]
string? EventValue { get; set; }
Property Value
Type Description
string

HandlerCode

Gets or sets the handler code.

Declaration
[ApiField("HANDLER")]
string? HandlerCode { get; set; }
Property Value
Type Description
string

Id

Gets or sets the id.

Declaration
[ApiField("ID")]
int? Id { get; set; }
Property Value
Type Description
int?

IsActive

Gets or sets whether the batch job is active.

Declaration
[ApiField("ACTIVE")]
bool IsActive { get; set; }
Property Value
Type Description
bool

IsPeriodic

Gets or sets whether the batch job is periodic.

Declaration
[ApiField("PERIODIC")]
bool IsPeriodic { get; set; }
Property Value
Type Description
bool

LastRun

Gets the last run date.

Declaration
[ApiField("LASTRUN_DATE")]
DateTimeOffset? LastRun { get; }

Name

Gets or sets the name.

Declaration
[ApiField("NAME")]
string? Name { get; set; }
Property Value
Type Description
string

Parameters

Gets the parameters.

Declaration
IList<IBatchJobParameter> Parameters { get; }

PeriodicType

Gets or sets the periodic type.

Declaration
[ApiField("PERIODIC_TYPE")]
BatchJobPeriodicType PeriodicType { get; set; }

PeriodicValue

Gets or sets the periodic value.

Declaration
[ApiField("PERIODIC_VALUE")]
int? PeriodicValue { get; set; }
Property Value
Type Description
int?

Start

Gets or sets the start date.

Declaration
[ApiField("START_DATE")]
DateTimeOffset? Start { get; set; }

Type

Gets or sets the type.

Declaration
[ApiField("TYPE")]
BatchJobType Type { get; set; }

UserId

Gets or sets the username.

Declaration
[ApiField("USER")]
string? UserId { get; set; }
Property Value
Type Description
string

Extension Methods