Class ScheduleRow

Generic scheduled tasked handling time scheduling, locking and error messages
Row Object for table 'schedule'. Row objects correspond directly to database tables, and one instance of a row object represents one row in the corresponding table in the database.

Inheritance
Object
SqlCommand
PrivateSave
TableRowBase
ScheduleRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ScheduleRow : TableRowBase, INestedPersist, ISoDataLookup, ISentryIgnorable, ISoItem
Remarks

Row objects can be created in several ways.

  • Use the static CreateNew() method to create a new, empty object. After populating it with values, you call the method and a corresponding row in the database is created, and the objects' primary key field updated. This is the preferred way to insert new rows into the database.
  • You can create a (nested) ScheduleRow ScheduleRow.CustomSearch object to obtain a query pre-populated with the correct tableinfo and return fields. This query can be modified with restrictions, etc. Then, use the static GetFromCustomSearch(ScheduleRow.CustomSearch) method to apply the query to the database and obtain the result as a Row object. This is how you select existing rows from the database when you have a query that does not correspond to any of the existing database indexes.
  • For each unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy. Note that if you try to fetch a row that does not exist (for instance, by using the primary key index and specifying a primary key that does not exist in the database), you will get a Row object with the and properties set to true. Such a Row object is called a 'ghost' and cannot be updated, saved or deleted. You can also get a ghost if the row does exist in the database, but the Sentry system denies Select rights to the row.
  • Finally, if you have an SoDataReader that contains ALL the fields of the table, and you have the ScheduleTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ScheduleTableInfo) method to create a new row object from the reader and the table info. This is useful when you have a larger, more complex query, for instance one that joins a number of tables, and you wish to use Row objects to process the result set. If your result set corresponds to an entity, consider using the corresponding Entity layer object instead, since entities automatically handle ID allocation and mapping, rights, and other higher-level aspects.
Non-unique indexes are handled through the ScheduleRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, ScheduleTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table Schedule are:

Index fieldsNested index class name

Constructors

ScheduleRow(ScheduleRow.ScheduleRowIdxBase)

Constructor for the class taking an index as argument. Generic scheduled tasked handling time scheduling, locking and error messages

Declaration
protected ScheduleRow(ScheduleRow.ScheduleRowIdxBase idx)
Parameters
Type Name Description
ScheduleRow.ScheduleRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAfterScheduleId

Current value, see property AfterScheduleId.

Declaration
protected int _currentAfterScheduleId
Field Value
Type Description
Int32

_currentAsap

Current value, see property Asap.

Declaration
protected short _currentAsap
Field Value
Type Description
Int16

_currentDayOfMonth

Current value, see property DayOfMonth.

Declaration
protected int _currentDayOfMonth
Field Value
Type Description
Int32

_currentDisabled

Current value, see property Disabled.

Declaration
protected short _currentDisabled
Field Value
Type Description
Int16

_currentDomain

Current value, see property Domain.

Declaration
protected short _currentDomain
Field Value
Type Description
Int16

_currentErrorMessage

Current value, see property ErrorMessage.

Declaration
protected string _currentErrorMessage
Field Value
Type Description
String

_currentExecutionTime

Current value, see property ExecutionTime.

Declaration
protected int _currentExecutionTime
Field Value
Type Description
Int32

_currentFrequency

Current value, see property Frequency.

Declaration
protected short _currentFrequency
Field Value
Type Description
Int16

_currentLastError

Current value, see property LastError.

Declaration
protected DateTime _currentLastError
Field Value
Type Description
DateTime

_currentLastExecution

Current value, see property LastExecution.

Declaration
protected DateTime _currentLastExecution
Field Value
Type Description
DateTime

_currentLockExpire

Current value, see property LockExpire.

Declaration
protected DateTime _currentLockExpire
Field Value
Type Description
DateTime

_currentLockPid

Current value, see property LockPid.

Declaration
protected int _currentLockPid
Field Value
Type Description
Int32

_currentLockTtl

Current value, see property LockTtl.

