Class SShipmentAddrTableInfo

Table 's_shipment_addr': Addresses that are ready to be sent in a shipment.

Inheritance
object
TableInfo
SShipmentAddrTableInfo
Implements
Inherited Members
Namespace: SuperOffice.CRM.Data
Assembly: SoDataBase.dll
Syntax
[DatabaseTable("s_shipment_addr")]
public class SShipmentAddrTableInfo : TableInfo, ICloneable
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Fields

DictionaryTableName

Conceptual name of table SShipmentAddr in the database dictionary: s_shipment_addr

Declaration
public const string DictionaryTableName = "s_shipment_addr"
Field Value
Type Description
string
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Properties

Address

Field 'address' in table 's_shipment_addr': Dictionary type String[256], .NET type: string

The email address
Declaration
public StringFieldInfo Address { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

BounceCode

Field 'bounce_code' in table 's_shipment_addr': Dictionary type Int, .NET type: int

If this recipient bounced and we have a bounce code, this field will contain the code
Declaration
public Int32FieldInfo BounceCode { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

BounceReason

Field 'bounce_reason' in table 's_shipment_addr': Dictionary type String[1024], .NET type: string

Reason text received from mailing system
Declaration
public StringFieldInfo BounceReason { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

BounceReasontag

Field 'bounce_reasontag' in table 's_shipment_addr': Dictionary type String[4001], .NET type: string

If this recipient bounced and we have a bounce reason, this field will contain the reason
Declaration
public StringFieldInfo BounceReasontag { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Cleaned

Field 'cleaned' in table 's_shipment_addr': Dictionary type Bool, .NET type: short

Used for indicating that a bounced recipient row has been cleaned, and now will not be presented again in the cleaning list
Declaration
public UInt16FieldInfo Cleaned { get; }
Property Value
Type Description
UInt16FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

ContactId

Field 'contact_id' in table 's_shipment_addr': Dictionary type FK, target: Contact, .NET type: int

Id of contact bound to shipment address
Declaration
public Int32FieldInfo ContactId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

ContactId_InnerJoin_Contact

Generated join from the foreign key ContactId in this table, to its target table ContactTableInfo.

Declaration
public TargetedInnerJoin<ContactTableInfo> ContactId_InnerJoin_Contact { get; }
Property Value
Type Description
TargetedInnerJoin<ContactTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

CustomerId

Field 'customer_id' in table 's_shipment_addr': Dictionary type FK, target: Person, .NET type: int

Id of the customer if this entry is created by a dynamic list
Declaration
public Int32FieldInfo CustomerId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

CustomerId_InnerJoin_Person

Generated join from the foreign key CustomerId in this table, to its target table PersonTableInfo.

Declaration
public TargetedInnerJoin<PersonTableInfo> CustomerId_InnerJoin_Person { get; }
Property Value
Type Description
TargetedInnerJoin<PersonTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Definition

Definition of the table as described in the deployed runtime dictionary

Declaration
public override SoTable Definition { get; }
Property Value
Type Description
SoTable
Overrides
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

DictionaryTableNumber

Table number for table SShipmentAddr in the database dictionary; potentially changes between databases, but always the same over the lifetime of any single database

Declaration
public int DictionaryTableNumber { get; }
Property Value
Type Description
int
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

FormSubmissionId

Field 'form_submission_id' in table 's_shipment_addr': Dictionary type FK, target: FormSubmission, .NET type: int

If this mailing recipient is created from a form submission, this will contain a reference to that submission
Declaration
public Int32FieldInfo FormSubmissionId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

FormSubmissionId_InnerJoin_FormSubmission

Generated join from the foreign key FormSubmissionId in this table, to its target table FormSubmissionTableInfo.

Declaration
public TargetedInnerJoin<FormSubmissionTableInfo> FormSubmissionId_InnerJoin_FormSubmission { get; }
Property Value
Type Description
TargetedInnerJoin<FormSubmissionTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

LeftOuterJoin_FormSubmission_ResponseShipmentAddrId

Generated left outer join from the primary key SShipmentAddrId on this table, to FormSubmission.ResponseShipmentAddrId.

Declaration
public TargetedLeftOuterJoin<FormSubmissionTableInfo> LeftOuterJoin_FormSubmission_ResponseShipmentAddrId { get; }
Property Value
Type Description
TargetedLeftOuterJoin<FormSubmissionTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Name

Field 'name' in table 's_shipment_addr': Dictionary type String[256], .NET type: string

The name of the recipient
Declaration
public StringFieldInfo Name { get; }
Property Value
Type Description
StringFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

RuntimeDefinition

Definition of the table as described in the deployed runtime dictionary

Declaration
[Obsolete("Use instance property Definition or static member DictionaryTableNumber", true)]
public static SoTable RuntimeDefinition { get; }
Property Value
Type Description
SoTable
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

SShipmentAddrId

Field 'id' in table 's_shipment_addr': Dictionary type PK, .NET type: int

Primary key
Declaration
public Int32FieldInfo SShipmentAddrId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

SenderNr

Field 'sender_nr' in table 's_shipment_addr': Dictionary type Int, .NET type: int

Used for multiple ejSenders. This field indicate which ejSender process this belongs to
Declaration
public Int32FieldInfo SenderNr { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

SendingTime

Field 'sending_time' in table 's_shipment_addr': Dictionary type DateTime, .NET type: DateTime

Estimated or actual sent time (depends on status)
Declaration
public DateTimeFieldInfo SendingTime { get; }
Property Value
Type Description
DateTimeFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

ShipmentId

Field 'shipment_id' in table 's_shipment_addr': Dictionary type FK, target: SShipment, .NET type: int

Which shipment this address belongs to
Declaration
public Int32FieldInfo ShipmentId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

ShipmentId_InnerJoin_SShipment

Generated join from the foreign key ShipmentId in this table, to its target table SShipmentTableInfo.

Declaration
public TargetedInnerJoin<SShipmentTableInfo> ShipmentId_InnerJoin_SShipment { get; }
Property Value
Type Description
TargetedInnerJoin<SShipmentTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Status

Field 'status' in table 's_shipment_addr': Dictionary type Enum, .NET type: ShipmentAddrStatus

Status for sending to this particular recipient
Declaration
public ShipmentAddrStatusFieldInfo Status { get; }
Property Value
Type Description
ShipmentAddrStatusFieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

TicketId

Field 'ticket_id' in table 's_shipment_addr': Dictionary type FK, target: Ticket, .NET type: int

Id of the ticket if this entry is created by a ticketSelection list
Declaration
public Int32FieldInfo TicketId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

TicketId_InnerJoin_Ticket

Generated join from the foreign key TicketId in this table, to its target table TicketTableInfo.

Declaration
public TargetedInnerJoin<TicketTableInfo> TicketId_InnerJoin_Ticket { get; }
Property Value
Type Description
TargetedInnerJoin<TicketTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Timestamp

Field 'timestamp' in table 's_shipment_addr': Dictionary type Int, .NET type: int

A stamp set when this address it taken by ejSender to prevent two ejSenders to take one address.
Declaration
public Int32FieldInfo Timestamp { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Type

Field 'type' in table 's_shipment_addr': Dictionary type Int, .NET type: int

Indicates if this is an email or a sms
Declaration
public Int32FieldInfo Type { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

WorkflowInstanceId

Field 'workflow_instance_id' in table 's_shipment_addr': Dictionary type FK, target: WorkflowInstance, .NET type: int

The row was created by this workflow instance
Declaration
public Int32FieldInfo WorkflowInstanceId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

WorkflowInstanceId_InnerJoin_WorkflowInstance

Generated join from the foreign key WorkflowInstanceId in this table, to its target table WorkflowInstanceTableInfo.

Declaration
public TargetedInnerJoin<WorkflowInstanceTableInfo> WorkflowInstanceId_InnerJoin_WorkflowInstance { get; }
Property Value
Type Description
TargetedInnerJoin<WorkflowInstanceTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

WorkflowStepId

Field 'workflow_step_id' in table 's_shipment_addr': Dictionary type FK, target: WorkflowStep, .NET type: int

The row was created by this workflow step
Declaration
public Int32FieldInfo WorkflowStepId { get; }
Property Value
Type Description
Int32FieldInfo
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

WorkflowStepId_InnerJoin_WorkflowStep

Generated join from the foreign key WorkflowStepId in this table, to its target table WorkflowStepTableInfo.

Declaration
public TargetedInnerJoin<WorkflowStepTableInfo> WorkflowStepId_InnerJoin_WorkflowStep { get; }
Property Value
Type Description
TargetedInnerJoin<WorkflowStepTableInfo>
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Methods

IdxStatus(ShipmentAddrStatus)

Shortcut method for looking up using the database index Status, which spans the following fields:

FieldDescription
StatusStatus for sending to this particular recipient
Declaration
public Restriction IdxStatus(ShipmentAddrStatus status)
Parameters
Type Name Description
ShipmentAddrStatus status
Returns
Type Description
Restriction
Remarks

An instance of this class represents one instance of this table in an SQL statement. In most cases each table appears only once in a SELECT, but in cases where you need to self-join, or there are multiple occurrences for other reasons (typically additional restrictions in the joins), then you will need multiple instances.
Instances of this class are created by calling TablesInfo.GetSShipmentAddrInfo().

Implements

Extension Methods