Table of Contents

Class ScheduledTaskConfigurationInfo

Namespace
CMS.Scheduler
Assembly
CMS.Scheduler.dll

TaskInfo data container class.

public class ScheduledTaskConfigurationInfo : AbstractInfo<ScheduledTaskConfigurationInfo, IInfoProvider<ScheduledTaskConfigurationInfo>>, IExtensible, IInfo, IAdvancedDataContainer, ICMSObject, IHierarchicalDataContainer, IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable, IMacroObject, IInfoWithId, IInfoWithGuid, IInfoWithName
Inheritance
object
ScheduledTaskConfigurationInfo
Implements
Inherited Members
Extension Methods

Constructors

ScheduledTaskConfigurationInfo()

Constructor - Creates an empty TaskInfo object.

public ScheduledTaskConfigurationInfo()

ScheduledTaskConfigurationInfo(DataRow)

Constructor - Creates a new TaskInfo object from the given DataRow.

public ScheduledTaskConfigurationInfo(DataRow dr)

Parameters

dr DataRow

Fields

OBJECT_TYPE

Object type

public const string OBJECT_TYPE = "cms.scheduledtaskconfiguration"

Field Value

string

OBJECT_TYPE_OBJECTTASK

Object type for object tasks

public const string OBJECT_TYPE_OBJECTTASK = "cms.objectscheduledtask"

Field Value

string

TYPEINFO

Type information.

public static ObjectTypeInfo TYPEINFO

Field Value

ObjectTypeInfo

TYPEINFO_OBJECT

Type information for object scheduled tasks.

public static ObjectTypeInfo TYPEINFO_OBJECT

Field Value

ObjectTypeInfo

Properties

ScheduledTaskConfigurationCreatedDynamically

Indicates whether the task configuration was created dynamically.

[DatabaseField]
public virtual bool ScheduledTaskConfigurationCreatedDynamically { get; set; }

Property Value

bool

ScheduledTaskConfigurationData

Task data.

[DatabaseField]
public virtual string ScheduledTaskConfigurationData { get; set; }

Property Value

string

ScheduledTaskConfigurationDeleteAfterLastRun

If true, the task is deleted after successful execution.

[DatabaseField]
public virtual bool ScheduledTaskConfigurationDeleteAfterLastRun { get; set; }

Property Value

bool

ScheduledTaskConfigurationDisplayName

Display name.

[DatabaseField]
public virtual string ScheduledTaskConfigurationDisplayName { get; set; }

Property Value

string

ScheduledTaskConfigurationEnabled

Indicates whether task is enabled.

[DatabaseField]
public virtual bool ScheduledTaskConfigurationEnabled { get; set; }

Property Value

bool

Remarks

Disabled tasks will not be executed automatically. However they can still be executed manually.

ScheduledTaskConfigurationExecutingServerName

Name of the server executing the task right now (may be empty for single-server scenarios)

[DatabaseField]
public string ScheduledTaskConfigurationExecutingServerName { get; set; }

Property Value

string

ScheduledTaskConfigurationExecutions

Number of task executions.

[DatabaseField]
public virtual int ScheduledTaskConfigurationExecutions { get; set; }

Property Value

int

ScheduledTaskConfigurationGUID

Task GUID.

[DatabaseField]
public virtual Guid ScheduledTaskConfigurationGUID { get; set; }

Property Value

Guid

ScheduledTaskConfigurationID

Task ID.

[DatabaseField]
public virtual int ScheduledTaskConfigurationID { get; set; }

Property Value

int

ScheduledTaskConfigurationInterval

Interval between execution of task.

[DatabaseField]
public virtual string ScheduledTaskConfigurationInterval { get; set; }

Property Value

string

ScheduledTaskConfigurationIsCancellationRequested

Indicates whether cancellation has been requested for the task.

[DatabaseField]
public virtual bool ScheduledTaskConfigurationIsCancellationRequested { get; set; }

Property Value

bool

ScheduledTaskConfigurationIsRunning

Indicates whether task is running.

[DatabaseField]
public virtual bool ScheduledTaskConfigurationIsRunning { get; set; }

Property Value

bool

ScheduledTaskConfigurationLastModified

Object last modified.

[DatabaseField]
public virtual DateTime ScheduledTaskConfigurationLastModified { get; set; }

Property Value

DateTime

ScheduledTaskConfigurationLastResult

Task last result.

[DatabaseField]
public virtual string ScheduledTaskConfigurationLastResult { get; set; }

Property Value

string

ScheduledTaskConfigurationLastRunTime

Time of last run.

[DatabaseField]
public virtual DateTime ScheduledTaskConfigurationLastRunTime { get; set; }

Property Value

DateTime

ScheduledTaskConfigurationName

Task name.

[DatabaseField]
public virtual string ScheduledTaskConfigurationName { get; set; }

Property Value

string

ScheduledTaskConfigurationNextRunTime

Time of next run.

[DatabaseField]
public virtual DateTime ScheduledTaskConfigurationNextRunTime { get; set; }

Property Value

DateTime

ScheduledTaskConfigurationObjectID

ID of object associated to this task.

[DatabaseField]
public virtual int ScheduledTaskConfigurationObjectID { get; set; }

Property Value

int

ScheduledTaskConfigurationObjectType

Type of object associated to this task.

[DatabaseField]
public virtual string ScheduledTaskConfigurationObjectType { get; set; }

Property Value

string

ScheduledTaskConfigurationScheduledTaskIdentifier

Identifier of the registered task.

[DatabaseField]
public string ScheduledTaskConfigurationScheduledTaskIdentifier { get; set; }

Property Value

string

ScheduledTaskConfigurationUserID

Task user ID to specify the user context for the task execution.

[DatabaseField]
public virtual int ScheduledTaskConfigurationUserID { get; set; }

Property Value

int

TypeInfo

Object type information.

public override ObjectTypeInfo TypeInfo { get; }

Property Value

ObjectTypeInfo

Methods

DeleteObject()

Deletes the object using appropriate provider.

protected override void DeleteObject()

LoadDefaultData()

Loads the default data to the object.

protected override void LoadDefaultData()

SetObject()

Updates the object using appropriate provider.

protected override void SetObject()