Declaration
protected int _currentLockTtl
Field Value
Type Description
Int32

_currentMinOfHour

Current value, see property MinOfHour.

Declaration
protected int _currentMinOfHour
Field Value
Type Description
Int32

_currentMinuteInterval

Current value, see property MinuteInterval.

Declaration
protected int _currentMinuteInterval
Field Value
Type Description
Int32

_currentMonths

Current value, see property Months.

Declaration
protected int _currentMonths
Field Value
Type Description
Int32

_currentName

Current value, see property Name.

Declaration
protected string _currentName
Field Value
Type Description
String

_currentNextExecution

Current value, see property NextExecution.

Declaration
protected DateTime _currentNextExecution
Field Value
Type Description
DateTime

_currentOnceAt

Current value, see property OnceAt.

Declaration
protected DateTime _currentOnceAt
Field Value
Type Description
DateTime

_currentRetries

Current value, see property Retries.

Declaration
protected int _currentRetries
Field Value
Type Description
Int32

_currentRetryInterval

Current value, see property RetryInterval.

Declaration
protected int _currentRetryInterval
Field Value
Type Description
Int32

_currentScheduleId

Current value, see property ScheduleId.

Declaration
protected int _currentScheduleId
Field Value
Type Description
Int32

_currentStatus

Current value, see property Status.

Declaration
protected short _currentStatus
Field Value
Type Description
Int16

_currentStop

Current value, see property Stop.

Declaration
protected short _currentStop
Field Value
Type Description
Int16

_currentTimeOfDay

Current value, see property TimeOfDay.

Declaration
protected DateTime _currentTimeOfDay
Field Value
Type Description
DateTime

_currentWeekdays

Current value, see property Weekdays.

Declaration
protected int _currentWeekdays
Field Value
Type Description
Int32

_persistedAfterScheduleId

Persisted value, see property AfterScheduleId.

Declaration
protected int _persistedAfterScheduleId
Field Value
Type Description
Int32

_persistedAsap

Persisted value, see property Asap.

Declaration
protected short _persistedAsap
Field Value
Type Description
Int16

_persistedDayOfMonth

Persisted value, see property DayOfMonth.

Declaration
protected int _persistedDayOfMonth
Field Value
Type Description
Int32

_persistedDisabled

Persisted value, see property Disabled.

Declaration
protected short _persistedDisabled
Field Value
Type Description
Int16

_persistedDomain

Persisted value, see property Domain.

Declaration
protected short _persistedDomain
Field Value
Type Description
Int16

_persistedErrorMessage

Persisted value, see property ErrorMessage.

Declaration
protected string _persistedErrorMessage
Field Value
Type Description
String

_persistedExecutionTime

Persisted value, see property ExecutionTime.

Declaration
protected int _persistedExecutionTime
Field Value
Type Description
Int32

_persistedFrequency

Persisted value, see property Frequency.

Declaration
protected short _persistedFrequency
Field Value
Type Description
Int16

_persistedLastError

Persisted value, see property LastError.

Declaration
protected DateTime _persistedLastError
Field Value
Type Description
DateTime

_persistedLastExecution

Persisted value, see property LastExecution.

Declaration
protected DateTime _persistedLastExecution
Field Value
Type Description
DateTime

_persistedLockExpire

Persisted value, see property LockExpire.

Declaration
protected DateTime _persistedLockExpire
Field Value
Type Description
DateTime

_persistedLockPid

Persisted value, see property LockPid.

Declaration
protected int _persistedLockPid
Field Value
Type Description
Int32

_persistedLockTtl

Persisted value, see property LockTtl.

Declaration
protected int _persistedLockTtl
Field Value
Type Description
Int32

_persistedMinOfHour

Persisted value, see property MinOfHour.

Declaration
protected int _persistedMinOfHour
Field Value
Type Description
Int32

_persistedMinuteInterval

Persisted value, see property MinuteInterval.

Declaration
protected int _persistedMinuteInterval
Field Value
Type Description
Int32

