Class EjpackageRow

This table stores packages on the system.
Row Object for table 'ejpackage'. 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

EjpackageRow

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

Unique indexes on table Ejpackage are:

Index fields	Nested index class name

Constructors

EjpackageRow(EjpackageRow.EjpackageRowIdxBase)

Constructor for the class taking an index as argument. This table stores packages on the system.

Declaration

protected EjpackageRow(EjpackageRow.EjpackageRowIdxBase idx)

Parameters

Type	Name	Description
EjpackageRow.EjpackageRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentAttachmentId

Current value, see property AttachmentId.

Declaration

protected int _currentAttachmentId

Field Value

Type	Description
Int32

_currentDescription

Current value, see property Description.

Declaration

protected string _currentDescription

Field Value

Type	Description
String

_currentEjpackageId

Current value, see property EjpackageId.

Declaration

protected int _currentEjpackageId

Field Value

Type	Description
Int32

_currentEjVersion

Current value, see property EjVersion.

Declaration

protected string _currentEjVersion

Field Value

Type	Description
String

_currentInstallScript

Current value, see property InstallScript.

Declaration

protected string _currentInstallScript

Field Value

Type	Description
String

_currentLocked

Current value, see property Locked.

Declaration

protected short _currentLocked

Field Value

Type	Description
Int16

_currentName

Current value, see property Name.

Declaration

protected string _currentName

Field Value

Type	Description
String

_currentPackageVersion

Current value, see property PackageVersion.

Declaration

protected string _currentPackageVersion

Field Value

Type	Description
String

_currentUploadedAt

Current value, see property UploadedAt.

Declaration

protected DateTime _currentUploadedAt

Field Value

Type	Description
DateTime

_currentUploadedBy

Current value, see property UploadedBy.

Declaration

protected int _currentUploadedBy

Field Value

Type	Description
Int32

_persistedAttachmentId

Persisted value, see property AttachmentId.

Declaration

protected int _persistedAttachmentId

Field Value

Type	Description
Int32

_persistedDescription

Persisted value, see property Description.

Declaration

protected string _persistedDescription

Field Value

Type	Description
String

_persistedEjpackageId

Persisted value, see property EjpackageId.

Declaration

protected int _persistedEjpackageId

Field Value

Type	Description
Int32

_persistedEjVersion

Persisted value, see property EjVersion.

Declaration

protected string _persistedEjVersion

Field Value

Type	Description
String

_persistedInstallScript

Persisted value, see property InstallScript.

Declaration

protected string _persistedInstallScript

Field Value

Type	Description
String

_persistedLocked

Persisted value, see property Locked.

Declaration

protected short _persistedLocked

Field Value

Type	Description
Int16

_persistedName

Persisted value, see property Name.

Declaration

protected string _persistedName

Field Value

Type	Description
String

_persistedPackageVersion

Persisted value, see property PackageVersion.

Declaration

protected string _persistedPackageVersion

Field Value

Type	Description
String

_persistedUploadedAt

Persisted value, see property UploadedAt.

Declaration

protected DateTime _persistedUploadedAt

Field Value

Type	Description
DateTime

_persistedUploadedBy

Persisted value, see property UploadedBy.

Declaration

protected int _persistedUploadedBy

Field Value

Type	Description
Int32

Properties

AttachmentId

.NET type: int. The attachment.id for the attachment containing the xml

Declaration

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

Description

.NET type: string. Description/comment

Declaration

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

EjpackageId

.NET type: int. Primary key

Declaration

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

EjpackageTableInfo

Get the EjpackageTableInfo object associated with the row.

Declaration

public EjpackageTableInfo EjpackageTableInfo { get; }

Property Value

Type	Description
EjpackageTableInfo

EjVersion

.NET type: string. The oldest eJournal version this package can be installed on

Declaration

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

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

InstallScript

.NET type: string. Installation script

Declaration

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

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.

Locked

.NET type: short. Locked package - components should not be modified by users

Declaration

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

PackageVersion

.NET type: string. Version of the created package

Declaration

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

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

UploadedAt

.NET type: DateTime. Time of upload of this package

Declaration

public virtual DateTime UploadedAt { 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

UploadedBy

.NET type: int. Uploaded by

Declaration

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

Methods

CreateNew()

Create a new instance of the EjpackageRow object. This table stores packages on the system.

Declaration

public static EjpackageRow CreateNew()

Returns

Type	Description
EjpackageRow	A new instance of the EjpackageRow object.

GetFromCustomSearch(EjpackageRow.CustomSearch)

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

Parameters

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

Returns

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

GetFromIdxEjpackageId(Int32)

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

Declaration

public static EjpackageRow GetFromIdxEjpackageId(int ejpackageId)

Parameters

Type	Name	Description
Int32	ejpackageId

Returns

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

GetFromReader(SoDataReader, EjpackageTableInfo)

Create a new instance of the EjpackageRow 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 packages on the system.

Declaration

public static EjpackageRow GetFromReader(SoDataReader reader, EjpackageTableInfo tableInfo)

Parameters

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

_onAttachmentIdChange

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

Declaration

protected event OnFieldChange<int> _onAttachmentIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onDescriptionChange

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

Declaration

protected event OnFieldChange<string> _onDescriptionChange

Event Type

Type	Description
OnFieldChange<String>

_onEjVersionChange

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

Declaration

protected event OnFieldChange<string> _onEjVersionChange

Event Type

Type	Description
OnFieldChange<String>

_onInstallScriptChange

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

Declaration

protected event OnFieldChange<string> _onInstallScriptChange

Event Type

Type	Description
OnFieldChange<String>

_onLockedChange

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

Declaration

protected event OnFieldChange<short> _onLockedChange

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>

_onPackageVersionChange

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

Declaration

protected event OnFieldChange<string> _onPackageVersionChange

Event Type

Type	Description
OnFieldChange<String>

_onUploadedAtChange

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

Declaration

protected event OnFieldChange<DateTime> _onUploadedAtChange

Event Type

Type	Description
OnFieldChange<DateTime>

_onUploadedByChange

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

Declaration

protected event OnFieldChange<int> _onUploadedByChange

Event Type

Type	Description
OnFieldChange<Int32>

OnAttachmentIdChange

Event raised when AttachmentId is changing.

Declaration

public event OnFieldChange<int> OnAttachmentIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnDescriptionChange

Event raised when Description is changing.

Declaration

public event OnFieldChange<string> OnDescriptionChange

Event Type

Type	Description
OnFieldChange<String>

OnEjVersionChange

Event raised when EjVersion is changing.

Declaration

public event OnFieldChange<string> OnEjVersionChange

Event Type

Type	Description
OnFieldChange<String>

OnInstallScriptChange

Event raised when InstallScript is changing.

Declaration

public event OnFieldChange<string> OnInstallScriptChange

Event Type

Type	Description
OnFieldChange<String>

OnLockedChange

Event raised when Locked is changing.

Declaration

public event OnFieldChange<short> OnLockedChange

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>

OnPackageVersionChange

Event raised when PackageVersion is changing.

Declaration

public event OnFieldChange<string> OnPackageVersionChange

Event Type

Type	Description
OnFieldChange<String>

OnUploadedAtChange

Event raised when UploadedAt is changing.

Declaration

public event OnFieldChange<DateTime> OnUploadedAtChange

Event Type

Type	Description
OnFieldChange<DateTime>

OnUploadedByChange

Event raised when UploadedBy is changing.

Declaration

public event OnFieldChange<int> OnUploadedByChange

Event Type

Type	Description
OnFieldChange<Int32>

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)