Class EjselectionRow

This table stores selections, dynamic groups.
Row Object for table 'ejselection'. 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
EjselectionRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class EjselectionRow : 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) EjselectionRow EjselectionRow.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(EjselectionRow.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 EjselectionTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, EjselectionTableInfo) 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 EjselectionRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, EjselectionTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table Ejselection are:

Index fieldsNested index class name

Constructors

EjselectionRow(EjselectionRow.EjselectionRowIdxBase)

Constructor for the class taking an index as argument. This table stores selections, dynamic groups.

Declaration
protected EjselectionRow(EjselectionRow.EjselectionRowIdxBase idx)
Parameters
Type Name Description
EjselectionRow.EjselectionRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAccessLevel

Current value, see property AccessLevel.

Declaration
protected int _currentAccessLevel
Field Value
Type Description
Int32

_currentCreator

Current value, see property Creator.

Declaration
protected int _currentCreator
Field Value
Type Description
Int32

_currentDisplayProperties

Current value, see property DisplayProperties.

Declaration
protected string _currentDisplayProperties
Field Value
Type Description
String

_currentEjselectionId

Current value, see property EjselectionId.

Declaration
protected int _currentEjselectionId
Field Value
Type Description
Int32

_currentEjTable

Current value, see property EjTable.

Declaration
protected string _currentEjTable
Field Value
Type Description
String

_currentHierarchyId

Current value, see property HierarchyId.

Declaration
protected int _currentHierarchyId
Field Value
Type Description
Int32

_currentIncludeId

Current value, see property IncludeId.

Declaration
protected string _currentIncludeId
Field Value
Type Description
String

_currentLastCount

Current value, see property LastCount.

Declaration
protected int _currentLastCount
Field Value
Type Description
Int32

_currentLeftMenu

Current value, see property LeftMenu.

Declaration
protected short _currentLeftMenu
Field Value
Type Description
Int16

_currentName

Current value, see property Name.

Declaration
protected string _currentName
Field Value
Type Description
String

_currentResultConfig

Current value, see property ResultConfig.

Declaration
protected string _currentResultConfig
Field Value
Type Description
String

_currentSourceId

Current value, see property SourceId.

Declaration
protected int _currentSourceId
Field Value
Type Description
Int32

_currentSourceType

Current value, see property SourceType.

Declaration
protected int _currentSourceType
Field Value
Type Description
Int32

_persistedAccessLevel

Persisted value, see property AccessLevel.

Declaration
protected int _persistedAccessLevel
Field Value
Type Description
Int32

_persistedCreator

Persisted value, see property Creator.

Declaration
protected int _persistedCreator
Field Value
Type Description
Int32

_persistedDisplayProperties

Persisted value, see property DisplayProperties.

Declaration
protected string _persistedDisplayProperties
Field Value
Type Description
String

_persistedEjselectionId

Persisted value, see property EjselectionId.

Declaration
protected int _persistedEjselectionId
Field Value
Type Description
Int32

_persistedEjTable

Persisted value, see property EjTable.

Declaration
protected string _persistedEjTable
Field Value
Type Description
String

_persistedHierarchyId

Persisted value, see property HierarchyId.

Declaration
protected int _persistedHierarchyId
Field Value
Type Description
Int32

_persistedIncludeId

Persisted value, see property IncludeId.

Declaration
protected string _persistedIncludeId
Field Value
Type Description
String

_persistedLastCount

Persisted value, see property LastCount.

Declaration
protected int _persistedLastCount
Field Value
Type Description
Int32

_persistedLeftMenu

Persisted value, see property LeftMenu.

Declaration
protected short _persistedLeftMenu
Field Value
Type Description
Int16

_persistedName

Persisted value, see property Name.

Declaration
protected string _persistedName
Field Value
Type Description
String

_persistedResultConfig

Persisted value, see property ResultConfig.

Declaration
protected string _persistedResultConfig
Field Value
Type Description
String

_persistedSourceId

Persisted value, see property SourceId.

Declaration
protected int _persistedSourceId
Field Value
Type Description
Int32

_persistedSourceType

Persisted value, see property SourceType.

