Class ModuleLicenseRow

Module licenses, belonging to one single owner
Row Object for table 'ModuleLicense'. 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
ModuleLicenseRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class ModuleLicenseRow : 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) ModuleLicenseRow ModuleLicenseRow.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(ModuleLicenseRow.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 ModuleLicenseTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, ModuleLicenseTableInfo) 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 ModuleLicenseRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, ModuleLicenseTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table ModuleLicense are:

Index fieldsNested index class name

Constructors

ModuleLicenseRow(ModuleLicenseRow.ModuleLicenseRowIdxBase)

Constructor for the class taking an index as argument. Module licenses, belonging to one single owner

Declaration
protected ModuleLicenseRow(ModuleLicenseRow.ModuleLicenseRowIdxBase idx)
Parameters
Type Name Description
ModuleLicenseRow.ModuleLicenseRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentAllowedAssocsMask

Current value, see property AllowedAssocsMask.

Declaration
protected uint _currentAllowedAssocsMask
Field Value
Type Description
UInt32

_currentEncryptedCheck

Current value, see property EncryptedCheck.

Declaration
protected string _currentEncryptedCheck
Field Value
Type Description
String

_currentExtraFlags

Current value, see property ExtraFlags.

Declaration
protected uint _currentExtraFlags
Field Value
Type Description
UInt32

_currentExtraInfo

Current value, see property ExtraInfo.

Declaration
protected string _currentExtraInfo
Field Value
Type Description
String

_currentHidden

Current value, see property Hidden.

Declaration
protected short _currentHidden
Field Value
Type Description
Int16

_currentLicenseNumber

Current value, see property LicenseNumber.

Declaration
protected uint _currentLicenseNumber
Field Value
Type Description
UInt32

_currentLicenseType

Current value, see property LicenseType.

Declaration
protected LicenseType _currentLicenseType
Field Value
Type Description
SuperOffice.License.LicenseType

_currentModuleDescription

Current value, see property ModuleDescription.

Declaration
protected string _currentModuleDescription
Field Value
Type Description
String

_currentModuleLicenseId

Current value, see property ModuleLicenseId.

Declaration
protected int _currentModuleLicenseId
Field Value
Type Description
Int32

_currentModuleName

Current value, see property ModuleName.

Declaration
protected string _currentModuleName
Field Value
Type Description
String

_currentModuleOwnerId

Current value, see property ModuleOwnerId.

Declaration
protected int _currentModuleOwnerId
Field Value
Type Description
Int32

_currentModuleVersion

Current value, see property ModuleVersion.

Declaration
protected string _currentModuleVersion
Field Value
Type Description
String

_currentPrerequisiteModule

Current value, see property PrerequisiteModule.

Declaration
protected string _currentPrerequisiteModule
Field Value
Type Description
String

_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

_currentSignature

Current value, see property Signature.

Declaration
protected string _currentSignature
Field Value
Type Description
String

_currentSortOrder

Current value, see property SortOrder.

Declaration
protected int _currentSortOrder
Field Value
Type Description
Int32

_currentTooltip

Current value, see property Tooltip.

Declaration
protected string _currentTooltip
Field Value
Type Description
String

_currentUnrestricted

Current value, see property Unrestricted.

Declaration
protected short _currentUnrestricted
Field Value
Type Description
Int16

_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

_persistedAllowedAssocsMask

Persisted value, see property AllowedAssocsMask.

Declaration
protected uint _persistedAllowedAssocsMask
Field Value
Type Description
UInt32

_persistedEncryptedCheck

Persisted value, see property EncryptedCheck.

Declaration
protected string _persistedEncryptedCheck
Field Value
Type Description
String

_persistedExtraFlags

Persisted value, see property ExtraFlags.

Declaration
protected uint _persistedExtraFlags
Field Value
Type Description
UInt32

_persistedExtraInfo

Persisted value, see property ExtraInfo.

Declaration
protected string _persistedExtraInfo
Field Value
Type Description
String

_persistedHidden

Persisted value, see property Hidden.

Declaration
protected short _persistedHidden
Field Value
Type Description
Int16

_persistedLicenseNumber

Persisted value, see property LicenseNumber.

Declaration
protected uint _persistedLicenseNumber
Field Value
Type Description
UInt32

_persistedLicenseType

Persisted value, see property LicenseType.

Declaration
protected LicenseType _persistedLicenseType
Field Value
Type Description
SuperOffice.License.LicenseType

_persistedModuleDescription

Persisted value, see property ModuleDescription.

Declaration
protected string _persistedModuleDescription
Field Value
Type Description
String

_persistedModuleLicenseId

Persisted value, see property ModuleLicenseId.

Declaration
protected int _persistedModuleLicenseId
Field Value
Type Description
Int32

_persistedModuleName

Persisted value, see property ModuleName.

Declaration
protected string _persistedModuleName
Field Value
Type Description
String

_persistedModuleOwnerId

Persisted value, see property ModuleOwnerId.

Declaration
protected int _persistedModuleOwnerId
Field Value
Type Description
Int32

_persistedModuleVersion

Persisted value, see property ModuleVersion.

Declaration
protected string _persistedModuleVersion
Field Value
Type Description
String

_persistedPrerequisiteModule

Persisted value, see property PrerequisiteModule.

Declaration
protected string _persistedPrerequisiteModule
Field Value
Type Description
String

_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

_persistedSignature

Persisted value, see property Signature.

Declaration
protected string _persistedSignature
Field Value
Type Description
String

_persistedSortOrder

Persisted value, see property SortOrder.

Declaration
protected int _persistedSortOrder
Field Value
Type Description
Int32

_persistedTooltip

Persisted value, see property Tooltip.

Declaration
protected string _persistedTooltip
Field Value
Type Description
String

_persistedUnrestricted

Persisted value, see property Unrestricted.

Declaration
protected short _persistedUnrestricted
Field Value
Type Description
Int16

_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

Properties

AllowedAssocsMask

.NET type: uint. Bitmask of allowed associate types who can have this kind of license

Declaration
public virtual uint AllowedAssocsMask { get; set; }
Property Value
Type Description
UInt32
Remarks

Original type in dictionary: UInt.

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

EncryptedCheck

.NET type: string. Encrypted checksum that stops tampering and copying between databases

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

ExtraFlags

.NET type: uint. Unspecified extra flags of license, part of checksum. Value=1 means this a 'user plan'; such licenses cause the admin gui to switch to radiobutton view

Declaration
public virtual uint ExtraFlags { get; set; }
Property Value
Type Description
UInt32
Remarks

Original type in dictionary: UInt.

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

ExtraInfo

.NET type: string. Free field, can be used by the module owner (example: host domain, for eJournal). NOTE: For rows with extraFlags=1 this field contains the list of modules that this plan comprises

Declaration
public virtual string ExtraInfo { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[4000].

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

Hidden

.NET type: short. If true, then this module should not appear in GUI and is not assignable by users

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

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.

LicenseNumber

.NET type: uint. Number of systems, databases or associates licensed

Declaration
public virtual uint LicenseNumber { get; set; }
Property Value
Type Description
UInt32
Remarks

Original type in dictionary: UInt.

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

LicenseType

.NET type: LicenseType. Entire system, per database, or per associate

Declaration
public virtual LicenseType LicenseType { get; set; }
Property Value
Type Description
SuperOffice.License.LicenseType
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

ModuleDescription

.NET type: string. Human-readable description of module, shown in GUI, default language. Additional languages can be added to LocaleText, resource type 25

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

ModuleLicenseId

.NET type: int. Primary key

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

ModuleLicenseTableInfo

Get the ModuleLicenseTableInfo object associated with the row.

Declaration
public ModuleLicenseTableInfo ModuleLicenseTableInfo { get; }
Property Value
Type Description
ModuleLicenseTableInfo

ModuleName

.NET type: string. The name of the module, not visible in GUI but used in the code. This must be in UPPER CASE and only contain A-Z and 0-9. NO EXTENDED CHARACTERS please.

Declaration
public virtual string ModuleName { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[240].

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

ModuleOwnerId

.NET type: int. Link to owner of this module

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

ModuleVersion

.NET type: string. Version string for this module

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

PrerequisiteModule

.NET type: string. If set, specifies a module license needed before this license can be granted

Declaration
public virtual string PrerequisiteModule { get; set; }
Property Value
Type Description
String
Remarks

Original type in dictionary: String[240].

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

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

Signature

.NET type: string. Signature that verifies that this row is correctly transferred from SuperLicense

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

SortOrder

.NET type: int. Ordering value - generated by SuperLicense and transferred here. Must be followed for signatures to be correct

Declaration
public virtual int SortOrder { get; set; }
Property Value
Type Description
Int32
Remarks

Original type in dictionary: Id.

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

Tooltip

.NET type: string. Tooltip text, anything you want; shown when the cursor hovers over the line in the GUI. Default language. Additional languages can be added to LocaleText, resource type 27

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

Unrestricted

.NET type: short. If true, then there is no licenseNumber limit on how many of these modules may be assigned

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

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

Methods

CreateNew()

Create a new instance of the ModuleLicenseRow object. Module licenses, belonging to one single owner

Declaration
public static ModuleLicenseRow CreateNew()
Returns
Type Description
ModuleLicenseRow

A new instance of the ModuleLicenseRow object.

GetFromCustomSearch(ModuleLicenseRow.CustomSearch)

Create a new instance of the ModuleLicenseRow 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 ModuleLicenseRow GetFromCustomSearch(ModuleLicenseRow.CustomSearch query)
Parameters
Type Name Description
ModuleLicenseRow.CustomSearch query

The custom search to execute against the database
Returns
Type Description
ModuleLicenseRow

A new instance of the ModuleLicenseRow object, reflecting the result of the query.

GetFromIdxModuleLicenseId(Int32)

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

Declaration
public static ModuleLicenseRow GetFromIdxModuleLicenseId(int moduleLicenseId)
Parameters
Type Name Description
Int32 moduleLicenseId
Returns
Type Description
ModuleLicenseRow

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

GetFromIdxModuleNameModuleVersionModuleOwnerId(String, String, Int32)

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

Declaration
public static ModuleLicenseRow GetFromIdxModuleNameModuleVersionModuleOwnerId(string moduleName, string moduleVersion, int moduleOwnerId)
Parameters
Type Name Description
String moduleName
String moduleVersion
Int32 moduleOwnerId
Returns
Type Description
ModuleLicenseRow

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

GetFromReader(SoDataReader, ModuleLicenseTableInfo)

Create a new instance of the ModuleLicenseRow 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. Module licenses, belonging to one single owner

Declaration
public static ModuleLicenseRow GetFromReader(SoDataReader reader, ModuleLicenseTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
ModuleLicenseTableInfo tableInfo

ModuleLicenseTableInfo 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
ModuleLicenseRow

A new instance of the ModuleLicenseRow 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

_onAllowedAssocsMaskChange

Change envent for property AllowedAssocsMask; field is of .NET type uint.

Declaration
protected event OnFieldChange<uint> _onAllowedAssocsMaskChange
Event Type
Type Description
OnFieldChange<UInt32>

_onEncryptedCheckChange

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

Declaration
protected event OnFieldChange<string> _onEncryptedCheckChange
Event Type
Type Description
OnFieldChange<String>

_onExtraFlagsChange

Change envent for property ExtraFlags; field is of .NET type uint.

Declaration
protected event OnFieldChange<uint> _onExtraFlagsChange
Event Type
Type Description
OnFieldChange<UInt32>

_onExtraInfoChange

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

Declaration
protected event OnFieldChange<string> _onExtraInfoChange
Event Type
Type Description
OnFieldChange<String>

_onHiddenChange

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

Declaration
protected event OnFieldChange<short> _onHiddenChange
Event Type
Type Description
OnFieldChange<Int16>

_onLicenseNumberChange

Change envent for property LicenseNumber; field is of .NET type uint.

Declaration
protected event OnFieldChange<uint> _onLicenseNumberChange
Event Type
Type Description
OnFieldChange<UInt32>

_onLicenseTypeChange

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

Declaration
protected event OnFieldChange<LicenseType> _onLicenseTypeChange
Event Type
Type Description
OnFieldChange<SuperOffice.License.LicenseType>

_onModuleDescriptionChange

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

Declaration
protected event OnFieldChange<string> _onModuleDescriptionChange
Event Type
Type Description
OnFieldChange<String>

_onModuleNameChange

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

Declaration
protected event OnFieldChange<string> _onModuleNameChange
Event Type
Type Description
OnFieldChange<String>

_onModuleOwnerIdChange

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

Declaration
protected event OnFieldChange<int> _onModuleOwnerIdChange
Event Type
Type Description
OnFieldChange<Int32>

_onModuleVersionChange

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

Declaration
protected event OnFieldChange<string> _onModuleVersionChange
Event Type
Type Description
OnFieldChange<String>

_onPrerequisiteModuleChange

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

Declaration
protected event OnFieldChange<string> _onPrerequisiteModuleChange
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>

_onSignatureChange

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

Declaration
protected event OnFieldChange<string> _onSignatureChange
Event Type
Type Description
OnFieldChange<String>

_onSortOrderChange

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

Declaration
protected event OnFieldChange<int> _onSortOrderChange
Event Type
Type Description
OnFieldChange<Int32>

_onTooltipChange

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

Declaration
protected event OnFieldChange<string> _onTooltipChange
Event Type
Type Description
OnFieldChange<String>

_onUnrestrictedChange

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

Declaration
protected event OnFieldChange<short> _onUnrestrictedChange
Event Type
Type Description
OnFieldChange<Int16>

_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>

OnAllowedAssocsMaskChange

Event raised when AllowedAssocsMask is changing.

Declaration
public event OnFieldChange<uint> OnAllowedAssocsMaskChange
Event Type
Type Description
OnFieldChange<UInt32>

OnEncryptedCheckChange

Event raised when EncryptedCheck is changing.

Declaration
public event OnFieldChange<string> OnEncryptedCheckChange
Event Type
Type Description
OnFieldChange<String>

OnExtraFlagsChange

Event raised when ExtraFlags is changing.

Declaration
public event OnFieldChange<uint> OnExtraFlagsChange
Event Type
Type Description
OnFieldChange<UInt32>

OnExtraInfoChange

Event raised when ExtraInfo is changing.

Declaration
public event OnFieldChange<string> OnExtraInfoChange
Event Type
Type Description
OnFieldChange<String>

OnHiddenChange

Event raised when Hidden is changing.

Declaration
public event OnFieldChange<short> OnHiddenChange
Event Type
Type Description
OnFieldChange<Int16>

OnLicenseNumberChange

Event raised when LicenseNumber is changing.

Declaration
public event OnFieldChange<uint> OnLicenseNumberChange
Event Type
Type Description
OnFieldChange<UInt32>

OnLicenseTypeChange

Event raised when LicenseType is changing.

Declaration
public event OnFieldChange<LicenseType> OnLicenseTypeChange
Event Type
Type Description
OnFieldChange<SuperOffice.License.LicenseType>

OnModuleDescriptionChange

Event raised when ModuleDescription is changing.

Declaration
public event OnFieldChange<string> OnModuleDescriptionChange
Event Type
Type Description
OnFieldChange<String>

OnModuleNameChange

Event raised when ModuleName is changing.

Declaration
public event OnFieldChange<string> OnModuleNameChange
Event Type
Type Description
OnFieldChange<String>

OnModuleOwnerIdChange

Event raised when ModuleOwnerId is changing.

Declaration
public event OnFieldChange<int> OnModuleOwnerIdChange
Event Type
Type Description
OnFieldChange<Int32>

OnModuleVersionChange

Event raised when ModuleVersion is changing.

Declaration
public event OnFieldChange<string> OnModuleVersionChange
Event Type
Type Description
OnFieldChange<String>

OnPrerequisiteModuleChange

Event raised when PrerequisiteModule is changing.

Declaration
public event OnFieldChange<string> OnPrerequisiteModuleChange
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>

OnSignatureChange

Event raised when Signature is changing.

Declaration
public event OnFieldChange<string> OnSignatureChange
Event Type
Type Description
OnFieldChange<String>

OnSortOrderChange

Event raised when SortOrder is changing.

Declaration
public event OnFieldChange<int> OnSortOrderChange
Event Type
Type Description
OnFieldChange<Int32>

OnTooltipChange

Event raised when Tooltip is changing.

Declaration
public event OnFieldChange<string> OnTooltipChange
Event Type
Type Description
OnFieldChange<String>

OnUnrestrictedChange

Event raised when Unrestricted is changing.

Declaration
public event OnFieldChange<short> OnUnrestrictedChange
Event Type
Type Description
OnFieldChange<Int16>

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>

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)