Class ActiveUserRow

Currently logged-on users. This table contains encrypted license information. Changing it may disable login for all users and require intervention by SuperOffice support. Recommended use: for determining who is logged on, at what location, etc.
Row Object for table 'activeuser'. 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

ActiveUserRow

Implements

Inherited Members

TableRowBase._saveOwner

TableRowBase._sentries

TableRowBase._onValueChange

TableRowBase._relatedNestedPersistMembers

TableRowBase._sqlType

TableRowBase.InternalSetValue(Int32, Object)

TableRowBase.InternalSetValue(SoField, Object)

TableRowBase.GetFieldValue(FieldInfo)

TableRowBase.GetKnownFields()

TableRowBase.ISoDataLookup.GetPersistedFieldValue(FieldInfo)

TableRowBase.ISoDataLookup.IsPersistedFieldValueKnown(FieldInfo)

TableRowBase.IsGhostField(FieldInfo)

TableRowBase.RowLoad()

TableRowBase.RowLoad(ITableRowLoadHandler)

TableRowBase.OnLoaded(IdxBase)

TableRowBase.Load(IdxBase, SoDataReader)

TableRowBase.Load(SoDataReader, TableInfo)

TableRowBase.SetDefaults()

TableRowBase.SetDefaults(DashboardTileDefinitionRow, String)

TableRowBase.SetSaveOwner(INestedPersist)

TableRowBase.Save()

TableRowBase.Delete()

TableRowBase.Validate()

TableRowBase.SetDirty(Int32, Object, Object)

TableRowBase.INestedPersist.OnPreIdUpdate()

TableRowBase.INestedPersist.OnPrimaryKeyRequest(PKContainer)

TableRowBase.INestedPersist.OnPrimaryKeyUpdate(PKContainer)

TableRowBase.INestedPersist.OnIdUpdate()

TableRowBase.INestedPersist.OnSave(BatchSave)

TableRowBase.INestedPersist.OnSaved(Boolean)

TableRowBase.OnPreIdUpdate()

TableRowBase.OnPrimaryKeyRequest(PKContainer)

TableRowBase.OnPrimaryKeyUpdate(PKContainer)

TableRowBase.OnIdUpdate()

TableRowBase.BeginIgnoreSentryCheck()

TableRowBase.EndIgnoreSentryCheck()

TableRowBase.GetRelatedNestedPersist()

TableRowBase.Item[Int32]

TableRowBase.Item[SoField]

TableRowBase.Sentries

TableRowBase.ForeignKeyHelper

TableRowBase.IsDeleted

TableRowBase.IsSaving

TableRowBase.SqlType

TableRowBase.IsSentryIgnored

TableRowBase.IsMarkedForDelete

TableRowBase.OnValueChanged

TableRowBase.OnElementSaved

TableRowBase.OnElementIdUpdate

PrivateSave.GetTableInfos()

PrivateSave.CloneToBasicUpdatingQuery()

PrivateSave.OnUpdateField

SqlCommand.Origin

SqlCommand.AddIgnoreAutoSentryTableInfo(TableInfo)

SqlCommand.AddIgnoreAutoSentryTableInfo(IEnumerable<TableInfo>)

SqlCommand.RemoveIgnoreAutoSentryTableInfo(TableInfo)

SqlCommand.ClearIgnoreAutoSentryTableInfos()

SqlCommand.IsAutoSentryIgnoredOnTableInfo(TableInfo)

SqlCommand.GetPrivateSaves()

SqlCommand.GetInserts()

SqlCommand.GetUpdates()

SqlCommand.GetDeletes()

SqlCommand.GetSelect()

SqlCommand.AutoSentryIgnoredTables

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

public class ActiveUserRow : 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) ActiveUserRow ActiveUserRow.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(ActiveUserRow.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 ActiveUserTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ActiveUserTableInfo) 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 ActiveUserRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, ActiveUserTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table ActiveUser are:

Index fields	Nested index class name

Constructors

ActiveUserRow(ActiveUserRow.ActiveUserRowIdxBase)

Constructor for the class taking an index as argument. Currently logged-on users. This table contains encrypted license information. Changing it may disable login for all users and require intervention by SuperOffice support. Recommended use: for determining who is logged on, at what location, etc.

Declaration

protected ActiveUserRow(ActiveUserRow.ActiveUserRowIdxBase idx)

Parameters

Type	Name	Description
ActiveUserRow.ActiveUserRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentActiveuserId

Current value, see property ActiveuserId.

Declaration

protected int _currentActiveuserId

Field Value

Type	Description
Int32

