Class RedLetterDayRow
Red letter days for calendar (holidays, birthday of king etc)
Row Object for table 'redletterday'. Row objects correspond directly to database tables, and one
instance of a row object represents one row in the corresponding table in the database.
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class RedLetterDayRow : 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) RedLetterDayRow RedLetterDayRow.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(RedLetterDayRow.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 RedLetterDayTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, RedLetterDayTableInfo) 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.
Unique indexes on table RedLetterDay are:
Index fields | Nested index class name |
---|
Constructors
RedLetterDayRow(RedLetterDayRow.RedLetterDayRowIdxBase)
Constructor for the class taking an index as argument. Red letter days for calendar (holidays, birthday of king etc)
Declaration
protected RedLetterDayRow(RedLetterDayRow.RedLetterDayRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
RedLetterDayRow.RedLetterDayRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentColor
Current value, see property Color.
Declaration
protected short _currentColor
Field Value
Type | Description |
---|---|
Int16 |
_currentColored
Current value, see property Colored.
Declaration
protected uint _currentColored
Field Value
Type | Description |
---|---|
UInt32 |
_currentCountryId
Current value, see property CountryId.
Declaration
protected int _currentCountryId
Field Value
Type | Description |
---|---|
Int32 |
_currentExtraFlags
Current value, see property ExtraFlags.
Declaration
protected uint _currentExtraFlags
Field Value
Type | Description |
---|---|
UInt32 |
_currentReddate
Current value, see property Reddate.
Declaration
protected DateTime _currentReddate
Field Value
Type | Description |
---|---|
DateTime |
_currentRedletterdayId
Current value, see property RedletterdayId.
Declaration
protected int _currentRedletterdayId
Field Value
Type | Description |
---|---|
Int32 |
_currentReds
Current value, see property Reds.
Declaration
protected uint _currentReds
Field Value
Type | Description |
---|---|
UInt32 |
_currentRgbColour
Current value, see property RgbColour.
Declaration
protected uint _currentRgbColour
Field Value
Type | Description |
---|---|
UInt32 |
_currentText
Current value, see property Text.
Declaration
protected string _currentText
Field Value
Type | Description |
---|---|
String |
_currentUpdatedCount
Current value, see property UpdatedCount.
Declaration
protected short _currentUpdatedCount
Field Value
Type | Description |
---|---|
Int16 |
_persistedColor
Persisted value, see property Color.
Declaration
protected short _persistedColor
Field Value
Type | Description |
---|---|
Int16 |
_persistedColored
Persisted value, see property Colored.
Declaration
protected uint _persistedColored
Field Value
Type | Description |
---|---|
UInt32 |
_persistedCountryId
Persisted value, see property CountryId.
Declaration
protected int _persistedCountryId
Field Value
Type | Description |
---|---|
Int32 |
_persistedExtraFlags
Persisted value, see property ExtraFlags.
Declaration
protected uint _persistedExtraFlags
Field Value
Type | Description |
---|---|
UInt32 |
_persistedReddate
Persisted value, see property Reddate.
Declaration
protected DateTime _persistedReddate
Field Value
Type | Description |
---|---|
DateTime |
_persistedRedletterdayId
Persisted value, see property RedletterdayId.
Declaration
protected int _persistedRedletterdayId
Field Value
Type | Description |
---|---|
Int32 |
_persistedReds
Persisted value, see property Reds.
Declaration
protected uint _persistedReds
Field Value
Type | Description |
---|---|
UInt32 |
_persistedRgbColour
Persisted value, see property RgbColour.
Declaration
protected uint _persistedRgbColour
Field Value
Type | Description |
---|---|
UInt32 |
_persistedText
Persisted value, see property Text.
Declaration
protected string _persistedText
Field Value
Type | Description |
---|---|
String |
_persistedUpdatedCount
Persisted value, see property UpdatedCount.
Declaration
protected short _persistedUpdatedCount
Field Value
Type | Description |
---|---|
Int16 |
Properties
Color
.NET type: short. color can be one of the following: RLD_COLOR_BLACK, RLD_COLOR_RED, RLD_COLOR_SPES
Declaration
public virtual short Color { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: UShort.
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
Colored
.NET type: uint. The n´th bit corresponding to the date in dates month, is true if the color is active.
Declaration
public virtual uint Colored { get; set; }
Property Value
Type | Description |
---|---|
UInt32 |
Remarks
Original type in dictionary: UInt.
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
CountryId
.NET type: int. Which country does this red letter day belong to. It will show up in the diary for associates with this country as homecountry.
Declaration
public virtual int CountryId { 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
ExtraFlags
.NET type: uint. Extra flags, spare field
Declaration
public virtual uint ExtraFlags { get; set; }
Property Value
Type | Description |
---|---|
UInt32 |
Remarks
Original type in dictionary: UInt.
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. |
Reddate
.NET type: DateTime. The date
Declaration
public virtual DateTime Reddate { 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
RedletterdayId
.NET type: int. Primary key
Declaration
public virtual int RedletterdayId { 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
RedLetterDayTableInfo
Get the RedLetterDayTableInfo object associated with the row.
Declaration
public RedLetterDayTableInfo RedLetterDayTableInfo { get; }
Property Value
Type | Description |
---|---|
RedLetterDayTableInfo |
Reds
.NET type: uint. The n´th bit corresponding to the date in dates month, is true if the color is active.
Declaration
public virtual uint Reds { get; set; }
Property Value
Type | Description |
---|---|
UInt32 |
Remarks
Original type in dictionary: UInt.
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
RgbColour
.NET type: uint. Actual RGB colour index
Declaration
public virtual uint RgbColour { get; set; }
Property Value
Type | Description |
---|---|
UInt32 |
Remarks
Original type in dictionary: UInt.
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
Text
.NET type: string. Text to show on the date
Declaration
public virtual string Text { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[80].
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
UpdatedCount
.NET type: short. Number of updates made to this record
Declaration
public virtual short UpdatedCount { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: UShort.
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 RedLetterDayRow object. Red letter days for calendar (holidays, birthday of king etc)
Declaration
public static RedLetterDayRow CreateNew()
Returns
Type | Description |
---|---|
RedLetterDayRow | A new instance of the RedLetterDayRow object. |
GetFromCustomSearch(RedLetterDayRow.CustomSearch)
Create a new instance of the RedLetterDayRow 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 RedLetterDayRow GetFromCustomSearch(RedLetterDayRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
RedLetterDayRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
RedLetterDayRow | A new instance of the RedLetterDayRow object, reflecting the result of the query. |
GetFromIdxRedletterdayId(Int32)
Create a new instance of the RedLetterDayRow object, by querying the database table via the index 'IDXRldayId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static RedLetterDayRow GetFromIdxRedletterdayId(int redletterdayId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | redletterdayId |
Returns
Type | Description |
---|---|
RedLetterDayRow | 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 RedLetterDay table. Non-unique indexes have corresponding inner classes and methods in the RedLetterDayRows collection, since they may return more than one row.
GetFromReader(SoDataReader, RedLetterDayTableInfo)
Create a new instance of the RedLetterDayRow 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. Red letter days for calendar (holidays, birthday of king etc)
Declaration
public static RedLetterDayRow GetFromReader(SoDataReader reader, RedLetterDayTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
RedLetterDayTableInfo | tableInfo | RedLetterDayTableInfo 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 |
---|---|
RedLetterDayRow | A new instance of the RedLetterDayRow 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
_onColorChange
Change envent for property Color; field is of .NET type short.
Declaration
protected event OnFieldChange<short> _onColorChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
_onColoredChange
Change envent for property Colored; field is of .NET type uint.
Declaration
protected event OnFieldChange<uint> _onColoredChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
_onCountryIdChange
Change envent for property CountryId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onCountryIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onExtraFlagsChange
Change envent for property ExtraFlags; field is of .NET type uint.
Declaration
protected event OnFieldChange<uint> _onExtraFlagsChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
_onReddateChange
Change envent for property Reddate; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onReddateChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onRedsChange
Change envent for property Reds; field is of .NET type uint.
Declaration
protected event OnFieldChange<uint> _onRedsChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
_onRgbColourChange
Change envent for property RgbColour; field is of .NET type uint.
Declaration
protected event OnFieldChange<uint> _onRgbColourChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
_onTextChange
Change envent for property Text; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onTextChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onUpdatedCountChange
Change envent for property UpdatedCount; field is of .NET type short.
Declaration
protected event OnFieldChange<short> _onUpdatedCountChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
OnColorChange
Event raised when Color is changing.
Declaration
public event OnFieldChange<short> OnColorChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
OnColoredChange
Event raised when Colored is changing.
Declaration
public event OnFieldChange<uint> OnColoredChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
OnCountryIdChange
Event raised when CountryId is changing.
Declaration
public event OnFieldChange<int> OnCountryIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnExtraFlagsChange
Event raised when ExtraFlags is changing.
Declaration
public event OnFieldChange<uint> OnExtraFlagsChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
OnReddateChange
Event raised when Reddate is changing.
Declaration
public event OnFieldChange<DateTime> OnReddateChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnRedsChange
Event raised when Reds is changing.
Declaration
public event OnFieldChange<uint> OnRedsChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
OnRgbColourChange
Event raised when RgbColour is changing.
Declaration
public event OnFieldChange<uint> OnRgbColourChange
Event Type
Type | Description |
---|---|
OnFieldChange<UInt32> |
OnTextChange
Event raised when Text is changing.
Declaration
public event OnFieldChange<string> OnTextChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnUpdatedCountChange
Event raised when UpdatedCount is changing.
Declaration
public event OnFieldChange<short> OnUpdatedCountChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |