Class DocumentRow
Documents, this table is an extension of the Appointment table. There is always a corresponding appointment record; the relation between appointment and document is navigable in both directions. A document-type appointment record always has a corresponding document record and a record in VisibleFor specifying who may see this.
Row Object for table 'document'. 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 DocumentRow : 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) DocumentRow DocumentRow.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(DocumentRow.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 DocumentTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, DocumentTableInfo) 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 Document are:
Index fields | Nested index class name |
---|
Constructors
DocumentRow(DocumentRow.DocumentRowIdxBase)
Constructor for the class taking an index as argument. Documents, this table is an extension of the Appointment table. There is always a corresponding appointment record; the relation between appointment and document is navigable in both directions. A document-type appointment record always has a corresponding document record and a record in VisibleFor specifying who may see this.
Declaration
protected DocumentRow(DocumentRow.DocumentRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
DocumentRow.DocumentRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentApplicationId
Current value, see property ApplicationId.
Declaration
protected int _currentApplicationId
Field Value
Type | Description |
---|---|
Int32 |
_currentAppointmentId
Current value, see property AppointmentId.
Declaration
protected int _currentAppointmentId
Field Value
Type | Description |
---|---|
Int32 |
_currentArchiveProvider
Current value, see property ArchiveProvider.
Declaration
protected int _currentArchiveProvider
Field Value
Type | Description |
---|---|
Int32 |
_currentAttention
Current value, see property Attention.
Declaration
protected string _currentAttention
Field Value
Type | Description |
---|---|
String |
_currentDocumentId
Current value, see property DocumentId.
Declaration
protected int _currentDocumentId
Field Value
Type | Description |
---|---|
Int32 |
_currentExtref
Current value, see property Extref.
Declaration
protected string _currentExtref
Field Value
Type | Description |
---|---|
String |
_currentExtUrl
Current value, see property ExtUrl.
Declaration
protected string _currentExtUrl
Field Value
Type | Description |
---|---|
String |
_currentHeader
Current value, see property Header.
Declaration
protected string _currentHeader
Field Value
Type | Description |
---|---|
String |
_currentName
Current value, see property Name.
Declaration
protected string _currentName
Field Value
Type | Description |
---|---|
String |
_currentOurRef
Current value, see property OurRef.
Declaration
protected string _currentOurRef
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 |
_currentSearchname
Current value, see property Searchname.
Declaration
protected string _currentSearchname
Field Value
Type | Description |
---|---|
String |
_currentSnum
Current value, see property Snum.
Declaration
protected int _currentSnum
Field Value
Type | Description |
---|---|
Int32 |
_currentTextId
Current value, see property TextId.
Declaration
protected int _currentTextId
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 |
_currentUserdef2Id
Current value, see property Userdef2Id.
Declaration
protected int _currentUserdef2Id
Field Value
Type | Description |
---|---|
Int32 |
_currentUserdefId
Current value, see property UserdefId.
Declaration
protected int _currentUserdefId
Field Value
Type | Description |
---|---|
Int32 |
_currentYourRef
Current value, see property YourRef.
Declaration
protected string _currentYourRef
Field Value
Type | Description |
---|---|
String |
_persistedApplicationId
Persisted value, see property ApplicationId.
Declaration
protected int _persistedApplicationId
Field Value
Type | Description |
---|---|
Int32 |
_persistedAppointmentId
Persisted value, see property AppointmentId.
Declaration
protected int _persistedAppointmentId
Field Value
Type | Description |
---|---|
Int32 |
_persistedArchiveProvider
Persisted value, see property ArchiveProvider.
Declaration
protected int _persistedArchiveProvider
Field Value
Type | Description |
---|---|
Int32 |
_persistedAttention
Persisted value, see property Attention.
Declaration
protected string _persistedAttention
Field Value
Type | Description |
---|---|
String |
_persistedDocumentId
Persisted value, see property DocumentId.
Declaration
protected int _persistedDocumentId
Field Value
Type | Description |
---|---|
Int32 |
_persistedExtref
Persisted value, see property Extref.
Declaration
protected string _persistedExtref
Field Value
Type | Description |
---|---|
String |
_persistedExtUrl
Persisted value, see property ExtUrl.
Declaration
protected string _persistedExtUrl
Field Value
Type | Description |
---|---|
String |
_persistedHeader
Persisted value, see property Header.
Declaration
protected string _persistedHeader
Field Value
Type | Description |
---|---|
String |
_persistedName
Persisted value, see property Name.
Declaration
protected string _persistedName
Field Value
Type | Description |
---|---|
String |
_persistedOurRef
Persisted value, see property OurRef.
Declaration
protected string _persistedOurRef
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 |
_persistedSearchname
Persisted value, see property Searchname.
Declaration
protected string _persistedSearchname
Field Value
Type | Description |
---|---|
String |
_persistedSnum
Persisted value, see property Snum.
Declaration
protected int _persistedSnum
Field Value
Type | Description |
---|---|
Int32 |
_persistedTextId
Persisted value, see property TextId.
Declaration
protected int _persistedTextId
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 |
_persistedUserdef2Id
Persisted value, see property Userdef2Id.
Declaration
protected int _persistedUserdef2Id
Field Value
Type | Description |
---|---|
Int32 |
_persistedUserdefId
Persisted value, see property UserdefId.
Declaration
protected int _persistedUserdefId
Field Value
Type | Description |
---|---|
Int32 |
_persistedYourRef
Persisted value, see property YourRef.
Declaration
protected string _persistedYourRef
Field Value
Type | Description |
---|---|
String |
Properties
ApplicationId
.NET type: int. Application this document was made with
Declaration
public virtual int ApplicationId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
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 |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
AppointmentId
.NET type: int. points back to owning appointment
Declaration
public virtual int AppointmentId { 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
ArchiveProvider
.NET type: int. Document plugin id copied from the DocTmpl.autoevent_id - tells us where the document content is stored
Declaration
public virtual int ArchiveProvider { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: Id.
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 |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Attention
.NET type: string. Attention/salutation
Declaration
public virtual string Attention { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[100].
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 |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
DocumentId
.NET type: int. Primary key
Declaration
public virtual int DocumentId { 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
DocumentTableInfo
Get the DocumentTableInfo object associated with the row.
Declaration
public DocumentTableInfo DocumentTableInfo { get; }
Property Value
Type | Description |
---|---|
DocumentTableInfo |
Extref
.NET type: string. External reference (notes ID, email ID, URL, whatever) for use by document plugin in locating document content
Declaration
public virtual string Extref { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[512].
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 |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
ExtUrl
.NET type: string. For DocPlugin-internal use only. Used to optionally cache URL of external documents.
Declaration
public virtual string ExtUrl { 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
Header
.NET type: string. Visible document name
Declaration
public virtual string Header { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[220].
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 |
---|---|
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
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. |
LockSemantics
Document lock semantics; in version 6.3 this field is physically stored in the 'UpdatedCount' but will move in future versions
Declaration
public DocumentLockSemantics LockSemantics { get; set; }
Property Value
Type | Description |
---|---|
DocumentLockSemantics |
Name
.NET type: string. File name
Declaration
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[512].
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 |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
OurRef
.NET type: string. Our reference, searchable field from freetext search
Declaration
public virtual string OurRef { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[100].
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 |
---|---|
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.
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 |
---|---|
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.
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 |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Searchname
.NET type: string. Searchable name (not used?)
Declaration
public virtual string Searchname { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[100].
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 |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Snum
.NET type: int. The sequence number allocated from refcount on used template when creating the document
Declaration
public virtual int Snum { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: Int.
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
TextId
.NET type: int. Pointer to optional long description
Declaration
public virtual int TextId { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
Remarks
Original type in dictionary: FK.
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 |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
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.
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 |
---|---|
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.
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 |
---|---|
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.
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 |
---|---|
SoSentryException | Thrown if the set method is accessed without having the Write access right to the field |
Userdef2Id
.NET type: int. User-defined fields
Declaration
public virtual int Userdef2Id { 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
UserdefId
.NET type: int. User-defined fields
Declaration
public virtual int UserdefId { 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
YourRef
.NET type: string. Your reference
Declaration
public virtual string YourRef { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[100].
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 |
---|---|
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 DocumentRow object. Documents, this table is an extension of the Appointment table. There is always a corresponding appointment record; the relation between appointment and document is navigable in both directions. A document-type appointment record always has a corresponding document record and a record in VisibleFor specifying who may see this.
Declaration
public static DocumentRow CreateNew()
Returns
Type | Description |
---|---|
DocumentRow | A new instance of the DocumentRow object. |
GetFromCustomSearch(DocumentRow.CustomSearch)
Create a new instance of the DocumentRow 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 DocumentRow GetFromCustomSearch(DocumentRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
DocumentRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
DocumentRow | A new instance of the DocumentRow object, reflecting the result of the query. |
GetFromIdxDocumentId(Int32)
Create a new instance of the DocumentRow object, by querying the database table via the index 'IDXDocId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static DocumentRow GetFromIdxDocumentId(int documentId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | documentId |
Returns
Type | Description |
---|---|
DocumentRow | 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 Document table. Non-unique indexes have corresponding inner classes and methods in the DocumentRows collection, since they may return more than one row.
GetFromReader(SoDataReader, DocumentTableInfo)
Create a new instance of the DocumentRow 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. Documents, this table is an extension of the Appointment table. There is always a corresponding appointment record; the relation between appointment and document is navigable in both directions. A document-type appointment record always has a corresponding document record and a record in VisibleFor specifying who may see this.
Declaration
public static DocumentRow GetFromReader(SoDataReader reader, DocumentTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
DocumentTableInfo | tableInfo | DocumentTableInfo 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 |
---|---|
DocumentRow | A new instance of the DocumentRow 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
_onApplicationIdChange
Change envent for property ApplicationId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onApplicationIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onAppointmentIdChange
Change envent for property AppointmentId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onAppointmentIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onArchiveProviderChange
Change envent for property ArchiveProvider; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onArchiveProviderChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onAttentionChange
Change envent for property Attention; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onAttentionChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onExtrefChange
Change envent for property Extref; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onExtrefChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onExtUrlChange
Change envent for property ExtUrl; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onExtUrlChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onHeaderChange
Change envent for property Header; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onNameChange
Change envent for property Name; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onOurRefChange
Change envent for property OurRef; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onOurRefChange
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> |
_onSearchnameChange
Change envent for property Searchname; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onSearchnameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onSnumChange
Change envent for property Snum; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onSnumChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onTextIdChange
Change envent for property TextId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onTextIdChange
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> |
_onUserdef2IdChange
Change envent for property Userdef2Id; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onUserdef2IdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onUserdefIdChange
Change envent for property UserdefId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onUserdefIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onYourRefChange
Change envent for property YourRef; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onYourRefChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnApplicationIdChange
Event raised when ApplicationId is changing.
Declaration
public event OnFieldChange<int> OnApplicationIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnAppointmentIdChange
Event raised when AppointmentId is changing.
Declaration
public event OnFieldChange<int> OnAppointmentIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnArchiveProviderChange
Event raised when ArchiveProvider is changing.
Declaration
public event OnFieldChange<int> OnArchiveProviderChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnAttentionChange
Event raised when Attention is changing.
Declaration
public event OnFieldChange<string> OnAttentionChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnExtrefChange
Event raised when Extref is changing.
Declaration
public event OnFieldChange<string> OnExtrefChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnExtUrlChange
Event raised when ExtUrl is changing.
Declaration
public event OnFieldChange<string> OnExtUrlChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnHeaderChange
Event raised when Header is changing.
Declaration
public event OnFieldChange<string> OnHeaderChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnNameChange
Event raised when Name is changing.
Declaration
public event OnFieldChange<string> OnNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnOurRefChange
Event raised when OurRef is changing.
Declaration
public event OnFieldChange<string> OnOurRefChange
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> |
OnSearchnameChange
Event raised when Searchname is changing.
Declaration
public event OnFieldChange<string> OnSearchnameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnSnumChange
Event raised when Snum is changing.
Declaration
public event OnFieldChange<int> OnSnumChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnTextIdChange
Event raised when TextId is changing.
Declaration
public event OnFieldChange<int> OnTextIdChange
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> |
OnUserdef2IdChange
Event raised when Userdef2Id is changing.
Declaration
public event OnFieldChange<int> OnUserdef2IdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnUserdefIdChange
Event raised when UserdefId is changing.
Declaration
public event OnFieldChange<int> OnUserdefIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnYourRefChange
Event raised when YourRef is changing.
Declaration
public event OnFieldChange<string> OnYourRefChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |