Class TravelIDMappingRows

Mapping of primary keys between Travel databases and the mother database All travel database transactions get a high id to be able to see that this entry came from a database outside the central database. When update files are read into the central database, they get a normal low id. This table remembers the high travel id to map it to the low central id as long as this travel user is travelling. Collection of TravelIDMappingRow. Each element of the collection represents one row in the TravelIDMapping table.

Inheritance
Object
NestedPersist
NestedPersistFacade
NestedCollectionPersist
TableRowsBase
TravelIDMappingRows
Inherited Members
Namespace: SuperOffice.CRM.Rows
Assembly: SoDataBase.dll
Syntax
public class TravelIDMappingRows : TableRowsBase, INestedPersist, IEnumerable<INestedPersist>, ISoCollection, IList, ICollection, IEnumerable, INotifyCollectionChanged, IBindingList
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 TravelIDMappingRow to it, and use methods like to operate on the whole collection.
  • You can create a (nested) TravelIDMappingRows TravelIDMappingRows.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(TravelIDMappingRows.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 TravelIDMappingRow object directly, which has nested classes and GetFromIdx methods for each unique index. Similarly, there is a GetFromReader(SoDataReader, TravelIDMappingTableInfo) 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

Item[Int32]

Get a TravelIDMappingRow given its index in the collection.

Declaration
public TravelIDMappingRow this[int index] { get; }
Parameters
Type Name Description
Int32 index

Index of the TravelIDMappingRow in the collection
Property Value
Type Description
TravelIDMappingRow

Methods

Add(TravelIDMappingRow)

Add one TravelIDMappingRow to the collection.

Declaration
public int Add(TravelIDMappingRow row)
Parameters
Type Name Description
TravelIDMappingRow row

An instance of TravelIDMappingRow to be added to the collection.
Returns
Type Description
Int32

The index of the added TravelIDMappingRow.

AddNew()

Add a new instance of TravelIDMappingRow added to the collection.

Declaration
public TravelIDMappingRow AddNew()
Returns
Type Description
TravelIDMappingRow

A new instance of TravelIDMappingRow added to the collection.

AddRange(IEnumerable<TravelIDMappingRow>)

Add a range of TravelIDMappingRow to the collection.

Declaration
public TravelIDMappingRows AddRange(IEnumerable<TravelIDMappingRow> rows)
Parameters
Type Name Description
IEnumerable<TravelIDMappingRow> rows
Returns
Type Description
TravelIDMappingRows

The updated TravelIDMappingRows collection object.

CreateChild()

Create a new instance of TravelIDMappingRow

Declaration
protected override TableRowBase CreateChild()
Returns
Type Description
TableRowBase

New instance of TravelIDMappingRow
Overrides

CreateNew()

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

Declaration
public static TravelIDMappingRows CreateNew()
Returns
Type Description
TravelIDMappingRows

A new instance of the TravelIDMappingRows object.

Find(Predicate<TravelIDMappingRow>)

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

Declaration
public TravelIDMappingRow Find(Predicate<TravelIDMappingRow> condition)
Parameters
Type Name Description
Predicate<TravelIDMappingRow> condition
Returns
Type Description
TravelIDMappingRow

FindAll(Predicate<TravelIDMappingRow>)

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

Declaration
public TravelIDMappingRows FindAll(Predicate<TravelIDMappingRow> condition)
Parameters
Type Name Description
Predicate<TravelIDMappingRow> condition
Returns
Type Description
TravelIDMappingRows

ForEach(Action<TravelIDMappingRow>)

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

Declaration
public void ForEach(Action<TravelIDMappingRow> whatToDo)
Parameters
Type Name Description
Action<TravelIDMappingRow> whatToDo

GetFromCustomSearch(TravelIDMappingRows.CustomSearch)

Create a new instance of the TravelIDMappingRows 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 TravelIDMappingRow objects representing each row will be returned.

Declaration
public static TravelIDMappingRows GetFromCustomSearch(TravelIDMappingRows.CustomSearch query)
Parameters
Type Name Description
TravelIDMappingRows.CustomSearch query

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

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

GetFromIdxAssociateId(Int32)

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

Declaration
public static TravelIDMappingRows GetFromIdxAssociateId(int associateId)
Parameters
Type Name Description
Int32 associateId
Returns
Type Description
TravelIDMappingRows

Row object that represents the result of the search. 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 TravelIDMapping table. Non-unique indexes have corresponding inner classes and methods in the TravelIDMappingRows collection, since they may return more than one row.

GetFromIdxAssociateIdTableNumber(Int32, Int16)

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

Declaration
public static TravelIDMappingRows GetFromIdxAssociateIdTableNumber(int associateId, short tableNumber)
Parameters
Type Name Description
Int32 associateId
Int16 tableNumber
Returns
Type Description
TravelIDMappingRows

Row object that represents the result of the search. 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 TravelIDMapping table. Non-unique indexes have corresponding inner classes and methods in the TravelIDMappingRows collection, since they may return more than one row.

GetFromIdxAssociateIdTableNumberParentId(Int32, Int16, Int32)

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

Declaration
public static TravelIDMappingRows GetFromIdxAssociateIdTableNumberParentId(int associateId, short tableNumber, int parentId)
Parameters
Type Name Description
Int32 associateId
Int16 tableNumber
Int32 parentId
Returns
Type Description
TravelIDMappingRows

Row object that represents the result of the search. 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 TravelIDMapping table. Non-unique indexes have corresponding inner classes and methods in the TravelIDMappingRows collection, since they may return more than one row.

GetFromIdxLocalId(Int32)

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

Declaration
public static TravelIDMappingRows GetFromIdxLocalId(int localId)
Parameters
Type Name Description
Int32 localId
Returns
Type Description
TravelIDMappingRows

Row object that represents the result of the search. 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 TravelIDMapping table. Non-unique indexes have corresponding inner classes and methods in the TravelIDMappingRows collection, since they may return more than one row.

GetFromReader(SoDataReader, TravelIDMappingTableInfo)

Create a new instance of the TravelIDMappingRows 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 TravelIDMappingRow 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 TravelIDMappingRows GetFromReader(SoDataReader reader, TravelIDMappingTableInfo tableInfo)
Parameters
Type Name Description
SoDataReader reader

SoDataReader positioned to a valid database row.
TravelIDMappingTableInfo tableInfo

TravelIDMappingTableInfo 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
TravelIDMappingRows

Remove(TravelIDMappingRow)

Removes the given TravelIDMappingRow from the collection

Declaration
public void Remove(TravelIDMappingRow row)
Parameters
Type Name Description
TravelIDMappingRow row

the TravelIDMappingRow to be removed

ToArray()

Declaration
public TravelIDMappingRow[] ToArray()
Returns
Type Description
TravelIDMappingRow[]

ToString()

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

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Implements

Extension Methods

EnumUtil.MapEnums<From, To>(From)