Class AttachmentRow
This table contains metadata for attachments. The actual attachments are stored directly on disk, with filenames based on the the primary key for this table.
Row Object for table 'attachment'. 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 AttachmentRow : 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) AttachmentRow AttachmentRow.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(AttachmentRow.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 AttachmentTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, AttachmentTableInfo) 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 Attachment are:
Index fields | Nested index class name |
---|
Constructors
AttachmentRow(AttachmentRow.AttachmentRowIdxBase)
Constructor for the class taking an index as argument. This table contains metadata for attachments. The actual attachments are stored directly on disk, with filenames based on the the primary key for this table.
Declaration
protected AttachmentRow(AttachmentRow.AttachmentRowIdxBase idx)
Parameters
Type | Name | Description |
---|---|---|
AttachmentRow.AttachmentRowIdxBase | idx | The index representing a SELECT command to the database. |
Fields
_currentAttachmentId
Current value, see property AttachmentId.
Declaration
protected int _currentAttachmentId
Field Value
Type | Description |
---|---|
Int32 |
_currentAttachmentLocationId
Current value, see property AttachmentLocationId.
Declaration
protected int _currentAttachmentLocationId
Field Value
Type | Description |
---|---|
Int32 |
_currentAttSize
Current value, see property AttSize.
Declaration
protected int _currentAttSize
Field Value
Type | Description |
---|---|
Int32 |
_currentAuthKey
Current value, see property AuthKey.
Declaration
protected string _currentAuthKey
Field Value
Type | Description |
---|---|
String |
_currentCharset
Current value, see property Charset.
Declaration
protected string _currentCharset
Field Value
Type | Description |
---|---|
String |
_currentContentType
Current value, see property ContentType.
Declaration
protected string _currentContentType
Field Value
Type | Description |
---|---|
String |
_currentDbiAgentId
Current value, see property DbiAgentId.
Declaration
protected int _currentDbiAgentId
Field Value
Type | Description |
---|---|
Int32 |
_currentDbiKey
Current value, see property DbiKey.
Declaration
protected string _currentDbiKey
Field Value
Type | Description |
---|---|
String |
_currentDbiLastModified
Current value, see property DbiLastModified.
Declaration
protected DateTime _currentDbiLastModified
Field Value
Type | Description |
---|---|
DateTime |
_currentDbiLastSyncronized
Current value, see property DbiLastSyncronized.
Declaration
protected DateTime _currentDbiLastSyncronized
Field Value
Type | Description |
---|---|
DateTime |
_currentName
Current value, see property Name.
Declaration
protected string _currentName
Field Value
Type | Description |
---|---|
String |
_persistedAttachmentId
Persisted value, see property AttachmentId.
Declaration
protected int _persistedAttachmentId
Field Value
Type | Description |
---|---|
Int32 |
_persistedAttachmentLocationId
Persisted value, see property AttachmentLocationId.
Declaration
protected int _persistedAttachmentLocationId
Field Value
Type | Description |
---|---|
Int32 |
_persistedAttSize
Persisted value, see property AttSize.
Declaration
protected int _persistedAttSize
Field Value
Type | Description |
---|---|
Int32 |
_persistedAuthKey
Persisted value, see property AuthKey.
Declaration
protected string _persistedAuthKey
Field Value
Type | Description |
---|---|
String |
_persistedCharset
Persisted value, see property Charset.
Declaration
protected string _persistedCharset
Field Value
Type | Description |
---|---|
String |
_persistedContentType
Persisted value, see property ContentType.
Declaration
protected string _persistedContentType
Field Value
Type | Description |
---|---|
String |
_persistedDbiAgentId
Persisted value, see property DbiAgentId.
Declaration
protected int _persistedDbiAgentId
Field Value
Type | Description |
---|---|
Int32 |
_persistedDbiKey
Persisted value, see property DbiKey.
Declaration
protected string _persistedDbiKey
Field Value
Type | Description |
---|---|
String |
_persistedDbiLastModified
Persisted value, see property DbiLastModified.
Declaration
protected DateTime _persistedDbiLastModified
Field Value
Type | Description |
---|---|
DateTime |
_persistedDbiLastSyncronized
Persisted value, see property DbiLastSyncronized.
Declaration
protected DateTime _persistedDbiLastSyncronized
Field Value
Type | Description |
---|---|
DateTime |
_persistedName
Persisted value, see property Name.
Declaration
protected string _persistedName
Field Value
Type | Description |
---|---|
String |
Properties
AttachmentId
.NET type: int. The primary key (auto-incremented)
Declaration
public virtual int AttachmentId { 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
AttachmentLocationId
.NET type: int. The id of the attachment_location this attachment is stored in
Declaration
public virtual int AttachmentLocationId { 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
AttachmentTableInfo
Get the AttachmentTableInfo object associated with the row.
Declaration
public AttachmentTableInfo AttachmentTableInfo { get; }
Property Value
Type | Description |
---|---|
AttachmentTableInfo |
AttSize
.NET type: int. The size (in bytes) for the attachment.
Declaration
public virtual int AttSize { 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
AuthKey
.NET type: string. The key used for authenticating access to this attachment.
Declaration
public virtual string AuthKey { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
Charset
.NET type: string. The charset if this is a text attachment
Declaration
public virtual string Charset { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
ContentType
.NET type: string. The content type for the attachment (e.g. 'applaction/octet-stream' or 'application/vnd.openxmlformats-officedocument.wordprocessingml.document').
Declaration
public virtual string ContentType { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
DbiAgentId
.NET type: int. Integration agent (eJournal)
Declaration
public virtual int DbiAgentId { 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
DbiKey
.NET type: string. The primary key for the integrated entry in the external datasource.
Declaration
public virtual string DbiKey { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
DbiLastModified
.NET type: DateTime. When the entry was last modified.
Declaration
public virtual DateTime DbiLastModified { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: DateTime.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
DbiLastSyncronized
.NET type: DateTime. Last external syncronization.
Declaration
public virtual DateTime DbiLastSyncronized { get; set; }
Property Value
Type | Description |
---|---|
DateTime |
Remarks
Original type in dictionary: DateTime.
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
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. |
Name
.NET type: string. The filename for the attachment.
Declaration
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
String |
Remarks
Original type in dictionary: String[256].
Setting this field to a new value will not affect the Sentry calculations and your rights
This field is not protected by the Sentry system, and can always be read
This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it
TableInfo
Get the TableInfo for the table.
Declaration
public override TableInfo TableInfo { get; }
Property Value
Type | Description |
---|---|
TableInfo | The TableInfo for the table. |
Overrides
Methods
CreateNew()
Create a new instance of the AttachmentRow object. This table contains metadata for attachments. The actual attachments are stored directly on disk, with filenames based on the the primary key for this table.
Declaration
public static AttachmentRow CreateNew()
Returns
Type | Description |
---|---|
AttachmentRow | A new instance of the AttachmentRow object. |
GetFromCustomSearch(AttachmentRow.CustomSearch)
Create a new instance of the AttachmentRow 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 AttachmentRow GetFromCustomSearch(AttachmentRow.CustomSearch query)
Parameters
Type | Name | Description |
---|---|---|
AttachmentRow.CustomSearch | query | The custom search to execute against the database |
Returns
Type | Description |
---|---|
AttachmentRow | A new instance of the AttachmentRow object, reflecting the result of the query. |
GetFromIdxAttachmentId(Int32)
Create a new instance of the AttachmentRow object, by querying the database table via the index 'IDXAttachmentId'. This method is intended to make it easy to use efficient queries that match a database index.
Declaration
public static AttachmentRow GetFromIdxAttachmentId(int attachmentId)
Parameters
Type | Name | Description |
---|---|---|
Int32 | attachmentId |
Returns
Type | Description |
---|---|
AttachmentRow | 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 Attachment table. Non-unique indexes have corresponding inner classes and methods in the AttachmentRows collection, since they may return more than one row.
GetFromReader(SoDataReader, AttachmentTableInfo)
Create a new instance of the AttachmentRow object, and populate it with data from a reader/tableinfo. If the reader has DBNull as the current value of the primary key field, an unpopulated object with IsNew == true will be returned. If any fields are missing or one of the non-primary key fields is DBNull, an exception will be thrown. This table contains metadata for attachments. The actual attachments are stored directly on disk, with filenames based on the the primary key for this table.
Declaration
public static AttachmentRow GetFromReader(SoDataReader reader, AttachmentTableInfo tableInfo)
Parameters
Type | Name | Description |
---|---|---|
SoDataReader | reader | SoDataReader positioned to a valid database row. |
AttachmentTableInfo | tableInfo | AttachmentTableInfo 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 |
---|---|
AttachmentRow | A new instance of the AttachmentRow 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
_onAttachmentLocationIdChange
Change envent for property AttachmentLocationId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onAttachmentLocationIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onAttSizeChange
Change envent for property AttSize; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onAttSizeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onAuthKeyChange
Change envent for property AuthKey; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onAuthKeyChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onCharsetChange
Change envent for property Charset; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onCharsetChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onContentTypeChange
Change envent for property ContentType; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onContentTypeChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onDbiAgentIdChange
Change envent for property DbiAgentId; field is of .NET type int.
Declaration
protected event OnFieldChange<int> _onDbiAgentIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
_onDbiKeyChange
Change envent for property DbiKey; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onDbiKeyChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
_onDbiLastModifiedChange
Change envent for property DbiLastModified; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onDbiLastModifiedChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onDbiLastSyncronizedChange
Change envent for property DbiLastSyncronized; field is of .NET type DateTime.
Declaration
protected event OnFieldChange<DateTime> _onDbiLastSyncronizedChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
_onNameChange
Change envent for property Name; field is of .NET type string.
Declaration
protected event OnFieldChange<string> _onNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnAttachmentLocationIdChange
Event raised when AttachmentLocationId is changing.
Declaration
public event OnFieldChange<int> OnAttachmentLocationIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnAttSizeChange
Event raised when AttSize is changing.
Declaration
public event OnFieldChange<int> OnAttSizeChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnAuthKeyChange
Event raised when AuthKey is changing.
Declaration
public event OnFieldChange<string> OnAuthKeyChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnCharsetChange
Event raised when Charset is changing.
Declaration
public event OnFieldChange<string> OnCharsetChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnContentTypeChange
Event raised when ContentType is changing.
Declaration
public event OnFieldChange<string> OnContentTypeChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnDbiAgentIdChange
Event raised when DbiAgentId is changing.
Declaration
public event OnFieldChange<int> OnDbiAgentIdChange
Event Type
Type | Description |
---|---|
OnFieldChange<Int32> |
OnDbiKeyChange
Event raised when DbiKey is changing.
Declaration
public event OnFieldChange<string> OnDbiKeyChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |
OnDbiLastModifiedChange
Event raised when DbiLastModified is changing.
Declaration
public event OnFieldChange<DateTime> OnDbiLastModifiedChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnDbiLastSyncronizedChange
Event raised when DbiLastSyncronized is changing.
Declaration
public event OnFieldChange<DateTime> OnDbiLastSyncronizedChange
Event Type
Type | Description |
---|---|
OnFieldChange<DateTime> |
OnNameChange
Event raised when Name is changing.
Declaration
public event OnFieldChange<string> OnNameChange
Event Type
Type | Description |
---|---|
OnFieldChange<String> |