_persistedMonths

Persisted value, see property Months.

Declaration
protected int _persistedMonths
Field Value
Type Description
Int32

_persistedName

Persisted value, see property Name.

Declaration
protected string _persistedName
Field Value
Type Description
String

_persistedNextExecution

Persisted value, see property NextExecution.

Declaration
protected DateTime _persistedNextExecution
Field Value
Type Description
DateTime

_persistedOnceAt

Persisted value, see property OnceAt.

Declaration
protected DateTime _persistedOnceAt
Field Value
Type Description
DateTime

_persistedRetries

Persisted value, see property Retries.

Declaration
protected int _persistedRetries
Field Value
Type Description
Int32

_persistedRetryInterval

Persisted value, see property RetryInterval.

Declaration
protected int _persistedRetryInterval
Field Value
Type Description
Int32

_persistedScheduleId

Persisted value, see property ScheduleId.

Declaration
protected int _persistedScheduleId
Field Value
Type Description
Int32

_persistedStatus

Persisted value, see property Status.

Declaration
protected short _persistedStatus
Field Value
Type Description
Int16

_persistedStop

Persisted value, see property Stop.

Declaration
protected short _persistedStop
Field Value
Type Description
Int16

_persistedTimeOfDay

Persisted value, see property TimeOfDay.

Declaration
protected DateTime _persistedTimeOfDay
Field Value
Type Description
DateTime

_persistedWeekdays

Persisted value, see property Weekdays.

Declaration
protected int _persistedWeekdays
Field Value
Type Description
Int32

Properties

AfterScheduleId

.NET type: int. Run after another schedule have completed

