Class SShipmentRow

Contains info about one shipment. The addresses are stored in s_shipment_addr
Row Object for table 's_shipment'. 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
SShipmentRow
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class SShipmentRow : 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) SShipmentRow SShipmentRow.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(SShipmentRow.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 SShipmentTableInfo instance used in the query behind the reader, you can use the static GetFromReader(SoDataReader, SShipmentTableInfo) 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 SShipmentRows collection, which has nested classes and GetFromIdx methods for each non-unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row.

Unique indexes on table SShipment are:

Index fieldsNested index class name

Constructors

SShipmentRow(SShipmentRow.SShipmentRowIdxBase)

Constructor for the class taking an index as argument. Contains info about one shipment. The addresses are stored in s_shipment_addr

Declaration
protected SShipmentRow(SShipmentRow.SShipmentRowIdxBase idx)
Parameters
Type Name Description
SShipmentRow.SShipmentRowIdxBase idx

The index representing a SELECT command to the database.

Fields

_currentActivePane

Current value, see property ActivePane.

Declaration
protected int _currentActivePane
Field Value
Type Description
Int32

_currentActualCount

Current value, see property ActualCount.

Declaration
protected int _currentActualCount
Field Value
Type Description
Int32

_currentActualRate

Current value, see property ActualRate.

Declaration
protected int _currentActualRate
Field Value
Type Description
Int32

_currentActualTime

Current value, see property ActualTime.

Declaration
protected DateTime _currentActualTime
Field Value
Type Description
DateTime

_currentConfiguration

Current value, see property Configuration.

Declaration
protected int _currentConfiguration
Field Value
Type Description
Int32

_currentCurrentSender

Current value, see property CurrentSender.

Declaration
protected int _currentCurrentSender
Field Value
Type Description
Int32

_currentDescription

Current value, see property Description.

Declaration
protected string _currentDescription
Field Value
Type Description
String

_currentEndDate

Current value, see property EndDate.

Declaration
protected DateTime _currentEndDate
Field Value
Type Description
DateTime

_currentEnvelopeFrom

Current value, see property EnvelopeFrom.

Declaration
protected string _currentEnvelopeFrom
Field Value
Type Description
String

_currentFlags

Current value, see property Flags.

Declaration
protected uint _currentFlags
Field Value
Type Description
UInt32

_currentFolderId

Current value, see property FolderId.

Declaration
protected int _currentFolderId
Field Value
Type Description
Int32

_currentFromAddr

Current value, see property FromAddr.

Declaration
protected string _currentFromAddr
Field Value
Type Description
String

_currentGeneratedDocumentId

Current value, see property GeneratedDocumentId.

Declaration
protected int _currentGeneratedDocumentId
Field Value
Type Description
Int32

_currentMessageId

Current value, see property MessageId.

Declaration
protected int _currentMessageId
Field Value
Type Description
Int32

_currentProjectId

Current value, see property ProjectId.

Declaration
protected int _currentProjectId
Field Value
Type Description
Int32

_currentRecipients

Current value, see property Recipients.

Declaration
protected int _currentRecipients
Field Value
Type Description
Int32

_currentRegistered

Current value, see property Registered.

Declaration
protected DateTime _currentRegistered
Field Value
Type Description
DateTime

_currentRegisteredAssociateId

Current value, see property RegisteredAssociateId.

Declaration
protected int _currentRegisteredAssociateId
Field Value
Type Description
Int32

_currentReplyAddr

Current value, see property ReplyAddr.

Declaration
protected string _currentReplyAddr
Field Value
Type Description
String

_currentSelectionId

Current value, see property SelectionId.

Declaration
protected int _currentSelectionId
Field Value
Type Description
Int32

_currentSendRate

Current value, see property SendRate.

Declaration
protected int _currentSendRate
Field Value
Type Description
Int32

_currentShipmenttypeId

Current value, see property ShipmenttypeId.

Declaration
protected int _currentShipmenttypeId
Field Value
Type Description
Int32

_currentSmtpPort

Current value, see property SmtpPort.

Declaration
protected int _currentSmtpPort
Field Value
Type Description
Int32

_currentSmtpServ

Current value, see property SmtpServ.

Declaration
protected string _currentSmtpServ
Field Value
Type Description
String

_currentSorting

Current value, see property Sorting.

Declaration
protected RecipientSorting _currentSorting
Field Value
Type Description
RecipientSorting

_currentSShipmentId

Current value, see property SShipmentId.

Declaration
protected int _currentSShipmentId
Field Value
Type Description
Int32

_currentStartDate

Current value, see property StartDate.

Declaration
protected DateTime _currentStartDate
Field Value
Type Description
DateTime

_currentStatus

Current value, see property Status.

Declaration
protected ShipmentStatus _currentStatus
Field Value
Type Description
ShipmentStatus

_currentTicketCategory

Current value, see property TicketCategory.

Declaration
protected int _currentTicketCategory
Field Value
Type Description
Int32

_currentTicketOwner

Current value, see property TicketOwner.

Declaration
protected int _currentTicketOwner
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

_persistedActivePane

Persisted value, see property ActivePane.

Declaration
protected int _persistedActivePane
Field Value
Type Description
Int32

_persistedActualCount

Persisted value, see property ActualCount.

Declaration
protected int _persistedActualCount
Field Value
Type Description
Int32

_persistedActualRate

Persisted value, see property ActualRate.

Declaration
protected int _persistedActualRate
Field Value
Type Description
Int32

_persistedActualTime

Persisted value, see property ActualTime.

Declaration
protected DateTime _persistedActualTime
Field Value
Type Description
DateTime

_persistedConfiguration

Persisted value, see property Configuration.

Declaration
protected int _persistedConfiguration
Field Value
Type Description
Int32

_persistedCurrentSender

Persisted value, see property CurrentSender.

Declaration
protected int _persistedCurrentSender
Field Value
Type Description
Int32

_persistedDescription

Persisted value, see property Description.

Declaration
protected string _persistedDescription
Field Value
Type Description
String

_persistedEndDate

Persisted value, see property EndDate.

Declaration
protected DateTime _persistedEndDate
Field Value
Type Description
DateTime

_persistedEnvelopeFrom

Persisted value, see property EnvelopeFrom.

Declaration
protected string _persistedEnvelopeFrom
Field Value
Type Description
String

_persistedFlags

Persisted value, see property Flags.

Declaration
protected uint _persistedFlags
Field Value
Type Description
UInt32

_persistedFolderId

Persisted value, see property FolderId.

Declaration
protected int _persistedFolderId
Field Value
Type Description
Int32

_persistedFromAddr

Persisted value, see property FromAddr.

Declaration
protected string _persistedFromAddr
Field Value
Type Description
String

_persistedGeneratedDocumentId

Persisted value, see property GeneratedDocumentId.

Declaration
protected int _persistedGeneratedDocumentId
Field Value
Type Description
Int32

_persistedMessageId

Persisted value, see property MessageId.

Declaration
protected int _persistedMessageId
Field Value
Type Description
Int32

_persistedProjectId

Persisted value, see property ProjectId.

Declaration
protected int _persistedProjectId
Field Value
Type Description
Int32

_persistedRecipients

Persisted value, see property Recipients.

Declaration
protected int _persistedRecipients
Field Value
Type Description
Int32

_persistedRegistered

Persisted value, see property Registered.

Declaration
protected DateTime _persistedRegistered
Field Value
Type Description
DateTime

_persistedRegisteredAssociateId

Persisted value, see property RegisteredAssociateId.

Declaration
protected int _persistedRegisteredAssociateId
Field Value
Type Description
Int32

_persistedReplyAddr

Persisted value, see property ReplyAddr.

Declaration
protected string _persistedReplyAddr
Field Value
Type Description
String

_persistedSelectionId

Persisted value, see property SelectionId.

Declaration
protected int _persistedSelectionId
Field Value
Type Description
Int32

_persistedSendRate

Persisted value, see property SendRate.

Declaration
protected int _persistedSendRate
Field Value
Type Description
Int32

_persistedShipmenttypeId

Persisted value, see property ShipmenttypeId.

Declaration
protected int _persistedShipmenttypeId
Field Value
Type Description
Int32

_persistedSmtpPort

Persisted value, see property SmtpPort.

Declaration
protected int _persistedSmtpPort
Field Value
Type Description
Int32

_persistedSmtpServ

Persisted value, see property SmtpServ.

Declaration
protected string _persistedSmtpServ
Field Value
Type Description
String

_persistedSorting

Persisted value, see property Sorting.

Declaration
protected RecipientSorting _persistedSorting
Field Value
Type Description
RecipientSorting

_persistedSShipmentId

Persisted value, see property SShipmentId.

Declaration
protected int _persistedSShipmentId
Field Value
Type Description
Int32

_persistedStartDate

Persisted value, see property StartDate.

Declaration
protected DateTime _persistedStartDate
Field Value
Type Description
DateTime

_persistedStatus

Persisted value, see property Status.

Declaration
protected ShipmentStatus _persistedStatus
Field Value
Type Description
ShipmentStatus

_persistedTicketCategory

Persisted value, see property TicketCategory.

Declaration
protected int _persistedTicketCategory
Field Value
Type Description
Int32

_persistedTicketOwner

Persisted value, see property TicketOwner.

Declaration
protected int _persistedTicketOwner
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

ActivePane

.NET type: int. The currently active pane in the mailing wizard

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

ActualCount

.NET type: int. Number of emails sent at the last checkpoint

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

ActualRate

.NET type: int. The actual rate of messages per minute. can be lower than send_rate

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

ActualTime

.NET type: DateTime. The time of the last checkpoint

Declaration
public virtual DateTime ActualTime { 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

Configuration

.NET type: int. This field indicates what kind of shipment this is.

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

CurrentSender

.NET type: int. Timestamp to identify which ejsender that owns this shipment

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

Description

.NET type: string. Describes the shipment

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

EndDate

.NET type: DateTime. Is set when this shipment is ended

Declaration
public virtual DateTime EndDate { 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

EnvelopeFrom

.NET type: string. Email address for the MTA envelope (where bounces are returned)

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

Flags

.NET type: uint. Various flags for a shipment

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

Original type in dictionary: UInt.

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

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

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

FolderId

.NET type: int. The folder which this shipment belongs to. -1 indicates that the shipment is on the root

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

FromAddr

.NET type: string. Email address to put in the From header of the messages

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

GeneratedDocumentId

.NET type: int. ID of the merged document that is the result of the shipment

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

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.

MessageId

.NET type: int. The id of the message that is sent in this shipment

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

ProjectId

.NET type: int. Set if this shipment should be related to a Project

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

Recipients

.NET type: int. The total number of recipients to send message to.

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

Registered

.NET type: DateTime. Registered when in UTC

Declaration
public virtual DateTime Registered { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: UtcDateTime.

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

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

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

RegisteredAssociateId

.NET type: int. Registered by whom

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

Original type in dictionary: FK.

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

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

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

ReplyAddr

.NET type: string. Email address to put in the Reply To: header of the messages

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

SelectionId

.NET type: int. Set if this shipment should be related to a Selection

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

SendRate

.NET type: int. Maximum number of messages sent per minute.

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

ShipmenttypeId

.NET type: int. Id of subscriptionType that this shipment has, so we may check for reservations

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

SmtpPort

.NET type: int. The port of the SMTP server to use for this shipment.

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

SmtpServ

.NET type: string. The server to use for this shipment.

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

Sorting

.NET type: RecipientSorting. Which sorting should be used on the document mailing recipient list, used when generating PDF

Declaration
public virtual RecipientSorting Sorting { get; set; }
Property Value
Type Description
RecipientSorting
Remarks

Original type in dictionary: Enum.

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

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

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

SShipmentId

.NET type: int. Primary key

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

SShipmentTableInfo

Get the SShipmentTableInfo object associated with the row.

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

StartDate

.NET type: DateTime. The date and time when to start this shipment

Declaration
public virtual DateTime StartDate { 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

Status

.NET type: ShipmentStatus. Sending/stopped/failed etc.

Declaration
public virtual ShipmentStatus Status { get; set; }
Property Value
Type Description
ShipmentStatus
Remarks

Original type in dictionary: Enum.

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

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

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

TableInfo

Get the TableInfo for the table.

Declaration
public override TableInfo TableInfo { get; }
Property Value
Type Description
TableInfo

The TableInfo for the table.
Overrides

TicketCategory

.NET type: int. The category of tickets created while sending out if any. -1 if no ticket should be created

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

TicketOwner

.NET type: int. The owner of the ticket if any is created while sending out a shipment. -1 if no ticket should be automatically delegated, 1 if the ticket is unassigned, >1 for all others

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

Updated

.NET type: DateTime. Last updated when in UTC

Declaration
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime
Remarks

Original type in dictionary: UtcDateTime.

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

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

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

UpdatedAssociateId

.NET type: int. Last updated by whom

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

Original type in dictionary: FK.

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

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

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

UpdatedCount

.NET type: short. Number of updates made to this record

Declaration
public virtual short UpdatedCount { get; set; }
Property Value
Type Description
Int16
Remarks

Original type in dictionary: UShort.

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

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

This field is not protected by the Sentry system, and can be written to unless other restrictions prevent it

Methods

CreateNew()

Create a new instance of the SShipmentRow object. Contains info about one shipment. The addresses are stored in s_shipment_addr

Declaration
public static SShipmentRow CreateNew()
Returns
Type Description
SShipmentRow

A new instance of the SShipmentRow object.

GetFromCustomSearch(SShipmentRow.CustomSearch)

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

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

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

GetFromIdxSShipmentId(Int32)

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

Declaration
public static SShipmentRow GetFromIdxSShipmentId(int sShipmentId)
Parameters
Type Name Description
Int32 sShipmentId
Returns
Type Description
SShipmentRow

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

GetFromReader(SoDataReader, SShipmentTableInfo)

Create a new instance of the SShipmentRow 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. Contains info about one shipment. The addresses are stored in s_shipment_addr

Declaration
public static SShipmentRow GetFromReader(SoDataReader reader, SShipmentTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
SShipmentTableInfo tableInfo

SShipmentTableInfo 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
SShipmentRow

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

_onActivePaneChange

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

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

_onActualCountChange

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

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

_onActualRateChange

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

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

_onActualTimeChange

Change envent for property ActualTime; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onActualTimeChange
Event Type
Type Description
OnFieldChange<DateTime>

_onConfigurationChange

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

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

_onCurrentSenderChange

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

Declaration
protected event OnFieldChange<int> _onCurrentSenderChange
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>

_onEndDateChange

Change envent for property EndDate; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onEndDateChange
Event Type
Type Description
OnFieldChange<DateTime>

_onEnvelopeFromChange

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

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

_onFlagsChange

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

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

_onFolderIdChange

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

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

_onFromAddrChange

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

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

_onGeneratedDocumentIdChange

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

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

_onMessageIdChange

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

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

_onProjectIdChange

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

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

_onRecipientsChange

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

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

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

_onReplyAddrChange

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

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

_onSelectionIdChange

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

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

_onSendRateChange

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

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

_onShipmenttypeIdChange

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

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

_onSmtpPortChange

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

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

_onSmtpServChange

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

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

_onSortingChange

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

Declaration
protected event OnFieldChange<RecipientSorting> _onSortingChange
Event Type
Type Description
OnFieldChange<RecipientSorting>

_onStartDateChange

Change envent for property StartDate; field is of .NET type DateTime.

Declaration
protected event OnFieldChange<DateTime> _onStartDateChange
Event Type
Type Description
OnFieldChange<DateTime>

_onStatusChange

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

Declaration
protected event OnFieldChange<ShipmentStatus> _onStatusChange
Event Type
Type Description
OnFieldChange<ShipmentStatus>

_onTicketCategoryChange

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

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

_onTicketOwnerChange

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

Declaration
protected event OnFieldChange<int> _onTicketOwnerChange
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>

OnActivePaneChange

Event raised when ActivePane is changing.

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

OnActualCountChange

Event raised when ActualCount is changing.

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

OnActualRateChange

Event raised when ActualRate is changing.

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

OnActualTimeChange

Event raised when ActualTime is changing.

Declaration
public event OnFieldChange<DateTime> OnActualTimeChange
Event Type
Type Description
OnFieldChange<DateTime>

OnConfigurationChange

Event raised when Configuration is changing.

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

OnCurrentSenderChange

Event raised when CurrentSender is changing.

Declaration
public event OnFieldChange<int> OnCurrentSenderChange
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>

OnEndDateChange

Event raised when EndDate is changing.

Declaration
public event OnFieldChange<DateTime> OnEndDateChange
Event Type
Type Description
OnFieldChange<DateTime>

OnEnvelopeFromChange

Event raised when EnvelopeFrom is changing.

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

OnFlagsChange

Event raised when Flags is changing.

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

OnFolderIdChange

Event raised when FolderId is changing.

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

OnFromAddrChange

Event raised when FromAddr is changing.

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

OnGeneratedDocumentIdChange

Event raised when GeneratedDocumentId is changing.

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

OnMessageIdChange

Event raised when MessageId is changing.

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

OnProjectIdChange

Event raised when ProjectId is changing.

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

OnRecipientsChange

Event raised when Recipients is changing.

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

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>

OnReplyAddrChange

Event raised when ReplyAddr is changing.

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

OnSelectionIdChange

Event raised when SelectionId is changing.

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

OnSendRateChange

Event raised when SendRate is changing.

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

OnShipmenttypeIdChange

Event raised when ShipmenttypeId is changing.

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

OnSmtpPortChange

Event raised when SmtpPort is changing.

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

OnSmtpServChange

Event raised when SmtpServ is changing.

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

OnSortingChange

Event raised when Sorting is changing.

Declaration
public event OnFieldChange<RecipientSorting> OnSortingChange
Event Type
Type Description
OnFieldChange<RecipientSorting>

OnStartDateChange

Event raised when StartDate is changing.

Declaration
public event OnFieldChange<DateTime> OnStartDateChange
Event Type
Type Description
OnFieldChange<DateTime>

OnStatusChange

Event raised when Status is changing.

Declaration
public event OnFieldChange<ShipmentStatus> OnStatusChange
Event Type
Type Description
OnFieldChange<ShipmentStatus>

OnTicketCategoryChange

Event raised when TicketCategory is changing.

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

OnTicketOwnerChange

Event raised when TicketOwner is changing.

Declaration
public event OnFieldChange<int> OnTicketOwnerChange
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

Extension Methods

EnumUtil.MapEnums<From, To>(From)