Class SShipmentRows

Contains info about one shipment. The addresses are stored in s_shipment_addr Collection of SShipmentRow. Each element of the collection represents one row in the SShipment table.

Inheritance

object

NestedPersist

NestedPersistFacade

NestedCollectionPersist

TableRowsBase

SShipmentRows

Implements

INestedPersist

IEnumerable<INestedPersist>

ISoCollection

INotifyCollectionChanged

IBindingList

IList

ICollection

IEnumerable

Inherited Members

TableRowsBase._innerList

TableRowsBase._allHasBeenMarkedForDelete

TableRowsBase._sentries

TableRowsBase._idx

TableRowsBase.OnIndexChanged(IdxBase)

TableRowsBase.Load(IdxBase)

TableRowsBase.RowsLoad()

TableRowsBase.RowsLoad(ITableRowLoadHandlerFactory)

TableRowsBase.Delete()

TableRowsBase.GetEnumerator()

TableRowsBase.Add(TableRowBase)

TableRowsBase.Remove(TableRowBase)

TableRowsBase.Clear()

TableRowsBase.Sort(IComparer)

TableRowsBase.GetPrimaryKeys()

TableRowsBase.OnAdded(object, int)

TableRowsBase.CopyTo(Array, int)

TableRowsBase.IndexOf(object)

TableRowsBase.Contains(object)

TableRowsBase.AddIndex(PropertyDescriptor)

TableRowsBase.ApplySort(PropertyDescriptor, ListSortDirection)

TableRowsBase.Find(PropertyDescriptor, object)

TableRowsBase.RemoveIndex(PropertyDescriptor)

TableRowsBase.RemoveSort()

TableRowsBase.Sentries

TableRowsBase.IsDirty

TableRowsBase.Index

TableRowsBase.Count

TableRowsBase.IsMarkedForDelete

TableRowsBase.IsFixedSize

TableRowsBase.IsReadOnly

TableRowsBase.AllowEdit

TableRowsBase.AllowNew

TableRowsBase.AllowRemove

TableRowsBase.IsSorted

TableRowsBase.SortDirection

TableRowsBase.SortProperty

TableRowsBase.SupportsChangeNotification

TableRowsBase.SupportsSearching

TableRowsBase.SupportsSorting

TableRowsBase._onCollectionChanged

TableRowsBase.CollectionChanged

TableRowsBase.ListChanged

NestedCollectionPersist.GetFacadingItems()

NestedCollectionPersist.IsDeleted

NestedPersistFacade.OnPreIdUpdate()

NestedPersistFacade.OnPrimaryKeyRequest(PKContainer)

NestedPersistFacade.OnPrimaryKeyUpdate(PKContainer)

NestedPersistFacade.OnIdUpdate()

NestedPersistFacade.OnSave(BatchSave)

NestedPersistFacade.OnSaved(bool)

NestedPersist._saveOwner

NestedPersist._isSaving

NestedPersist.SetSaveOwner(INestedPersist)

NestedPersist.Save()

NestedPersist.IsSaving

NestedPersist.OnElementSaved

NestedPersist.OnElementIdUpdate

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SuperOffice.CRM.Rows

Assembly: SoDataBase.dll

Syntax

public class SShipmentRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, INotifyCollectionChanged, IBindingList, IList, ICollection, IEnumerable

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Properties

this[int]

Get a SShipmentRow given its index in the collection.

Declaration

public SShipmentRow this[int index] { get; }

Parameters

Type	Name	Description
int	index	Index of the SShipmentRow in the collection

Property Value

Type	Description
SShipmentRow

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Methods

Add(SShipmentRow)

Add one SShipmentRow to the collection.

Declaration

public int Add(SShipmentRow row)

Parameters

Type	Name	Description
SShipmentRow	row	An instance of SShipmentRow to be added to the collection.

Returns

Type	Description
int	The index of the added SShipmentRow.

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

AddNew()

Add a new instance of SShipmentRow added to the collection.

Declaration

public SShipmentRow AddNew()

Returns

Type	Description
SShipmentRow	A new instance of SShipmentRow added to the collection.

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

AddRange(IEnumerable<SShipmentRow>)

Add a range of SShipmentRow to the collection.

Declaration

public SShipmentRows AddRange(IEnumerable<SShipmentRow> rows)

Parameters

Type	Name	Description
IEnumerable<SShipmentRow>	rows

Returns