_currentClientType

Current value, see property ClientType.

Declaration

protected short _currentClientType

Field Value

Type	Description
Int16

_currentComputerName

Current value, see property ComputerName.

Declaration

protected string _currentComputerName

Field Value

Type	Description
String

_currentDomainName

Current value, see property DomainName.

Declaration

protected string _currentDomainName

Field Value

Type	Description
String

_currentLastlogin

Current value, see property Lastlogin.

Declaration

protected DateTime _currentLastlogin

Field Value

Type	Description
DateTime

_currentNetAddress

Current value, see property NetAddress.

Declaration

protected string _currentNetAddress

Field Value

Type	Description
String

_currentOsUserName

Current value, see property OsUserName.

Declaration

protected string _currentOsUserName

Field Value

Type	Description
String

_persistedActiveuserId

Persisted value, see property ActiveuserId.

Declaration

protected int _persistedActiveuserId

Field Value

Type	Description
Int32

_persistedClientType

Persisted value, see property ClientType.

Declaration

protected short _persistedClientType

Field Value

Type	Description
Int16

_persistedComputerName

Persisted value, see property ComputerName.

Declaration

protected string _persistedComputerName

Field Value

Type	Description
String

_persistedDomainName

Persisted value, see property DomainName.

Declaration

protected string _persistedDomainName

Field Value

Type	Description
String

_persistedLastlogin

Persisted value, see property Lastlogin.

Declaration

protected DateTime _persistedLastlogin

Field Value

Type	Description
DateTime

_persistedNetAddress

Persisted value, see property NetAddress.

Declaration

protected string _persistedNetAddress

Field Value

Type	Description
String

_persistedOsUserName

Persisted value, see property OsUserName.

Declaration

protected string _persistedOsUserName

Field Value

Type	Description
String

Properties

ActiveuserId

.NET type: int. Note: This ID is not assigned from sequence, but instead corresponds to the Associate primary key

Declaration

public virtual int ActiveuserId { 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.

Fields in this table are writeable only from within the same SoDatabase assembly

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

ActiveUserTableInfo

Get the ActiveUserTableInfo object associated with the row.

Declaration

public ActiveUserTableInfo ActiveUserTableInfo { get; }

Property Value

Type	Description
ActiveUserTableInfo

ClientType

.NET type: short. 1=CRM , 2=Admin, 3=SOQL, …

Declaration

public virtual short ClientType { get; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: UShort.

Fields in this table are writeable only from within the same SoDatabase assembly

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

ComputerName

.NET type: string. Computer name

Declaration

public virtual string ComputerName { get; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[128].

Fields in this table are writeable only from within the same SoDatabase assembly

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

DomainName

.NET type: string. Domain name

Declaration

public virtual string DomainName { get; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[128].

Fields in this table are writeable only from within the same SoDatabase assembly

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

PrivateSave.InnerFieldValuePairs

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

PrivateSave.InnerPrimaryKey

InnerPrimaryKeyValue

The actual value the primary key must have.

Declaration

protected override Parameter InnerPrimaryKeyValue { get; }

Property Value

Type	Description
Parameter

Overrides

PrivateSave.InnerPrimaryKeyValue

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

TableRowBase.IsDirty

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

TableRowBase.IsNew

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

TableRowBase.Item[String]

Exceptions

Type	Condition
ArgumentException	Thrown if the field is not known.

Lastlogin

.NET type: DateTime. Date of last login

Declaration

public virtual DateTime Lastlogin { get; }

Property Value

Type	Description
DateTime

Remarks

Original type in dictionary: DateTime.

Fields in this table are writeable only from within the same SoDatabase assembly

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

NetAddress

.NET type: string. DNS and numeric IP address

Declaration

public virtual string NetAddress { get; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[128].

Fields in this table are writeable only from within the same SoDatabase assembly

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

OsUserName

.NET type: string. OS user name currently logged on

Declaration

public virtual string OsUserName { get; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[128].

Fields in this table are writeable only from within the same SoDatabase assembly

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

TableRowBase.TableInfo

Methods

CreateNew()

Create a new instance of the ActiveUserRow object. Currently logged-on users. This table contains encrypted license information. Changing it may disable login for all users and require intervention by SuperOffice support. Recommended use: for determining who is logged on, at what location, etc.

Declaration

public static ActiveUserRow CreateNew()

Returns

Type	Description
ActiveUserRow	A new instance of the ActiveUserRow object.

GetFromCustomSearch(ActiveUserRow.CustomSearch)

Create a new instance of the ActiveUserRow 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 ActiveUserRow GetFromCustomSearch(ActiveUserRow.CustomSearch query)

Parameters

Type	Name	Description
ActiveUserRow.CustomSearch	query	The custom search to execute against the database

Returns

Type	Description
ActiveUserRow	A new instance of the ActiveUserRow object, reflecting the result of the query.

GetFromIdxActiveuserId(Int32)

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

Declaration

public static ActiveUserRow GetFromIdxActiveuserId(int activeuserId)

Parameters

Type	Name	Description
Int32	activeuserId

Returns

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

GetFromReader(SoDataReader, ActiveUserTableInfo)

Create a new instance of the ActiveUserRow 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. Currently logged-on users. This table contains encrypted license information. Changing it may disable login for all users and require intervention by SuperOffice support. Recommended use: for determining who is logged on, at what location, etc.

Declaration

public static ActiveUserRow GetFromReader(SoDataReader reader, ActiveUserTableInfo tableInfo)

Parameters

Type	Name	Description
SoDataReader	reader	SoDataReader positioned to a valid database row.
ActiveUserTableInfo	tableInfo	ActiveUserTableInfo 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
ActiveUserRow	A new instance of the ActiveUserRow 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

PrivateSave.GetPersistedFieldValue(FieldInfo)

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

TableRowBase.InternalSetValue(String, Object)

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

PrivateSave.IsPersistedFieldValueKnown(FieldInfo)

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

TableRowBase.OnLoad(SoDataReader, TableInfo)

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

TableRowBase.OnSave(BatchSave)

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

TableRowBase.OnSaved(Boolean)

Reset()

Reset the changes made on the object.

Declaration

protected override void Reset()

Overrides

TableRowBase.Reset()

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

TableRowBase.SetDefaults(DefaulterStrategy)

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

TableRowBase.SetPrimaryKey(Int32)

SetRowAsNew()

Declaration

public override void SetRowAsNew()

Overrides

TableRowBase.SetRowAsNew()

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

Object.ToString()

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

TableRowBase.Validate(RowValidator)

Events

_onClientTypeChange

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

Declaration

protected event OnFieldChange<short> _onClientTypeChange

Event Type

Type	Description
OnFieldChange<Int16>

_onComputerNameChange

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

Declaration

protected event OnFieldChange<string> _onComputerNameChange

Event Type

Type	Description
OnFieldChange<String>

_onDomainNameChange

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

Declaration

protected event OnFieldChange<string> _onDomainNameChange

Event Type

Type	Description
OnFieldChange<String>

_onLastloginChange

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

Declaration

protected event OnFieldChange<DateTime> _onLastloginChange

Event Type

Type	Description
OnFieldChange<DateTime>

_onNetAddressChange

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

Declaration

protected event OnFieldChange<string> _onNetAddressChange

Event Type

Type	Description
OnFieldChange<String>

_onOsUserNameChange

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

Declaration

protected event OnFieldChange<string> _onOsUserNameChange

Event Type

Type	Description
OnFieldChange<String>

OnClientTypeChange

Event raised when ClientType is changing.

Declaration

public event OnFieldChange<short> OnClientTypeChange

Event Type

Type	Description
OnFieldChange<Int16>

OnComputerNameChange

Event raised when ComputerName is changing.

Declaration

public event OnFieldChange<string> OnComputerNameChange

Event Type

Type	Description
OnFieldChange<String>

OnDomainNameChange

Event raised when DomainName is changing.

Declaration

public event OnFieldChange<string> OnDomainNameChange

Event Type

Type	Description
OnFieldChange<String>

OnLastloginChange

Event raised when Lastlogin is changing.

Declaration

public event OnFieldChange<DateTime> OnLastloginChange

Event Type

Type	Description
OnFieldChange<DateTime>

OnNetAddressChange

Event raised when NetAddress is changing.

Declaration

public event OnFieldChange<string> OnNetAddressChange

Event Type

Type	Description
OnFieldChange<String>

OnOsUserNameChange

Event raised when OsUserName is changing.

Declaration

public event OnFieldChange<string> OnOsUserNameChange

Event Type

Type	Description
OnFieldChange<String>

Implements

INestedPersist

ISoDataLookup

ISentryIgnorable

ISoItem

Extension Methods

EnumUtil.MapEnums<From, To>(From)

QueryExectionExtensions.ExecuteReader(SqlCommand, Boolean)

QueryExectionExtensions.ExecuteScalar<T>(SqlCommand)

QueryExectionExtensions.ExecuteNonQuery(SqlCommand)

Converters.MapEnums<From, To>(From)