Declaration
protected int _persistedSourceType
Field Value
Type Description
Int32

Properties

AccessLevel

.NET type: int. Access level for this selection

Declaration
public virtual int AccessLevel { 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

Creator

.NET type: int. The user who created this selection

Declaration
public virtual int Creator { 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

DisplayProperties

.NET type: string. The display properties of this selection

Declaration
public virtual string DisplayProperties { 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

EjselectionId

.NET type: int. Primary key

Declaration
public virtual int EjselectionId { 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

EjselectionTableInfo

Get the EjselectionTableInfo object associated with the row.

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

EjTable

.NET type: string. The source table

Declaration
public virtual string EjTable { 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

HierarchyId

.NET type: int. This extra table is inside this hierarchy folder

Declaration
public virtual int HierarchyId { 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

IncludeId

.NET type: string. A unique name used for refering to selections in scripts, url's etc.

Declaration
public virtual string IncludeId { 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

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.

LastCount

.NET type: int. Last result count

Declaration
public virtual int LastCount { 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

LeftMenu

.NET type: short. Will this selection be listed in the left menu?

Declaration
public virtual short LeftMenu { 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

Name

.NET type: string. The name of this package

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

ResultConfig

.NET type: string. XML data

Declaration
public virtual string ResultConfig { 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

SourceId

.NET type: int. The id of the source we links to

Declaration
public virtual int SourceId { 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

SourceType

.NET type: int. The source type of this selection

Declaration
public virtual int SourceType { 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

TableInfo

Get the TableInfo for the table.

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

The TableInfo for the table.
Overrides

Methods

CreateNew()

Create a new instance of the EjselectionRow object. This table stores selections, dynamic groups.

Declaration
public static EjselectionRow CreateNew()
Returns
Type Description
EjselectionRow

A new instance of the EjselectionRow object.

GetFromCustomSearch(EjselectionRow.CustomSearch)

Create a new instance of the EjselectionRow 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 EjselectionRow GetFromCustomSearch(EjselectionRow.CustomSearch query)
Parameters
Type Name Description
EjselectionRow.CustomSearch query

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

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

GetFromIdxEjselectionId(Int32)

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

Declaration
public static EjselectionRow GetFromIdxEjselectionId(int ejselectionId)
Parameters
Type Name Description
Int32 ejselectionId
Returns
Type Description
EjselectionRow

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 Ejselection table. Non-unique indexes have corresponding inner classes and methods in the EjselectionRows collection, since they may return more than one row.

GetFromReader(SoDataReader, EjselectionTableInfo)

Create a new instance of the EjselectionRow 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. This table stores selections, dynamic groups.

Declaration
public static EjselectionRow GetFromReader(SoDataReader reader, EjselectionTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
EjselectionTableInfo tableInfo

EjselectionTableInfo 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
EjselectionRow

A new instance of the EjselectionRow 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

_onAccessLevelChange

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

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

_onCreatorChange

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

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

_onDisplayPropertiesChange

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

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

_onEjTableChange

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

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

_onHierarchyIdChange

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

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

_onIncludeIdChange

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

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

_onLastCountChange

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

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

_onLeftMenuChange

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

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

_onNameChange

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

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

_onResultConfigChange

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

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

_onSourceIdChange

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

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

_onSourceTypeChange

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

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

OnAccessLevelChange

Event raised when AccessLevel is changing.

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

OnCreatorChange

Event raised when Creator is changing.

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

OnDisplayPropertiesChange

Event raised when DisplayProperties is changing.

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

OnEjTableChange

Event raised when EjTable is changing.

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

OnHierarchyIdChange

Event raised when HierarchyId is changing.

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

OnIncludeIdChange

Event raised when IncludeId is changing.

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

OnLastCountChange

Event raised when LastCount is changing.

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

OnLeftMenuChange

Event raised when LeftMenu is changing.

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

OnNameChange

Event raised when Name is changing.

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

OnResultConfigChange

Event raised when ResultConfig is changing.

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

OnSourceIdChange

Event raised when SourceId is changing.

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

OnSourceTypeChange

Event raised when SourceType is changing.

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

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)