Type	Description
SShipmentRows	The updated SShipmentRows collection object.

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

CreateChild()

Create a new instance of SShipmentRow

Declaration

protected override TableRowBase CreateChild()

Returns

Type	Description
TableRowBase	New instance of SShipmentRow

Overrides

TableRowsBase.CreateChild()

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

CreateNew()

Create a new instance of the SShipmentRows object. This collection will contain no rows.

Declaration

public static SShipmentRows CreateNew()

Returns

Type	Description
SShipmentRows	A new instance of the SShipmentRows object.

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Find(Predicate<SShipmentRow>)

Apply the predicate to each element of the collection and return the first row that matches; if no match then return null

Declaration

public SShipmentRow Find(Predicate<SShipmentRow> condition)

Parameters

Type	Name	Description
Predicate<SShipmentRow>	condition

Returns

Type	Description
SShipmentRow

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

FindAll(Predicate<SShipmentRow>)

Return a new collection that contains only those elements that match the condition. Elements are shared, not clones! of the original collection

Declaration

public SShipmentRows FindAll(Predicate<SShipmentRow> condition)

Parameters

Type	Name	Description
Predicate<SShipmentRow>	condition

Returns

Type	Description
SShipmentRows

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

ForEach(Action<SShipmentRow>)

Method that iterates over all members and applies the action parameter to each of them

Declaration

public void ForEach(Action<SShipmentRow> whatToDo)

Parameters

Type	Name	Description
Action<SShipmentRow>	whatToDo

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

GetFromCustomSearch(CustomSearch)

Create a new instance of the SShipmentRows object, and populate it with data from a custom search. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of SShipmentRow objects representing each row will be returned.

Declaration

public static SShipmentRows GetFromCustomSearch(SShipmentRows.CustomSearch query)

Parameters

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

Returns

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

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

GetFromIdxAreStatisticsDirty(short)

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

Declaration

public static SShipmentRows GetFromIdxAreStatisticsDirty(short areStatisticsDirty)

Parameters

Type	Name	Description
short	areStatisticsDirty

Returns

Type	Description
SShipmentRows	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.

GetFromIdxMessageId(int)

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

Declaration

public static SShipmentRows GetFromIdxMessageId(int messageId)

Parameters

Type	Name	Description
int	messageId

Returns

Type	Description
SShipmentRows	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 SShipmentRows object, and populate it with data from a reader. If the search returns no results, an empty collection will be returned; if the result contains rows, a collection of SShipmentRow objects representing each row will be returned.

Note that the internal logic starts by calling reader.Read(), which is correct if you hand the method the result of an ExecuteReader(), but if the reader has already been advanced one or more rows, the current row will be skipped and collection population will start with the next row.

Declaration

public static SShipmentRows 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
SShipmentRows

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Remove(SShipmentRow)

Removes the given SShipmentRow from the collection

Declaration

public void Remove(SShipmentRow row)

Parameters

Type	Name	Description
SShipmentRow	row	the SShipmentRow to be removed

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

ToArray()

Contains info about one shipment. The addresses are stored in s_shipment_addr Collection of SShipmentRow. Each element of the collection represents one row in the SShipment table.

Declaration

public SShipmentRow[] ToArray()

Returns

Type	Description
SShipmentRow[]

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

ToString()

For debugging: Number of members, and the first (up to) 5 items

Declaration

public override string ToString()

Returns

Type	Description
string

Overrides

object.ToString()

Remarks

Row collections can be created in several ways.

• Use the static CreateNew() method to create a new, empty collection. You can then add objects of type SShipmentRow to it, and use methods like Save to operate on the whole collection.
• You can create a (nested) SShipmentRows SShipmentRows.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(CustomSearch) method to apply the query to the database and obtain the result as a Rows object, with one item for each table row that matched your query.
• For each non-unique index defined for the table, there is a corresponding GetFromIdx method to make retrieving data via the indexes easy.

Unique indexes are handled through the SShipmentRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, SShipmentTableInfo) method to retrieve the results of queries that return more than one row (this method will iterate over the reader to fetch ALL results, so beware of fetching huge result sets).

Implements

INestedPersist

IEnumerable<T>

ISoCollection

INotifyCollectionChanged

IBindingList

System.Collections.IList

ICollection

IEnumerable

Extension Methods

EnumUtil.MapEnums<From, To>(From)

Converters.MapEnums<From, To>(From)