Declaration
public virtual int AfterScheduleId { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: FK.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Asap

.NET type: short. Run schedule ASAP

Declaration
public virtual short Asap { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Bool.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

DayOfMonth

.NET type: int. What day of month to run

Declaration
public virtual int DayOfMonth { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Disabled

.NET type: short. Disable the schedule

Declaration
public virtual short Disabled { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Bool.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Domain

.NET type: short. Type of scheduled task

Declaration
public virtual short Domain { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Enum.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ErrorMessage

.NET type: string. Last error message

Declaration
public virtual string ErrorMessage { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: Clob.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ExecutionTime

.NET type: int. Amount of time in seconds used by last execution

Declaration
public virtual int ExecutionTime { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Frequency

.NET type: short. Type of schedule algorithm to use

Declaration
public virtual short Frequency { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Enum.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

InnerFieldValuePairs

The values of all the fields in the row.
The first field is the primary key.
The index of the value corresponds to the name of the field returned from the Fields property.

Declaration
protected override ArgumentParameterCollection InnerFieldValuePairs { get; }
Property Value
Type Description
ArgumentParameterCollection
Overrides

InnerPrimaryKey

The primary key needed to decide which specific row to alter with the current sql-command.

Declaration
protected override FieldInfo InnerPrimaryKey { get; }
Property Value
Type Description
FieldInfo
Overrides

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration
protected override Parameter InnerPrimaryKeyValue { get; }
Property Value
Type Description
Parameter
Overrides

IsDirty

Is the row dirty, e.g. been modified since the last time it was saved to the database.

Declaration
public override bool IsDirty { get; }
Property Value
Type Description
Boolean
Overrides

IsNew

Is this object new, meaning that it does not exist in the database.

Declaration
public override bool IsNew { get; }
Property Value
Type Description
Boolean
Overrides

Item[String]

Get or set a value based on the name of the field.

Declaration
public override object this[string fieldName] { get; set; }
Parameters
Type Name Description
String fieldName

Name of the field in the database
Property Value
Type Description
Object

Value of the field.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

LastError

.NET type: DateTime. Time of last error

Declaration
public virtual DateTime LastError { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: DateTime.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

LastExecution

.NET type: DateTime. Last execution

Declaration
public virtual DateTime LastExecution { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: DateTime.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

LockExpire

.NET type: DateTime. Lock preventing the same schedule to run simultaniously

Declaration
public virtual DateTime LockExpire { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: DateTime.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

LockPid

.NET type: int. PID preventing the same schedule to run simultaniously

Declaration
public virtual int LockPid { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

LockTtl

.NET type: int. Lock time to live

Declaration
public virtual int LockTtl { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

MinOfHour

.NET type: int. Run at a given minute in an hour

Declaration
public virtual int MinOfHour { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

MinuteInterval

.NET type: int. Interval in minutes, used by Minutely

Declaration
public virtual int MinuteInterval { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Months

.NET type: int. Bitfield: which months of the year to run

Declaration
public virtual int Months { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Name

.NET type: string. Name of the schedule

Declaration
public virtual string Name { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[256].

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

NextExecution

.NET type: DateTime. Next execution

Declaration
public virtual DateTime NextExecution { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: DateTime.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

OnceAt

.NET type: DateTime. Execute once at

Declaration
public virtual DateTime OnceAt { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: DateTime.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Retries

.NET type: int. Number of retries since last successfull execution

Declaration
public virtual int Retries { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

RetryInterval

.NET type: int. Number of minutes between each retry

Declaration
public virtual int RetryInterval { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ScheduleId

.NET type: int. Primary key

Declaration
public virtual int ScheduleId { get; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: PK.

This field is the primary key and can only be read, never written.

This field is not protected by the Sentry system, and can always be read

ScheduleTableInfo

Get the ScheduleTableInfo object associated with the row.

Declaration
public ScheduleTableInfo ScheduleTableInfo { get; }
Property Value
Type Description
ScheduleTableInfo

Status

.NET type: short. Schedules current status

Declaration
public virtual short Status { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Enum.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Stop

.NET type: short. Signal to stop schedule

Declaration
public virtual short Stop { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: Bool.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

TableInfo

Get the TableInfo for the table.

Declaration
public override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo

The TableInfo for the table.
Overrides

TimeOfDay

.NET type: DateTime. Time of day to execute if not specified.

Declaration
public virtual DateTime TimeOfDay { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: DateTime.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Weekdays

.NET type: int. Bitfield: which days of the week to run

Declaration
public virtual int Weekdays { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Int.

Setting this field to a new value will not affect the Sentry calculations and your rights

This field is not protected by the Sentry system, and can always be read

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Methods

CreateNew()

Create a new instance of the ScheduleRow object. Generic scheduled tasked handling time scheduling, locking and error messages

Declaration
public static ScheduleRow CreateNew()
Returns
Type Description
ScheduleRow

A new instance of the ScheduleRow object.

GetFromCustomSearch(ScheduleRow.CustomSearch)

Create a new instance of the ScheduleRow object, and populate it with data from a custom search. If the search returns no results, an object with IsNew will be returned; if the result contains one row, an object representing that row will be returned. If the result contains more than one row, the first row will be used and the rest discarded (there is no way of detecting this situation).

Declaration
public static ScheduleRow GetFromCustomSearch(ScheduleRow.CustomSearch query)
Parameters
Type Name Description
ScheduleRow.CustomSearch query

The custom search to execute against the database
Returns
Type Description
ScheduleRow

A new instance of the ScheduleRow object, reflecting the result of the query.

GetFromIdxScheduleId(Int32)

Create a new instance of the ScheduleRow object, by querying the database table via the index 'IDXScheduleId'. This method is intended to make it easy to use efficient queries that match a database index.

Declaration
public static ScheduleRow GetFromIdxScheduleId(int scheduleId)
Parameters
Type Name Description
Int32 scheduleId
Returns
Type Description
ScheduleRow

Row object that represents the result of the search. IsNew will be true if the query did not match any row in the table
Remarks

This method represents one of the unique indexes on the Schedule table. Non-unique indexes have corresponding inner classes and methods in the ScheduleRows collection, since they may return more than one row.

GetFromReader(SoDataReader, ScheduleTableInfo)

Create a new instance of the ScheduleRow object, and populate it with data from a reader/tableinfo. If the reader has DBNull as the current value of the primary key field, an unpopulated object with IsNew == true will be returned. If any fields are missing or one of the non-primary key fields is DBNull, an exception will be thrown. Generic scheduled tasked handling time scheduling, locking and error messages

Declaration
public static ScheduleRow GetFromReader(SoDataReader reader, ScheduleTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
ScheduleTableInfo tableInfo

ScheduleTableInfo instance used in the query that is the source of the reader. The fields used from the reader will be those owned by this tableinfo object.
Returns
Type Description
ScheduleRow

A new instance of the ScheduleRow object.

GetPersistedFieldValue(FieldInfo)

Get the persisted value of a field.

Declaration
public override object GetPersistedFieldValue(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field
Returns
Type Description
Object

Field value, such as an int, DateTime, string ... Null can be returned if the value is not known.
Overrides
Exceptions
Type Condition
ArgumentException

Thrown if the field is not known.

InternalSetValue(String, Object)

Declaration
protected override void InternalSetValue(string fieldName, object value)
Parameters
Type Name Description
String fieldName
Object value
Overrides

IsPersistedFieldValueKnown(FieldInfo)

Check if the persisted value for a field is known.

Declaration
public override bool IsPersistedFieldValueKnown(FieldInfo field)
Parameters
Type Name Description
FieldInfo field

Specification of a field
Returns
Type Description
Boolean

True if the value is known and sentry permits read.
Overrides

OnLoad(SoDataReader, TableInfo)

Fill the object with data returned from the database.

Declaration
protected override void OnLoad(SoDataReader reader, TableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

Object holding the data returned from the database.
TableInfo tableInfo

The TableInfo used for the SELECT statement.
Overrides

OnSave(BatchSave)

Add the object to the BatchSave list if it needs saving.

Declaration
protected override void OnSave(BatchSave batchSave)
Parameters
Type Name Description
BatchSave batchSave

Collection of objects to be saved within the transaction.
Overrides
Remarks

Classes overriding this method should call it.

OnSaved(Boolean)

Method called after the save operation has been performed.

Declaration
protected override void OnSaved(bool bSucceeded)
Parameters
Type Name Description
Boolean bSucceeded

True if the save operation succeeded (e.g. transaction committed), or false if the save operation failed (e.g. transaction rolled back)
Overrides

Reset()

Reset the changes made on the object.

Declaration
protected override void Reset()
Overrides
Remarks

If the row is not persisted to the database (e.g. IsNew is true), all the values will be reset. If the row has been persisted to or loaded from the database, the properties will be set to those of the last persisted or loaded values.

SetDefaults(DefaulterStrategy)

Set default values for the row.

Declaration
public override void SetDefaults(DefaulterStrategy strategy)
Parameters
Type Name Description
DefaulterStrategy strategy

Strategy used when applying default values; values depend on where we are in the Create/Fetch/Populate/Save cycle
Overrides

SetPrimaryKey(Int32)

Set the primary key for the row.

Declaration
protected override void SetPrimaryKey(int primaryKey)
Parameters
Type Name Description
Int32 primaryKey

The new primary key for the row.
Overrides

SetRowAsNew()

Declaration
public override void SetRowAsNew()
Overrides

ToString()

ToString method intended for debugging, returns a string that displays the object type, new/dirty status, primary key and the string fields

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Validate(RowValidator)

Validate this row.

Declaration
public override void Validate(RowValidator rowValidator)
Parameters
Type Name Description
RowValidator rowValidator

RowValidator for inserting the result of the validation
Overrides

Events

_onAfterScheduleIdChange

Change envent for property AfterScheduleId; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onAfterScheduleIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onAsapChange

Change envent for property Asap; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onAsapChange
Event Type
Type Description
OnFieldChange<Int16>

_onDayOfMonthChange

Change envent for property DayOfMonth; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onDayOfMonthChange
Event Type
Type Description
OnFieldChange<Int32>

_onDisabledChange

Change envent for property Disabled; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onDisabledChange
Event Type
Type Description
OnFieldChange<Int16>

_onDomainChange

Change envent for property Domain; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onDomainChange
Event Type
Type Description
OnFieldChange<Int16>

_onErrorMessageChange

Change envent for property ErrorMessage; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onErrorMessageChange
Event Type
Type Description
OnFieldChange<String>

_onExecutionTimeChange

Change envent for property ExecutionTime; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onExecutionTimeChange
Event Type
Type Description
OnFieldChange<Int32>

_onFrequencyChange

Change envent for property Frequency; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onFrequencyChange
Event Type
Type Description
OnFieldChange<Int16>

_onLastErrorChange

Change envent for property LastError; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onLastErrorChange
Event Type
Type Description
OnFieldChange<DateTime>

_onLastExecutionChange

Change envent for property LastExecution; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onLastExecutionChange
Event Type
Type Description
OnFieldChange<DateTime>

_onLockExpireChange

Change envent for property LockExpire; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onLockExpireChange
Event Type
Type Description
OnFieldChange<DateTime>

_onLockPidChange

Change envent for property LockPid; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onLockPidChange
Event Type
Type Description
OnFieldChange<Int32>

_onLockTtlChange

Change envent for property LockTtl; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onLockTtlChange
Event Type
Type Description
OnFieldChange<Int32>

_onMinOfHourChange

Change envent for property MinOfHour; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onMinOfHourChange
Event Type
Type Description
OnFieldChange<Int32>

_onMinuteIntervalChange

Change envent for property MinuteInterval; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onMinuteIntervalChange
Event Type
Type Description
OnFieldChange<Int32>

_onMonthsChange

Change envent for property Months; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onMonthsChange
Event Type
Type Description
OnFieldChange<Int32>

_onNameChange

Change envent for property Name; field is of .NET type string.

Declaration
protected event OnFieldChange<string> _onNameChange
Event Type
Type Description
OnFieldChange<String>

_onNextExecutionChange

Change envent for property NextExecution; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onNextExecutionChange
Event Type
Type Description
OnFieldChange<DateTime>

_onOnceAtChange

Change envent for property OnceAt; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onOnceAtChange
Event Type
Type Description
OnFieldChange<DateTime>

_onRetriesChange

Change envent for property Retries; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onRetriesChange
Event Type
Type Description
OnFieldChange<Int32>

_onRetryIntervalChange

Change envent for property RetryInterval; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onRetryIntervalChange
Event Type
Type Description
OnFieldChange<Int32>

_onStatusChange

Change envent for property Status; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onStatusChange
Event Type
Type Description
OnFieldChange<Int16>

_onStopChange

Change envent for property Stop; field is of .NET type short.

Declaration
protected event OnFieldChange<short> _onStopChange
Event Type
Type Description
OnFieldChange<Int16>

_onTimeOfDayChange

Change envent for property TimeOfDay; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onTimeOfDayChange
Event Type
Type Description
OnFieldChange<DateTime>

_onWeekdaysChange

Change envent for property Weekdays; field is of .NET type int.

Declaration
protected event OnFieldChange<int> _onWeekdaysChange
Event Type
Type Description
OnFieldChange<Int32>

OnAfterScheduleIdChange

Event raised when AfterScheduleId is changing.

Declaration
public event OnFieldChange<int> OnAfterScheduleIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnAsapChange

Event raised when Asap is changing.

Declaration
public event OnFieldChange<short> OnAsapChange
Event Type
Type Description
OnFieldChange<Int16>

OnDayOfMonthChange

Event raised when DayOfMonth is changing.

Declaration
public event OnFieldChange<int> OnDayOfMonthChange
Event Type
Type Description
OnFieldChange<Int32>

OnDisabledChange

Event raised when Disabled is changing.

Declaration
public event OnFieldChange<short> OnDisabledChange
Event Type
Type Description
OnFieldChange<Int16>

OnDomainChange

Event raised when Domain is changing.

Declaration
public event OnFieldChange<short> OnDomainChange
Event Type
Type Description
OnFieldChange<Int16>

OnErrorMessageChange

Event raised when ErrorMessage is changing.

Declaration
public event OnFieldChange<string> OnErrorMessageChange
Event Type
Type Description
OnFieldChange<String>

OnExecutionTimeChange

Event raised when ExecutionTime is changing.

Declaration
public event OnFieldChange<int> OnExecutionTimeChange
Event Type
Type Description
OnFieldChange<Int32>

OnFrequencyChange

Event raised when Frequency is changing.

Declaration
public event OnFieldChange<short> OnFrequencyChange
Event Type
Type Description
OnFieldChange<Int16>

OnLastErrorChange

Event raised when LastError is changing.

Declaration
public event OnFieldChange<DateTime> OnLastErrorChange
Event Type
Type Description
OnFieldChange<DateTime>

OnLastExecutionChange

Event raised when LastExecution is changing.

Declaration
public event OnFieldChange<DateTime> OnLastExecutionChange
Event Type
Type Description
OnFieldChange<DateTime>

OnLockExpireChange

Event raised when LockExpire is changing.

Declaration
public event OnFieldChange<DateTime> OnLockExpireChange
Event Type
Type Description
OnFieldChange<DateTime>

OnLockPidChange

Event raised when LockPid is changing.

Declaration
public event OnFieldChange<int> OnLockPidChange
Event Type
Type Description
OnFieldChange<Int32>

OnLockTtlChange

Event raised when LockTtl is changing.

Declaration
public event OnFieldChange<int> OnLockTtlChange
Event Type
Type Description
OnFieldChange<Int32>

OnMinOfHourChange

Event raised when MinOfHour is changing.

Declaration
public event OnFieldChange<int> OnMinOfHourChange
Event Type
Type Description
OnFieldChange<Int32>

OnMinuteIntervalChange

Event raised when MinuteInterval is changing.

Declaration
public event OnFieldChange<int> OnMinuteIntervalChange
Event Type
Type Description
OnFieldChange<Int32>

OnMonthsChange

Event raised when Months is changing.

Declaration
public event OnFieldChange<int> OnMonthsChange
Event Type
Type Description
OnFieldChange<Int32>

OnNameChange

Event raised when Name is changing.

Declaration
public event OnFieldChange<string> OnNameChange
Event Type
Type Description
OnFieldChange<String>

OnNextExecutionChange

Event raised when NextExecution is changing.

Declaration
public event OnFieldChange<DateTime> OnNextExecutionChange
Event Type
Type Description
OnFieldChange<DateTime>

OnOnceAtChange

Event raised when OnceAt is changing.

Declaration
public event OnFieldChange<DateTime> OnOnceAtChange
Event Type
Type Description
OnFieldChange<DateTime>

OnRetriesChange

Event raised when Retries is changing.

Declaration
public event OnFieldChange<int> OnRetriesChange
Event Type
Type Description
OnFieldChange<Int32>

OnRetryIntervalChange

Event raised when RetryInterval is changing.

Declaration
public event OnFieldChange<int> OnRetryIntervalChange
Event Type
Type Description
OnFieldChange<Int32>

OnStatusChange

Event raised when Status is changing.

Declaration
public event OnFieldChange<short> OnStatusChange
Event Type
Type Description
OnFieldChange<Int16>

OnStopChange

Event raised when Stop is changing.

Declaration
public event OnFieldChange<short> OnStopChange
Event Type
Type Description
OnFieldChange<Int16>

OnTimeOfDayChange

Event raised when TimeOfDay is changing.

Declaration
public event OnFieldChange<DateTime> OnTimeOfDayChange
Event Type
Type Description
OnFieldChange<DateTime>

OnWeekdaysChange

Event raised when Weekdays is changing.

Declaration
public event OnFieldChange<int> OnWeekdaysChange
Event Type
Type Description
OnFieldChange<Int32>

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)