Class ProductVersionRow
Version information for code modules. Owner + code module must be unique
Row Object for table 'ProductVersion'. 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 ProductVersionRow : 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) ProductVersionRow ProductVersionRow.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(ProductVersionRow.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 ProductVersionTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ProductVersionTableInfo) 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 ProductVersion are:
Index fields | Nested index class name |
---|
Constructors
ProductVersionRow(ProductVersionRow.ProductVersionRowIdxBase)
Constructor for the class taking an index as argument. Version information for code modules. Owner + code module must be unique
Declaration
protected ProductVersionRow(ProductVersionRow.ProductVersionRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
ProductVersionRow.ProductVersionRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentCodeName
Current value, see property CodeName.
Declaration
protected string _currentCodeName
Field Value
Type | Description |
---|---|
String |
_currentComment
Current value, see property Comment.
Declaration
protected string _currentComment
Field Value
Type | Description |
---|---|
String |
_currentOwnerName
Current value, see property OwnerName.
Declaration
protected string _currentOwnerName
Field Value
Type | Description |
---|---|
String |
_currentProductVersionId
Current value, see property ProductVersionId.
Declaration
protected int _currentProductVersionId
Field Value
Type | Description |
---|---|
Int32 |
_currentRegistered
Current value, see property Registered.
Declaration
protected DateTime _currentRegistered
Field Value
Type | Description |
---|---|
DateTime |
_currentRegisteredAssociateId
Current value, see property RegisteredAssociateId.
Declaration
protected int _currentRegisteredAssociateId
Field Value
Type | Description |
---|---|
Int32 |
_currentUpdated
Current value, see property Updated.
Declaration
protected DateTime _currentUpdated
Field Value
Type | Description |
---|---|
DateTime |
_currentUpdatedAssociateId
Current value, see property UpdatedAssociateId.
Declaration
protected int _currentUpdatedAssociateId
Field Value
Type | Description |
---|---|
Int32 |
_currentUpdatedCount
Current value, see property UpdatedCount.
Declaration
protected short _currentUpdatedCount
Field Value
Type | Description |
---|---|
Int16 |
_currentUpdatePath
Current value, see property UpdatePath.
Declaration
protected string _currentUpdatePath
Field Value
Type | Description |
---|---|
String |
_currentVersion
Current value, see property Version.
Declaration
protected string _currentVersion
Field Value
Type | Description |
---|---|
String |
_persistedCodeName
Persisted value, see property CodeName.
Declaration
protected string _persistedCodeName
Field Value
Type | Description |
---|---|
String |
_persistedComment
Persisted value, see property Comment.
Declaration
protected string _persistedComment
Field Value
Type | Description |
---|---|
String |
_persistedOwnerName
Persisted value, see property OwnerName.
Declaration
protected string _persistedOwnerName
Field Value
Type | Description |
---|---|
String |
_persistedProductVersionId
Persisted value, see property ProductVersionId.
Declaration
protected int _persistedProductVersionId
Field Value
Type | Description |
---|---|
Int32 |
_persistedRegistered
Persisted value, see property Registered.
Declaration
protected DateTime _persistedRegistered
Field Value
Type | Description |
---|---|
DateTime |
_persistedRegisteredAssociateId
Persisted value, see property RegisteredAssociateId.
Declaration
protected int _persistedRegisteredAssociateId
Field Value
Type | Description |
---|---|
Int32 |
_persistedUpdated
Persisted value, see property Updated.
Declaration
protected DateTime _persistedUpdated
Field Value
Type | Description |
---|---|
DateTime |
_persistedUpdatedAssociateId
Persisted value, see property UpdatedAssociateId.
Declaration
protected int _persistedUpdatedAssociateId
Field Value
Type | Description |
---|---|
Int32 |
_persistedUpdatedCount
Persisted value, see property UpdatedCount.
Declaration
protected short _persistedUpdatedCount
Field Value
Type | Description |
---|---|
Int16 |
_persistedUpdatePath
Persisted value, see property UpdatePath.
Declaration
protected string _persistedUpdatePath
Field Value
Type | Description |
---|---|
String |
_persistedVersion
Persisted value, see property Version.
Declaration
protected string _persistedVersion
Field Value
Type | Description |
---|---|
String |
Properties
CodeName
.NET type: string. The name of the code module, which is not the same as a license module
Declaration
public virtual string CodeName { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[255].
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
Comment
.NET type: string. Possible comment string added by code
Declaration
public virtual string Comment { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[255].
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. |
OwnerName
.NET type: string. Owner of code module
Declaration
public virtual string OwnerName { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[255].
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
ProductVersionId
.NET type: int. Primary key
Declaration
public virtual int ProductVersionId { 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
ProductVersionTableInfo
Get the ProductVersionTableInfo object associated with the row.
Declaration
public ProductVersionTableInfo ProductVersionTableInfo { get; }
Property Value
Type | Description |
---|---|
ProductVersionTableInfo |
Registered
.NET type: DateTime. Registered when in UTC
Declaration
public virtual DateTime Registered { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: UtcDateTime.
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
RegisteredAssociateId
.NET type: int. Registered by whom
Declaration
public virtual int RegisteredAssociateId { 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
TableInfo
Get the TableInfo for the table.
Declaration
public override TableInfo TableInfo { get; }
Property Value
Type | Description |
---|---|
TableInfo | The TableInfo for the table. |
Overrides
Updated
.NET type: DateTime. Last updated when in UTC
Declaration
public virtual DateTime Updated { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: UtcDateTime.
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
UpdatedAssociateId
.NET type: int. Last updated by whom
Declaration
public virtual int UpdatedAssociateId { 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
UpdatedCount
.NET type: short. Number of updates made to this record
Declaration
public virtual short UpdatedCount { get; set; }
Property Value
Type | Description |
---|---|
Int16 |
Remarks
Original type in dictionary: UShort.
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
UpdatePath
.NET type: string. Path MSI or other files, that contain the installation for this version; used for auto-update
Declaration
public virtual string UpdatePath { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[1024].
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
Version
.NET type: string. The version string, formatted as the code module would like to. Keybase will have to understand these strings if they are relevant to the licenses issued.
Declaration
public virtual string Version { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[255].
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 ProductVersionRow object. Version information for code modules. Owner + code module must be unique
Declaration
public static ProductVersionRow CreateNew()
Returns
Type | Description |
---|---|
ProductVersionRow | A new instance of the ProductVersionRow object. |
GetFromCustomSearch(ProductVersionRow.CustomSearch)
Create a new instance of the ProductVersionRow 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 ProductVersionRow GetFromCustomSearch(ProductVersionRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
ProductVersionRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
ProductVersionRow | A new instance of the ProductVersionRow object, reflecting the result of the query. |
GetFromIdxOwnerNameCodeNameVersion(String, String, String)
Create a new instance of the ProductVersionRow object, by querying the database table via the index 'IOwnerNameCodeNameVersion'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ProductVersionRow GetFromIdxOwnerNameCodeNameVersion(string ownerName, string codeName, string version)
Parameters
Type | Name | Description |
---|---|---|
String | ownerName | |
String | codeName | |
String | version |
Returns
Type | Description |
---|---|
ProductVersionRow | 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 ProductVersion table. Non-unique indexes have corresponding inner classes and methods in the ProductVersionRows collection, since they may return more than one row.
GetFromIdxProductVersionId(Int32)
Create a new instance of the ProductVersionRow object, by querying the database table via the index 'IDXProductVersionId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static ProductVersionRow GetFromIdxProductVersionId(int productVersionId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | productVersionId |
Returns
Type | Description |
---|---|
ProductVersionRow | 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 ProductVersion table. Non-unique indexes have corresponding inner classes and methods in the ProductVersionRows collection, since they may return more than one row.
GetFromReader(SoDataReader, ProductVersionTableInfo)
Create a new instance of the ProductVersionRow 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. Version information for code modules. Owner + code module must be unique
Declaration
public static ProductVersionRow GetFromReader(SoDataReader reader, ProductVersionTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
ProductVersionTableInfo | tableInfo | ProductVersionTableInfo 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 |
---|---|
ProductVersionRow | A new instance of the ProductVersionRow 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
_onCodeNameChange
Change envent for property CodeName; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onCodeNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onCommentChange
Change envent for property Comment; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onCommentChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onOwnerNameChange
Change envent for property OwnerName; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onOwnerNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onRegisteredAssociateIdChange
Change envent for property RegisteredAssociateId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onRegisteredAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onRegisteredChange
Change envent for property Registered; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onRegisteredChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onUpdatedAssociateIdChange
Change envent for property UpdatedAssociateId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onUpdatedAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onUpdatedChange
Change envent for property Updated; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onUpdatedChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onUpdatedCountChange
Change envent for property UpdatedCount; field is of .NET type short.
Declaration
protected event OnFieldChange<short> _onUpdatedCountChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
_onUpdatePathChange
Change envent for property UpdatePath; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onUpdatePathChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onVersionChange
Change envent for property Version; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onVersionChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnCodeNameChange
Event raised when CodeName is changing.
Declaration
public event OnFieldChange<string> OnCodeNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnCommentChange
Event raised when Comment is changing.
Declaration
public event OnFieldChange<string> OnCommentChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnOwnerNameChange
Event raised when OwnerName is changing.
Declaration
public event OnFieldChange<string> OnOwnerNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnRegisteredAssociateIdChange
Event raised when RegisteredAssociateId is changing.
Declaration
public event OnFieldChange<int> OnRegisteredAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnRegisteredChange
Event raised when Registered is changing.
Declaration
public event OnFieldChange<DateTime> OnRegisteredChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnUpdatedAssociateIdChange
Event raised when UpdatedAssociateId is changing.
Declaration
public event OnFieldChange<int> OnUpdatedAssociateIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnUpdatedChange
Event raised when Updated is changing.
Declaration
public event OnFieldChange<DateTime> OnUpdatedChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnUpdatedCountChange
Event raised when UpdatedCount is changing.
Declaration
public event OnFieldChange<short> OnUpdatedCountChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int16> |
OnUpdatePathChange
Event raised when UpdatePath is changing.
Declaration
public event OnFieldChange<string> OnUpdatePathChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnVersionChange
Event raised when Version is changing.
Declaration
public event OnFieldChange<string> OnVersionChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |