Class SORPublishRow

SuperOffice reporter data
Row Object for table 'SORPublish'. 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

SORPublishRow

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

Unique indexes on table SORPublish are:

Index fields	Nested index class name

Constructors

SORPublishRow(SORPublishRow.SORPublishRowIdxBase)

Constructor for the class taking an index as argument. SuperOffice reporter data

Declaration

protected SORPublishRow(SORPublishRow.SORPublishRowIdxBase idx)

Parameters

Type	Name	Description
SORPublishRow.SORPublishRowIdxBase	idx	The index representing a SELECT command to the database.

Fields

_currentAssociateId

Current value, see property AssociateId.

Declaration

protected int _currentAssociateId

Field Value

Type	Description
Int32

_currentCCount

Current value, see property CCount.

Declaration

protected short _currentCCount

Field Value

Type	Description
Int16

_currentDefaultLabelLayout

Current value, see property DefaultLabelLayout.

Declaration

protected int _currentDefaultLabelLayout

Field Value

Type	Description
Int32

_currentDescription

Current value, see property Description.

Declaration

protected string _currentDescription

Field Value

Type	Description
String

_currentDescriptionResId

Current value, see property DescriptionResId.

Declaration

protected uint _currentDescriptionResId

Field Value

Type	Description
UInt32

_currentForceDefault

Current value, see property ForceDefault.

Declaration

protected short _currentForceDefault

Field Value

Type	Description
Int16

_currentIsBuiltIn

Current value, see property IsBuiltIn.

Declaration

protected short _currentIsBuiltIn

Field Value

Type	Description
Int16

_currentIsEdited

Current value, see property IsEdited.

Declaration

protected short _currentIsEdited

Field Value

Type	Description
Int16

_currentName

Current value, see property Name.

Declaration

protected string _currentName

Field Value

Type	Description
String

_currentNameResId

Current value, see property NameResId.

Declaration

protected uint _currentNameResId

Field Value

Type	Description
UInt32

_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

_currentSORPublishId

Current value, see property SORPublishId.

Declaration

protected int _currentSORPublishId

Field Value

Type	Description
Int32

_currentSORTemplateId

Current value, see property SORTemplateId.

Declaration

protected int _currentSORTemplateId

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

_persistedAssociateId

Persisted value, see property AssociateId.

Declaration

protected int _persistedAssociateId

Field Value

Type	Description
Int32

_persistedCCount

Persisted value, see property CCount.

Declaration

protected short _persistedCCount

Field Value

Type	Description
Int16

_persistedDefaultLabelLayout

Persisted value, see property DefaultLabelLayout.

Declaration

protected int _persistedDefaultLabelLayout

Field Value

Type	Description
Int32

_persistedDescription

Persisted value, see property Description.

Declaration

protected string _persistedDescription

Field Value

Type	Description
String

_persistedDescriptionResId

Persisted value, see property DescriptionResId.

Declaration

protected uint _persistedDescriptionResId

Field Value

Type	Description
UInt32

_persistedForceDefault

Persisted value, see property ForceDefault.

Declaration

protected short _persistedForceDefault

Field Value

Type	Description
Int16

_persistedIsBuiltIn

Persisted value, see property IsBuiltIn.

Declaration

protected short _persistedIsBuiltIn

Field Value

Type	Description
Int16

_persistedIsEdited

Persisted value, see property IsEdited.

Declaration

protected short _persistedIsEdited

Field Value

Type	Description
Int16

_persistedName

Persisted value, see property Name.

Declaration

protected string _persistedName

Field Value

Type	Description
String

_persistedNameResId

Persisted value, see property NameResId.

Declaration

protected uint _persistedNameResId

Field Value

Type	Description
UInt32

_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

_persistedSORPublishId

Persisted value, see property SORPublishId.

Declaration

protected int _persistedSORPublishId

Field Value

Type	Description
Int32

_persistedSORTemplateId

Persisted value, see property SORTemplateId.

Declaration

protected int _persistedSORTemplateId

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

Properties

AssociateId

.NET type: int. Owner id; 0=SO standard template; 0xFFFFFFFF=owner is Template User (?)

Declaration

public virtual int AssociateId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

CCount

.NET type: short. Label template: column count; Calendar Week: work start hour; otherwise unused (0)

Declaration

public virtual short CCount { get; set; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

DefaultLabelLayout

.NET type: int. Default template ID

Declaration

public virtual int DefaultLabelLayout { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Description

.NET type: string. Description text (long)

Declaration

public virtual string Description { get; set; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[2048].

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

DescriptionResId

.NET type: uint. ResId of description if translatable text

Declaration

public virtual uint DescriptionResId { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((UInt32)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

ForceDefault

.NET type: short. Don't ask the user if there is a default, just use it

Declaration

public virtual short ForceDefault { get; set; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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

IsBuiltIn

.NET type: short. Is this row a Standard Report? (reset to 0 if report is edited)

Declaration

public virtual short IsBuiltIn { get; set; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: UShort.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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

IsEdited

.NET type: short. Has this (standard) report been edited? This is nice to know during the next upgrade, to avoid trampling on customizations

Declaration

public virtual short IsEdited { get; set; }

Property Value

Type	Description
Int16

Remarks

Original type in dictionary: Bool.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Name

.NET type: string. Template name

Declaration

public virtual string Name { get; set; }

Property Value

Type	Description
String

Remarks

Original type in dictionary: String[240].

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (string.Empty)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

NameResId

.NET type: uint. Resource ID for translatable tempalte names; otherwise 0

Declaration

public virtual uint NameResId { get; set; }

Property Value

Type	Description
UInt32

Remarks

Original type in dictionary: UInt.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((UInt32)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

SORPublishId

.NET type: int. Primary key

Declaration

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

Read only for code not signed by SuperOffice.

This field is not protected by the Sentry system, and can always be read

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.

SORPublishTableInfo

Get the SORPublishTableInfo object associated with the row.

Declaration

public SORPublishTableInfo SORPublishTableInfo { get; }

Property Value

Type	Description
SORPublishTableInfo

SORTemplateId

.NET type: int. Owning template

Declaration

public virtual int SORTemplateId { get; set; }

Property Value

Type	Description
Int32

Remarks

Original type in dictionary: FK.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (DateTime.MinValue)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value (0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

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.

Read only for code not signed by SuperOffice.

You need to have Read access to get the value of this field. If you do not have access, you will get a blank value ((Int16)0)

You need to have Write access to set this field to a new value (Sentry will throw exception otherwise)

Setting this field to a new value will not affect the Sentry calculations and your rights

Exceptions

Type	Condition
SecurityException	Thrown if the set method is accessed by code not signed by SuperOffice.
SoSentryException	Thrown if the set method is accessed without having the Write access right to the field

Methods

CreateNew()

Create a new instance of the SORPublishRow object. SuperOffice reporter data

Declaration

public static SORPublishRow CreateNew()

Returns

Type	Description
SORPublishRow	A new instance of the SORPublishRow object.

GetFromCustomSearch(SORPublishRow.CustomSearch)

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

Parameters

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

Returns

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

GetFromIdxSORPublishId(Int32)

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

Declaration

public static SORPublishRow GetFromIdxSORPublishId(int sORPublishId)

Parameters

Type	Name	Description
Int32	sORPublishId

Returns

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

GetFromReader(SoDataReader, SORPublishTableInfo)

Create a new instance of the SORPublishRow 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. SuperOffice reporter data

Declaration

public static SORPublishRow GetFromReader(SoDataReader reader, SORPublishTableInfo tableInfo)

Parameters

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

_onAssociateIdChange

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

Declaration

protected event OnFieldChange<int> _onAssociateIdChange

Event Type

Type	Description
OnFieldChange<Int32>

_onCCountChange

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

Declaration

protected event OnFieldChange<short> _onCCountChange

Event Type

Type	Description
OnFieldChange<Int16>

_onDefaultLabelLayoutChange

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

Declaration

protected event OnFieldChange<int> _onDefaultLabelLayoutChange

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>

_onDescriptionResIdChange

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

Declaration

protected event OnFieldChange<uint> _onDescriptionResIdChange

Event Type

Type	Description
OnFieldChange<UInt32>

_onForceDefaultChange

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

Declaration

protected event OnFieldChange<short> _onForceDefaultChange

Event Type

Type	Description
OnFieldChange<Int16>

_onIsBuiltInChange

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

Declaration

protected event OnFieldChange<short> _onIsBuiltInChange

Event Type

Type	Description
OnFieldChange<Int16>

_onIsEditedChange

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

Declaration

protected event OnFieldChange<short> _onIsEditedChange

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>

_onNameResIdChange

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

Declaration

protected event OnFieldChange<uint> _onNameResIdChange

Event Type

Type	Description
OnFieldChange<UInt32>

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

_onSORTemplateIdChange

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

Declaration

protected event OnFieldChange<int> _onSORTemplateIdChange

Event Type

Type	Description
OnFieldChange<Int32>

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

OnAssociateIdChange

Event raised when AssociateId is changing.

Declaration

public event OnFieldChange<int> OnAssociateIdChange

Event Type

Type	Description
OnFieldChange<Int32>

OnCCountChange

Event raised when CCount is changing.

Declaration

public event OnFieldChange<short> OnCCountChange

Event Type

Type	Description
OnFieldChange<Int16>

OnDefaultLabelLayoutChange

Event raised when DefaultLabelLayout is changing.

Declaration

public event OnFieldChange<int> OnDefaultLabelLayoutChange

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>

OnDescriptionResIdChange

Event raised when DescriptionResId is changing.

Declaration

public event OnFieldChange<uint> OnDescriptionResIdChange

Event Type

Type	Description
OnFieldChange<UInt32>

OnForceDefaultChange

Event raised when ForceDefault is changing.

Declaration

public event OnFieldChange<short> OnForceDefaultChange

Event Type

Type	Description
OnFieldChange<Int16>

OnIsBuiltInChange

Event raised when IsBuiltIn is changing.

Declaration

public event OnFieldChange<short> OnIsBuiltInChange

Event Type

Type	Description
OnFieldChange<Int16>

OnIsEditedChange

Event raised when IsEdited is changing.

Declaration

public event OnFieldChange<short> OnIsEditedChange

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>

OnNameResIdChange

Event raised when NameResId is changing.

Declaration

public event OnFieldChange<uint> OnNameResIdChange

Event Type

Type	Description
OnFieldChange<UInt32>

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>

OnSORTemplateIdChange

Event raised when SORTemplateId is changing.

Declaration

public event OnFieldChange<int> OnSORTemplateIdChange

Event Type

Type	Description
OnFieldChange<Int32>

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

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)