Class SessionObjectRow
Generic session object, accessible from ejscript etc, typically xml or name=value syntax, may be stored over several rows if big
Row Object for table 'session_object'. 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 SessionObjectRow : 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) SessionObjectRow SessionObjectRow.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(SessionObjectRow.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 SessionObjectTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, SessionObjectTableInfo) 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 SessionObject are:
Index fields | Nested index class name |
---|
Constructors
SessionObjectRow(SessionObjectRow.SessionObjectRowIdxBase)
Constructor for the class taking an index as argument. Generic session object, accessible from ejscript etc, typically xml or name=value syntax, may be stored over several rows if big
Declaration
protected SessionObjectRow(SessionObjectRow.SessionObjectRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
SessionObjectRow.SessionObjectRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentCreatedAt
Current value, see property CreatedAt.
Declaration
protected DateTime _currentCreatedAt
Field Value
Type | Description |
---|---|
DateTime |
_currentLoginId
Current value, see property LoginId.
Declaration
protected int _currentLoginId
Field Value
Type | Description |
---|---|
Int32 |
_currentName
Current value, see property Name.
Declaration
protected string _currentName
Field Value
Type | Description |
---|---|
String |
_currentPart
Current value, see property Part.
Declaration
protected int _currentPart
Field Value
Type | Description |
---|---|
Int32 |
_currentSessionObjectId
Current value, see property SessionObjectId.
Declaration
protected int _currentSessionObjectId
Field Value
Type | Description |
---|---|
Int32 |
_currentSessionValue
Current value, see property SessionValue.
Declaration
protected string _currentSessionValue
Field Value
Type | Description |
---|---|
String |
_persistedCreatedAt
Persisted value, see property CreatedAt.
Declaration
protected DateTime _persistedCreatedAt
Field Value
Type | Description |
---|---|
DateTime |
_persistedLoginId
Persisted value, see property LoginId.
Declaration
protected int _persistedLoginId
Field Value
Type | Description |
---|---|
Int32 |
_persistedName
Persisted value, see property Name.
Declaration
protected string _persistedName
Field Value
Type | Description |
---|---|
String |
_persistedPart
Persisted value, see property Part.
Declaration
protected int _persistedPart
Field Value
Type | Description |
---|---|
Int32 |
_persistedSessionObjectId
Persisted value, see property SessionObjectId.
Declaration
protected int _persistedSessionObjectId
Field Value
Type | Description |
---|---|
Int32 |
_persistedSessionValue
Persisted value, see property SessionValue.
Declaration
protected string _persistedSessionValue
Field Value
Type | Description |
---|---|
String |
Properties
CreatedAt
.NET type: DateTime. When the object was posted.
Declaration
public virtual DateTime CreatedAt { 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
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. |
LoginId
.NET type: int. The id of the login session owning this session object
Declaration
public virtual int LoginId { 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
Name
.NET type: string. A unique name for the entry
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
Part
.NET type: int. Part number used to concatinate long values
Declaration
public virtual int Part { 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
SessionObjectId
.NET type: int. The primary key (auto-incremented)
Declaration
public virtual int SessionObjectId { 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
SessionObjectTableInfo
Get the SessionObjectTableInfo object associated with the row.
Declaration
public SessionObjectTableInfo SessionObjectTableInfo { get; }
Property Value
Type | Description |
---|---|
SessionObjectTableInfo |
SessionValue
.NET type: string. The object value
Declaration
public virtual string SessionValue { 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
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 SessionObjectRow object. Generic session object, accessible from ejscript etc, typically xml or name=value syntax, may be stored over several rows if big
Declaration
public static SessionObjectRow CreateNew()
Returns
Type | Description |
---|---|
SessionObjectRow | A new instance of the SessionObjectRow object. |
GetFromCustomSearch(SessionObjectRow.CustomSearch)
Create a new instance of the SessionObjectRow 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 SessionObjectRow GetFromCustomSearch(SessionObjectRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
SessionObjectRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
SessionObjectRow | A new instance of the SessionObjectRow object, reflecting the result of the query. |
GetFromIdxSessionObjectId(Int32)
Create a new instance of the SessionObjectRow object, by querying the database table via the index 'IDXSession_objectId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static SessionObjectRow GetFromIdxSessionObjectId(int sessionObjectId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | sessionObjectId |
Returns
Type | Description |
---|---|
SessionObjectRow | 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 SessionObject table. Non-unique indexes have corresponding inner classes and methods in the SessionObjectRows collection, since they may return more than one row.
GetFromReader(SoDataReader, SessionObjectTableInfo)
Create a new instance of the SessionObjectRow 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 session object, accessible from ejscript etc, typically xml or name=value syntax, may be stored over several rows if big
Declaration
public static SessionObjectRow GetFromReader(SoDataReader reader, SessionObjectTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
SessionObjectTableInfo | tableInfo | SessionObjectTableInfo 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 |
---|---|
SessionObjectRow | A new instance of the SessionObjectRow 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
_onCreatedAtChange
Change envent for property CreatedAt; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onCreatedAtChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onLoginIdChange
Change envent for property LoginId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onLoginIdChange
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> |
_onPartChange
Change envent for property Part; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onPartChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onSessionValueChange
Change envent for property SessionValue; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onSessionValueChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnCreatedAtChange
Event raised when CreatedAt is changing.
Declaration
public event OnFieldChange<DateTime> OnCreatedAtChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnLoginIdChange
Event raised when LoginId is changing.
Declaration
public event OnFieldChange<int> OnLoginIdChange
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> |
OnPartChange
Event raised when Part is changing.
Declaration
public event OnFieldChange<int> OnPartChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnSessionValueChange
Event raised when SessionValue is changing.
Declaration
public event OnFieldChange<string> OnSessionValueChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |