Class DocFolderRow

A document folder.
Row Object for table 'doc_folder'. 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

DocFolderRow

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

Unique indexes on table DocFolder are:

Index fields	Nested index class name

Constructors

DocFolderRow(DocFolderRow.DocFolderRowIdxBase)

Constructor for the class taking an index as argument. A document folder.

Declaration

protected DocFolderRow(DocFolderRow.DocFolderRowIdxBase idx)

Parameters

Type	Name	Description
DocFolderRow.DocFolderRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentAccessLevel

Current value, see property AccessLevel.

Declaration

protected short _currentAccessLevel

Field Value

Type	Description
Int16

_currentCreatedAt

Current value, see property CreatedAt.

Declaration

protected DateTime _currentCreatedAt

Field Value

Type	Description
DateTime

_currentCreatedBy

Current value, see property CreatedBy.

Declaration

protected int _currentCreatedBy

Field Value

Type	Description
Int32

_currentDocFolderId

Current value, see property DocFolderId.

Declaration

protected int _currentDocFolderId

Field Value

Type	Description
Int32

_currentFolderId

Current value, see property FolderId.

Declaration

protected int _currentFolderId

Field Value

Type	Description
Int32

_currentFullname

Current value, see property Fullname.

Declaration

protected string _currentFullname

Field Value

Type	Description
String

_currentInheritedAccessLevel

Current value, see property InheritedAccessLevel.

Declaration

protected short _currentInheritedAccessLevel

Field Value

Type	Description
Int16

_currentStatus

Current value, see property Status.

Declaration

protected short _currentStatus

Field Value

Type	Description
Int16

_currentTitle

Current value, see property Title.

Declaration

protected string _currentTitle

Field Value

Type	Description
String

_persistedAccessLevel

Persisted value, see property AccessLevel.

Declaration

protected short _persistedAccessLevel

Field Value

Type	Description
Int16

_persistedCreatedAt

Persisted value, see property CreatedAt.

Declaration

protected DateTime _persistedCreatedAt

Field Value

Type	Description
DateTime

_persistedCreatedBy

Persisted value, see property CreatedBy.

Declaration

protected int _persistedCreatedBy

Field Value

Type	Description
Int32

_persistedDocFolderId

Persisted value, see property DocFolderId.

Declaration

protected int _persistedDocFolderId

Field Value

Type	Description
Int32

_persistedFolderId

Persisted value, see property FolderId.

Declaration

protected int _persistedFolderId

Field Value

Type	Description
Int32

_persistedFullname

Persisted value, see property Fullname.

Declaration

protected string _persistedFullname

Field Value

Type	Description
String

_persistedInheritedAccessLevel

Persisted value, see property InheritedAccessLevel.

Declaration

protected short _persistedInheritedAccessLevel

Field Value

Type	Description
Int16

_persistedStatus

Persisted value, see property Status.

Declaration

protected short _persistedStatus

Field Value

Type	Description
Int16

_persistedTitle

Persisted value, see property Title.

Declaration

protected string _persistedTitle

Field Value

Type	Description
String

Properties

AccessLevel

.NET type: short. The access level for the folder

Declaration

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

CreatedAt

.NET type: DateTime. When the folder was created.

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

CreatedBy

.NET type: int. The used who created the folder.

Declaration

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

DocFolderId

.NET type: int. The primary id (auto-incremented)

Declaration

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

DocFolderTableInfo

Get the DocFolderTableInfo object associated with the row.

Declaration

public DocFolderTableInfo DocFolderTableInfo { get; }

Property Value

Type	Description
DocFolderTableInfo

FolderId

.NET type: int. The parent folder. -1 if this is a root folder.

Declaration

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

Fullname

.NET type: string. The full name of this category, i.e. Foo/bar/test.

Declaration

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

InheritedAccessLevel

.NET type: short. The lowest access level for this folder or any parent

Declaration

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

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.

Status

.NET type: short. The status of the folder.

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

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

Title

.NET type: string. The title of the folder

Declaration

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

Methods

CreateNew()

Create a new instance of the DocFolderRow object. A document folder.

Declaration

public static DocFolderRow CreateNew()

Returns

Type	Description
DocFolderRow	A new instance of the DocFolderRow object.

GetFromCustomSearch(DocFolderRow.CustomSearch)

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

Parameters

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

Returns

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

GetFromIdxDocFolderId(Int32)

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

Declaration

public static DocFolderRow GetFromIdxDocFolderId(int docFolderId)

Parameters

Type	Name	Description
Int32	docFolderId

Returns

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

GetFromReader(SoDataReader, DocFolderTableInfo)

Create a new instance of the DocFolderRow 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. A document folder.

Declaration

public static DocFolderRow GetFromReader(SoDataReader reader, DocFolderTableInfo tableInfo)

Parameters

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

_onAccessLevelChange

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

Declaration

protected event OnFieldChange<short> _onAccessLevelChange

Event Type

Type	Description
OnFieldChange<Int16>

_onCreatedAtChange

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

Declaration

protected event OnFieldChange<DateTime> _onCreatedAtChange

Event Type

Type	Description
OnFieldChange<DateTime>

_onCreatedByChange

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

Declaration

protected event OnFieldChange<int> _onCreatedByChange

Event Type

Type	Description
OnFieldChange<Int32>

_onFolderIdChange

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

Declaration

protected event OnFieldChange<int> _onFolderIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onFullnameChange

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

Declaration

protected event OnFieldChange<string> _onFullnameChange

Event Type

Type	Description
OnFieldChange<String>

_onInheritedAccessLevelChange

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

Declaration

protected event OnFieldChange<short> _onInheritedAccessLevelChange

Event Type

Type	Description
OnFieldChange<Int16>

_onStatusChange

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

Declaration

protected event OnFieldChange<short> _onStatusChange

Event Type

Type	Description
OnFieldChange<Int16>

_onTitleChange

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

Declaration

protected event OnFieldChange<string> _onTitleChange

Event Type

Type	Description
OnFieldChange<String>

OnAccessLevelChange

Event raised when AccessLevel is changing.

Declaration

public event OnFieldChange<short> OnAccessLevelChange

Event Type

Type	Description
OnFieldChange<Int16>

OnCreatedAtChange

Event raised when CreatedAt is changing.

Declaration

public event OnFieldChange<DateTime> OnCreatedAtChange

Event Type

Type	Description
OnFieldChange<DateTime>

OnCreatedByChange

Event raised when CreatedBy is changing.

Declaration

public event OnFieldChange<int> OnCreatedByChange

Event Type

Type	Description
OnFieldChange<Int32>

OnFolderIdChange

Event raised when FolderId is changing.

Declaration

public event OnFieldChange<int> OnFolderIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnFullnameChange

Event raised when Fullname is changing.

Declaration

public event OnFieldChange<string> OnFullnameChange

Event Type

Type	Description
OnFieldChange<String>

OnInheritedAccessLevelChange

Event raised when InheritedAccessLevel is changing.

Declaration

public event OnFieldChange<short> OnInheritedAccessLevelChange

Event Type

Type	Description
OnFieldChange<Int16>

OnStatusChange

Event raised when Status is changing.

Declaration

public event OnFieldChange<short> OnStatusChange

Event Type

Type	Description
OnFieldChange<Int16>

OnTitleChange

Event raised when Title is changing.

Declaration

public event OnFieldChange<string> OnTitleChange

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)