Class ScheduleItem

Represents one item in the scheduler.

Inheritance
System.Object
BaseEntityInfo
ScheduleItem
ScheduleHistoryItem
Implements
Inherited Members
Namespace: DotNetNuke.Services.Scheduling
Assembly: DotNetNuke.dll
Syntax
public class ScheduleItem : BaseEntityInfo, IHydratable

Constructors

| Improve this Doc View Source

ScheduleItem()

Initializes a new instance of the ScheduleItem class.

Declaration
public ScheduleItem()

Properties

| Improve this Doc View Source

AttachToEvent

Gets or sets the the event this item attaches to.

Declaration
public string AttachToEvent { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

CatchUpEnabled

Gets or sets a value indicating whether cath-up is enabled.

Declaration
public bool CatchUpEnabled { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

Enabled

Gets or sets a value indicating whether the item is enabled.

Declaration
public bool Enabled { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

FriendlyName

Gets or sets the friednly name for the item.

Declaration
public string FriendlyName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

KeyID

Represents one item in the scheduler.

Declaration
public int KeyID { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

NextStart

Gets or sets the next start date.

Declaration
public virtual DateTime NextStart { get; set; }
Property Value
Type Description
DateTime
| Improve this Doc View Source

ObjectDependencies

Gets or sets the object dependencies.

Declaration
public string ObjectDependencies { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ProcessGroup

Gets or sets the process group.

Declaration
public int ProcessGroup { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RetainHistoryNum

Gets or sets a value indicating how many history items to keep.

Declaration
public int RetainHistoryNum { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RetryTimeLapse

Gets or sets the retry time lapse value.

Declaration
public int RetryTimeLapse { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

RetryTimeLapseMeasurement

Gets or sets the unit of measure for the retry time lapse value.

Declaration
public string RetryTimeLapseMeasurement { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ScheduleID

Gets or sets the ID of the scheduled item.

Declaration
public int ScheduleID { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

ScheduleSource

Gets or sets the ScheduleSource.

Declaration
public ScheduleSource ScheduleSource { get; set; }
Property Value
Type Description
ScheduleSource
| Improve this Doc View Source

ScheduleStartDate

Gets or sets the schedule start date.

Declaration
public DateTime ScheduleStartDate { get; set; }
Property Value
Type Description
DateTime
| Improve this Doc View Source

Servers

Gets or sets the servers this task should run on.

Declaration
public string Servers { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

ThreadID

Gets or sets the ID of the running thread.

Declaration
public int ThreadID { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TimeLapse

Gets or sets the recurrence time lapse value.

Declaration
public int TimeLapse { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

TimeLapseMeasurement

Gets or sets the unit of measure for the recurrence time lapse value.

Declaration
public string TimeLapseMeasurement { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

TypeFullName

Gets or sets the full type name.

Declaration
public string TypeFullName { get; set; }
Property Value
Type Description
System.String

Methods

| Improve this Doc View Source

AddSetting(String, String)

Adds a schedule item setting value.

Declaration
public void AddSetting(string key, string value)
Parameters
Type Name Description
System.String key

The setting key.
System.String value

The value of the setting.
| Improve this Doc View Source

Fill(IDataReader)

Represents one item in the scheduler.

Declaration
public virtual void Fill(IDataReader dr)
Parameters
Type Name Description
IDataReader dr
| Improve this Doc View Source

FillInternal(IDataReader)

Fills a BaseEntityInfo from a Data Reader.

Declaration
protected override void FillInternal(IDataReader dr)
Parameters
Type Name Description
IDataReader dr

The Data Reader to use.
Overrides
| Improve this Doc View Source

GetSetting(String)

Gets a specific setting.

Declaration
public virtual string GetSetting(string key)
Parameters
Type Name Description
System.String key

The key of the setting to get.
Returns
Type Description
System.String

The value of the setting.
| Improve this Doc View Source

GetSettings()

Gets all the item settings.

Declaration
public virtual Hashtable GetSettings()
Returns
Type Description
Hashtable

An of all the settings.
| Improve this Doc View Source

HasObjectDependencies(String)

Gets or sets a value indicating whether the item has object dependencies.

Declaration
public bool HasObjectDependencies(string strObjectDependencies)
Parameters
Type Name Description
System.String strObjectDependencies

A string representing the name of the object dependencies.
Returns
Type Description
System.Boolean

A value indicating whether the item has object dependencies.

Implements

Extension Methods