OpenPetra
Free Administration Software for Non-Profits
Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable Class Reference

Address and other data related to that address. More...

Inheritance diagram for Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable:
Ict.Common.Data.TTypedDataTable Ict.Petra.Shared.MPartner.Partner.Data.PartnerAddressAggregateTDSSimilarLocationParametersTable

Public Member Functions

 PLocationTable ()
 constructor More...
 
 PLocationTable (string ATablename)
 constructor More...
 
 PLocationTable (System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context)
 constructor for serialization More...
 
override void InitVars ()
 assign columns to properties, set primary key More...
 
PLocationRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
PLocationRow NewRowTyped ()
 create a new typed row, always with default values More...
 
PLocationTable GetChangesTyped ()
 get typed set of changes More...
 
override OdbcParameter CreateOdbcParameter (Int32 AColumnNr)
 get an odbc parameter for the given column More...
 
new DataTable GetChanges ()
 make sure that we use GetChangesType instead of GetChanges More...
 
virtual string GetCustomReportPermission ()
 string to indicate which permissions a user needs to access table for custom reports (e.g. "PTNRUSER", "OR(FINANCE-1,DEVUSER)", "AND(PTNRUSER,FINANCE-1)" This should be returned by method in derived class More...
 
virtual bool IsAvailableForCustomReport ()
 Is this table generally available in custom reports? More...
 
virtual List< String > GetCustomReportFieldList ()
 Return a list of fields that are available for custom reports More...
 
DataTable GetChangesTypedInternal ()
 our own version of GetChanges More...
 
void RemoveColumnsNotInTableTemplate (DataTable ATableTemplate)
 remove columns that are not needed More...
 

Static Public Member Functions

static string GetTableName ()
 return the CamelCase name of the table More...
 
static string GetTableDBName ()
 return the name of the table as it is used in the database More...
 
static string GetTableDBLabel ()
 static method to return the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about) More...
 
static string GetSiteKeyDBName ()
 get the name of the field in the database for this column More...
 
static short GetSiteKeyLength ()
 get character length for column More...
 
static string GetSiteKeyHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLocationKeyDBName ()
 get the name of the field in the database for this column More...
 
static short GetLocationKeyLength ()
 get character length for column More...
 
static string GetLocationKeyHelp ()
 get the help text for the field in the database for this column More...
 
static string GetBuilding1DBName ()
 get the name of the field in the database for this column More...
 
static short GetBuilding1Length ()
 get character length for column More...
 
static string GetBuilding1Help ()
 get the help text for the field in the database for this column More...
 
static string GetBuilding2DBName ()
 get the name of the field in the database for this column More...
 
static short GetBuilding2Length ()
 get character length for column More...
 
static string GetBuilding2Help ()
 get the help text for the field in the database for this column More...
 
static string GetStreetNameDBName ()
 get the name of the field in the database for this column More...
 
static short GetStreetNameLength ()
 get character length for column More...
 
static string GetStreetNameHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLocalityDBName ()
 get the name of the field in the database for this column More...
 
static short GetLocalityLength ()
 get character length for column More...
 
static string GetLocalityHelp ()
 get the help text for the field in the database for this column More...
 
static string GetSuburbDBName ()
 get the name of the field in the database for this column More...
 
static short GetSuburbLength ()
 get character length for column More...
 
static string GetSuburbHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCityDBName ()
 get the name of the field in the database for this column More...
 
static short GetCityLength ()
 get character length for column More...
 
static string GetCityHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCountyDBName ()
 get the name of the field in the database for this column More...
 
static short GetCountyLength ()
 get character length for column More...
 
static string GetCountyHelp ()
 get the help text for the field in the database for this column More...
 
static string GetPostalCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetPostalCodeLength ()
 get character length for column More...
 
static string GetPostalCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCountryCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetCountryCodeLength ()
 get character length for column More...
 
static string GetCountryCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetAddress3DBName ()
 get the name of the field in the database for this column More...
 
static short GetAddress3Length ()
 get character length for column More...
 
static string GetAddress3Help ()
 get the help text for the field in the database for this column More...
 
static string GetGeoLatitudeDBName ()
 get the name of the field in the database for this column More...
 
static short GetGeoLatitudeLength ()
 get character length for column More...
 
static string GetGeoLatitudeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetGeoLongitudeDBName ()
 get the name of the field in the database for this column More...
 
static short GetGeoLongitudeLength ()
 get character length for column More...
 
static string GetGeoLongitudeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetGeoKmXDBName ()
 get the name of the field in the database for this column More...
 
static short GetGeoKmXLength ()
 get character length for column More...
 
static string GetGeoKmXHelp ()
 get the help text for the field in the database for this column More...
 
static string GetGeoKmYDBName ()
 get the name of the field in the database for this column More...
 
static short GetGeoKmYLength ()
 get character length for column More...
 
static string GetGeoKmYHelp ()
 get the help text for the field in the database for this column More...
 
static string GetGeoAccuracyDBName ()
 get the name of the field in the database for this column More...
 
static short GetGeoAccuracyLength ()
 get character length for column More...
 
static string GetGeoAccuracyHelp ()
 get the help text for the field in the database for this column More...
 
static string GetRestrictedDBName ()
 get the name of the field in the database for this column More...
 
static short GetRestrictedLength ()
 get character length for column More...
 
static string GetRestrictedHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateCreatedDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateCreatedLength ()
 get character length for column More...
 
static string GetDateCreatedHelp ()
 get the help text for the field in the database for this column More...
 
static string GetCreatedByDBName ()
 get the name of the field in the database for this column More...
 
static short GetCreatedByLength ()
 get character length for column More...
 
static string GetCreatedByHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateModifiedDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateModifiedLength ()
 get character length for column More...
 
static string GetDateModifiedHelp ()
 get the help text for the field in the database for this column More...
 
static string GetModifiedByDBName ()
 get the name of the field in the database for this column More...
 
static short GetModifiedByLength ()
 get character length for column More...
 
static string GetModifiedByHelp ()
 get the help text for the field in the database for this column More...
 
static string GetModificationIdDBName ()
 get the name of the field in the database for this column More...
 
static short GetModificationIdLength ()
 get character length for column More...
 
static string GetModificationIdHelp ()
 get the help text for the field in the database for this column More...
 
static OdbcParameter CreateOdbcParameter (short ATableNumber, TSearchCriteria ASearchCriteria)
 create an odbc parameter for the given column More...
 
static OdbcParameter CreateOdbcParameter (short ATableNumber, Int32 AColumnNr)
 create an odbc parameter for the given column More...
 
static void ResetStaticVariables ()
 reset the static variables for each Web Request call. More...
 
static string GetTableNameSQL (short ATableNumber)
 the table name as it is in the SQL database More...
 
static string GetTableName (short ATableNumber)
 the table name in CamelCase More...
 
static TTypedTableInfo GetTableByName (string ATableName)
 the table name in CamelCase More...
 
static string GetColumnNameSQL (short ATableNumber, short AColumnNr)
 the column name as it is in the SQL database More...
 
static string GetLabel (short ATableNumber, short AColumnNr)
 returns the translated label for the column More...
 
static Int32 GetLength (short ATableNumber, short AColumnNr)
 get the maximum length for the field More...
 
static Int32 GetLength (string ATableName, string AColumnName)
 get the maximum length for the field More...
 
static string[] GetKeyColumnStringList (short ATableNumber, int[] AKeyColumnsOrder)
 get the names of the columns that are part of the key More...
 
static string[] GetPrimaryKeyColumnStringList (short ATableNumber)
 get the names of the columns that are part of the primary key More...
 
static string[] GetUniqueKeyColumnStringList (short ATableNumber)
 get the names of the columns that are part of the unique key More...
 
static int[] GetPrimaryKeyColumnOrdList (short ATableNumber)
 get the order number of the columns that are part of the primary key More...
 
static int[] GetUniqueKeyColumnOrdList (short ATableNumber)
 get the order number of the columns that are part of a unique key More...
 
static string[] GetColumnStringList (short ATableNumber)
 get the names of the columns in this table More...
 

Public Attributes

DataColumn ColumnSiteKey
 This is the key that tell what site created this location, it will help to merge addresses when doing imports. More...
 
DataColumn ColumnLocationKey
 
DataColumn ColumnBuilding1
 The name of the building. More...
 
DataColumn ColumnBuilding2
 The name of the building (continued) More...
 
DataColumn ColumnStreetName
 The name of the street that the house is located on. More...
 
DataColumn ColumnLocality
 This is the first element of an address. More...
 
DataColumn ColumnSuburb
 The name of the suburb. More...
 
DataColumn ColumnCity
 This can be a post town or city. More...
 
DataColumn ColumnCounty
 This can be a county (UK), a state (US), province (CDN), canton (CH) etc. More...
 
DataColumn ColumnPostalCode
 This is the national post code. More...
 
DataColumn ColumnCountryCode
 
DataColumn ColumnAddress3
 This is the third element of an address (if required) More...
 
DataColumn ColumnGeoLatitude
 The latitude of the location; a number between -90 and +90; precision is 6 digits (11cm) More...
 
DataColumn ColumnGeoLongitude
 The longitude of the location; a number between -180 and +180; precision is 6 digits (11cm) More...
 
DataColumn ColumnGeoKmX
 The distance in km of this location to the location 0 if location 0 was on the same longitude; this is for improving query performance. More...
 
DataColumn ColumnGeoKmY
 The distance in km of this location to the location 0 if location 0 was on the same latitude; this is for improving query performance. More...
 
DataColumn ColumnGeoAccuracy
 The accuracy of the stored geo data; -2: server did not respond; -1: not processed yet; 0: Unknown Location; 1: Country level accuracy; 2: Region; 3: Sub-Region; 4: Town/City/Village; 5: Post code; 6: Street; 7: Intersection; 8: Address level accuracy. More...
 
DataColumn ColumnRestricted
 Indicates whether or not the location has restricted access. If it does then the access will be controlled by s_group_location. More...
 
DataColumn ColumnDateCreated
 The date the record was created. More...
 
DataColumn ColumnCreatedBy
 User ID of who created this record. More...
 
DataColumn ColumnDateModified
 The date the record was modified. More...
 
DataColumn ColumnModifiedBy
 User ID of who last modified this record. More...
 
DataColumn ColumnModificationId
 This identifies the current version of the record. More...
 
bool ThrowAwayAfterSubmitChanges = false
 if you want the datatable to be cleared after submitchanges. This will increase the speed significantly: no updating of modificationID, no slow AcceptChanges. More...
 
bool DontThrowAwayAfterSubmitChanges = false
 if you want no warning about that the datatable should be cleared after submitchanges. in some cases you must keep the data, eg when you need the new keys after INSERT More...
 

Static Public Attributes

static readonly short TableId = 38
 TableId for Ict.Common.Data generic functions. More...
 
static readonly short ColumnSiteKeyId = 0
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLocationKeyId = 1
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBuilding1Id = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnBuilding2Id = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnStreetNameId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLocalityId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnSuburbId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCityId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCountyId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPostalCodeId = 9
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCountryCodeId = 10
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnAddress3Id = 11
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnGeoLatitudeId = 12
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnGeoLongitudeId = 13
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnGeoKmXId = 14
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnGeoKmYId = 15
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnGeoAccuracyId = 16
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnRestrictedId = 17
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateCreatedId = 18
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnCreatedById = 19
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateModifiedId = 20
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModifiedById = 21
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnModificationIdId = 22
 used for generic TTypedDataTable functions More...
 

Protected Member Functions

override void InitClass ()
 create the columns More...
 
override System.Data.DataRow NewRowFromBuilder (System.Data.DataRowBuilder builder)
 new typed row using DataRowBuilder More...
 

Static Protected Attributes

static SortedList< short, TTypedTableInfoTableInfo = new SortedList <short, TTypedTableInfo>()
 stores information about typed tables More...
 

Properties

PLocationRow this[int i] [get]
 Access a typed row by index. More...
 
override string TableDBLabel [get]
 instance property to get the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about) More...
 
int Count [get]
 the number of rows in the current table More...
 

Detailed Description

Address and other data related to that address.

Constructor & Destructor Documentation

◆ PLocationTable() [1/3]

Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.PLocationTable ( )
inline

constructor

◆ PLocationTable() [2/3]

Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.PLocationTable ( string  ATablename)
inline

constructor

◆ PLocationTable() [3/3]

Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.PLocationTable ( System.Runtime.Serialization.SerializationInfo  info,
System.Runtime.Serialization.StreamingContext  context 
)
inline

constructor for serialization

Member Function Documentation

◆ CreateOdbcParameter() [1/3]

override OdbcParameter Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.CreateOdbcParameter ( Int32  AColumnNr)
inlinevirtual

get an odbc parameter for the given column

Implements Ict.Common.Data.TTypedDataTable.

◆ CreateOdbcParameter() [2/3]

static OdbcParameter Ict.Common.Data.TTypedDataTable.CreateOdbcParameter ( short  ATableNumber,
Int32  AColumnNr 
)
inlinestaticinherited

create an odbc parameter for the given column

◆ CreateOdbcParameter() [3/3]

static OdbcParameter Ict.Common.Data.TTypedDataTable.CreateOdbcParameter ( short  ATableNumber,
TSearchCriteria  ASearchCriteria 
)
inlinestaticinherited

create an odbc parameter for the given column

◆ GetAddress3DBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetAddress3DBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetAddress3Help()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetAddress3Help ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetAddress3Length()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetAddress3Length ( )
inlinestatic

get character length for column

◆ GetBuilding1DBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetBuilding1DBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetBuilding1Help()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetBuilding1Help ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetBuilding1Length()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetBuilding1Length ( )
inlinestatic

get character length for column

◆ GetBuilding2DBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetBuilding2DBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetBuilding2Help()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetBuilding2Help ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetBuilding2Length()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetBuilding2Length ( )
inlinestatic

get character length for column

◆ GetChanges()

new DataTable Ict.Common.Data.TTypedDataTable.GetChanges ( )
inlineinherited

make sure that we use GetChangesType instead of GetChanges

Returns
throws an exception

◆ GetChangesTyped()

PLocationTable Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetChangesTyped ( )
inline

get typed set of changes

◆ GetChangesTypedInternal()

DataTable Ict.Common.Data.TTypedDataTable.GetChangesTypedInternal ( )
inlineinherited

our own version of GetChanges

Returns
returns a typed table with the changes

◆ GetCityDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCityDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetCityHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCityHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetCityLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCityLength ( )
inlinestatic

get character length for column

◆ GetColumnNameSQL()

static string Ict.Common.Data.TTypedDataTable.GetColumnNameSQL ( short  ATableNumber,
short  AColumnNr 
)
inlinestaticinherited

the column name as it is in the SQL database

◆ GetColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetColumnStringList ( short  ATableNumber)
inlinestaticinherited

get the names of the columns in this table

◆ GetCountryCodeDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCountryCodeDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetCountryCodeHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCountryCodeHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetCountryCodeLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCountryCodeLength ( )
inlinestatic

get character length for column

◆ GetCountyDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCountyDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetCountyHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCountyHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetCountyLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCountyLength ( )
inlinestatic

get character length for column

◆ GetCreatedByDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCreatedByDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCreatedByHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetCreatedByLength ( )
inlinestatic

get character length for column

◆ GetCustomReportFieldList()

virtual List< String > Ict.Common.Data.TTypedDataTable.GetCustomReportFieldList ( )
inlinevirtualinherited

Return a list of fields that are available for custom reports

◆ GetCustomReportPermission()

virtual string Ict.Common.Data.TTypedDataTable.GetCustomReportPermission ( )
inlinevirtualinherited

string to indicate which permissions a user needs to access table for custom reports (e.g. "PTNRUSER", "OR(FINANCE-1,DEVUSER)", "AND(PTNRUSER,FINANCE-1)" This should be returned by method in derived class

◆ GetDateCreatedDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetDateCreatedDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetDateCreatedHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetDateCreatedLength ( )
inlinestatic

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetDateModifiedDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetDateModifiedHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetDateModifiedLength ( )
inlinestatic

get character length for column

◆ GetGeoAccuracyDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoAccuracyDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetGeoAccuracyHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoAccuracyHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetGeoAccuracyLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoAccuracyLength ( )
inlinestatic

get character length for column

◆ GetGeoKmXDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoKmXDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetGeoKmXHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoKmXHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetGeoKmXLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoKmXLength ( )
inlinestatic

get character length for column

◆ GetGeoKmYDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoKmYDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetGeoKmYHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoKmYHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetGeoKmYLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoKmYLength ( )
inlinestatic

get character length for column

◆ GetGeoLatitudeDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoLatitudeDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetGeoLatitudeHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoLatitudeHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetGeoLatitudeLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoLatitudeLength ( )
inlinestatic

get character length for column

◆ GetGeoLongitudeDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoLongitudeDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetGeoLongitudeHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoLongitudeHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetGeoLongitudeLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetGeoLongitudeLength ( )
inlinestatic

get character length for column

◆ GetKeyColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetKeyColumnStringList ( short  ATableNumber,
int[]  AKeyColumnsOrder 
)
inlinestaticinherited

get the names of the columns that are part of the key

◆ GetLabel()

static string Ict.Common.Data.TTypedDataTable.GetLabel ( short  ATableNumber,
short  AColumnNr 
)
inlinestaticinherited

returns the translated label for the column

◆ GetLength() [1/2]

static Int32 Ict.Common.Data.TTypedDataTable.GetLength ( short  ATableNumber,
short  AColumnNr 
)
inlinestaticinherited

get the maximum length for the field

◆ GetLength() [2/2]

static Int32 Ict.Common.Data.TTypedDataTable.GetLength ( string  ATableName,
string  AColumnName 
)
inlinestaticinherited

get the maximum length for the field

◆ GetLocalityDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetLocalityDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetLocalityHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetLocalityHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetLocalityLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetLocalityLength ( )
inlinestatic

get character length for column

◆ GetLocationKeyDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetLocationKeyDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetLocationKeyHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetLocationKeyHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetLocationKeyLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetLocationKeyLength ( )
inlinestatic

get character length for column

◆ GetModificationIdDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetModificationIdDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetModificationIdHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetModificationIdLength ( )
inlinestatic

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetModifiedByDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetModifiedByHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetModifiedByLength ( )
inlinestatic

get character length for column

◆ GetPostalCodeDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetPostalCodeDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetPostalCodeHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetPostalCodeHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetPostalCodeLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetPostalCodeLength ( )
inlinestatic

get character length for column

◆ GetPrimaryKeyColumnOrdList()

static int[] Ict.Common.Data.TTypedDataTable.GetPrimaryKeyColumnOrdList ( short  ATableNumber)
inlinestaticinherited

get the order number of the columns that are part of the primary key

◆ GetPrimaryKeyColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetPrimaryKeyColumnStringList ( short  ATableNumber)
inlinestaticinherited

get the names of the columns that are part of the primary key

◆ GetRestrictedDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetRestrictedDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetRestrictedHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetRestrictedHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetRestrictedLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetRestrictedLength ( )
inlinestatic

get character length for column

◆ GetSiteKeyDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetSiteKeyDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetSiteKeyHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetSiteKeyHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetSiteKeyLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetSiteKeyLength ( )
inlinestatic

get character length for column

◆ GetStreetNameDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetStreetNameDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetStreetNameHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetStreetNameHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetStreetNameLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetStreetNameLength ( )
inlinestatic

get character length for column

◆ GetSuburbDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetSuburbDBName ( )
inlinestatic

get the name of the field in the database for this column

◆ GetSuburbHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetSuburbHelp ( )
inlinestatic

get the help text for the field in the database for this column

◆ GetSuburbLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetSuburbLength ( )
inlinestatic

get character length for column

◆ GetTableByName()

static TTypedTableInfo Ict.Common.Data.TTypedDataTable.GetTableByName ( string  ATableName)
inlinestaticinherited

the table name in CamelCase

◆ GetTableDBLabel()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetTableDBLabel ( )
inlinestatic

static method to return the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about)

◆ GetTableDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetTableDBName ( )
inlinestatic

return the name of the table as it is used in the database

◆ GetTableName() [1/2]

static string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.GetTableName ( )
inlinestatic

return the CamelCase name of the table

◆ GetTableName() [2/2]

static string Ict.Common.Data.TTypedDataTable.GetTableName ( short  ATableNumber)
inlinestaticinherited

the table name in CamelCase

◆ GetTableNameSQL()

static string Ict.Common.Data.TTypedDataTable.GetTableNameSQL ( short  ATableNumber)
inlinestaticinherited

the table name as it is in the SQL database

◆ GetUniqueKeyColumnOrdList()

static int[] Ict.Common.Data.TTypedDataTable.GetUniqueKeyColumnOrdList ( short  ATableNumber)
inlinestaticinherited

get the order number of the columns that are part of a unique key

◆ GetUniqueKeyColumnStringList()

static string[] Ict.Common.Data.TTypedDataTable.GetUniqueKeyColumnStringList ( short  ATableNumber)
inlinestaticinherited

get the names of the columns that are part of the unique key

◆ InitClass()

override void Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.InitClass ( )
inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

override void Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.InitVars ( )
inlinevirtual

assign columns to properties, set primary key

Implements Ict.Common.Data.TTypedDataTable.

◆ IsAvailableForCustomReport()

virtual bool Ict.Common.Data.TTypedDataTable.IsAvailableForCustomReport ( )
inlinevirtualinherited

Is this table generally available in custom reports?

◆ NewRowFromBuilder()

override System.Data.DataRow Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.NewRowFromBuilder ( System.Data.DataRowBuilder  builder)
inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

PLocationRow Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

PLocationRow Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.NewRowTyped ( bool  AWithDefaultValues)
inline

create a new typed row

◆ RemoveColumnsNotInTableTemplate()

void Ict.Common.Data.TTypedDataTable.RemoveColumnsNotInTableTemplate ( DataTable  ATableTemplate)
inlineinherited

remove columns that are not needed

Parameters
ATableTemplatethis table only contains the columns that should be kept

◆ ResetStaticVariables()

static void Ict.Common.Data.TTypedDataTable.ResetStaticVariables ( )
inlinestaticinherited

reset the static variables for each Web Request call.

Member Data Documentation

◆ ColumnAddress3

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnAddress3

This is the third element of an address (if required)

◆ ColumnAddress3Id

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnAddress3Id = 11
static

used for generic TTypedDataTable functions

◆ ColumnBuilding1

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnBuilding1

The name of the building.

◆ ColumnBuilding1Id

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnBuilding1Id = 2
static

used for generic TTypedDataTable functions

◆ ColumnBuilding2

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnBuilding2

The name of the building (continued)

◆ ColumnBuilding2Id

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnBuilding2Id = 3
static

used for generic TTypedDataTable functions

◆ ColumnCity

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnCity

This can be a post town or city.

◆ ColumnCityId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnCityId = 7
static

used for generic TTypedDataTable functions

◆ ColumnCountryCode

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnCountryCode

This is a code which identifies a country. It is taken from the ISO 3166-1-alpha-2 code elements.

◆ ColumnCountryCodeId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnCountryCodeId = 10
static

used for generic TTypedDataTable functions

◆ ColumnCounty

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnCounty

This can be a county (UK), a state (US), province (CDN), canton (CH) etc.

◆ ColumnCountyId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnCountyId = 8
static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnCreatedBy

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnCreatedById = 19
static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnDateCreated

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnDateCreatedId = 18
static

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnDateModified

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnDateModifiedId = 20
static

used for generic TTypedDataTable functions

◆ ColumnGeoAccuracy

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoAccuracy

The accuracy of the stored geo data; -2: server did not respond; -1: not processed yet; 0: Unknown Location; 1: Country level accuracy; 2: Region; 3: Sub-Region; 4: Town/City/Village; 5: Post code; 6: Street; 7: Intersection; 8: Address level accuracy.

◆ ColumnGeoAccuracyId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoAccuracyId = 16
static

used for generic TTypedDataTable functions

◆ ColumnGeoKmX

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoKmX

The distance in km of this location to the location 0 if location 0 was on the same longitude; this is for improving query performance.

◆ ColumnGeoKmXId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoKmXId = 14
static

used for generic TTypedDataTable functions

◆ ColumnGeoKmY

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoKmY

The distance in km of this location to the location 0 if location 0 was on the same latitude; this is for improving query performance.

◆ ColumnGeoKmYId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoKmYId = 15
static

used for generic TTypedDataTable functions

◆ ColumnGeoLatitude

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoLatitude

The latitude of the location; a number between -90 and +90; precision is 6 digits (11cm)

◆ ColumnGeoLatitudeId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoLatitudeId = 12
static

used for generic TTypedDataTable functions

◆ ColumnGeoLongitude

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoLongitude

The longitude of the location; a number between -180 and +180; precision is 6 digits (11cm)

◆ ColumnGeoLongitudeId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnGeoLongitudeId = 13
static

used for generic TTypedDataTable functions

◆ ColumnLocality

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnLocality

This is the first element of an address.

◆ ColumnLocalityId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnLocalityId = 5
static

used for generic TTypedDataTable functions

◆ ColumnLocationKey

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnLocationKey

◆ ColumnLocationKeyId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnLocationKeyId = 1
static

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnModificationId

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnModificationIdId = 22
static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnModifiedBy

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnModifiedById = 21
static

used for generic TTypedDataTable functions

◆ ColumnPostalCode

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnPostalCode

This is the national post code.

◆ ColumnPostalCodeId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnPostalCodeId = 9
static

used for generic TTypedDataTable functions

◆ ColumnRestricted

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnRestricted

Indicates whether or not the location has restricted access. If it does then the access will be controlled by s_group_location.

◆ ColumnRestrictedId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnRestrictedId = 17
static

used for generic TTypedDataTable functions

◆ ColumnSiteKey

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnSiteKey

This is the key that tell what site created this location, it will help to merge addresses when doing imports.

◆ ColumnSiteKeyId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnSiteKeyId = 0
static

used for generic TTypedDataTable functions

◆ ColumnStreetName

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnStreetName

The name of the street that the house is located on.

◆ ColumnStreetNameId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnStreetNameId = 4
static

used for generic TTypedDataTable functions

◆ ColumnSuburb

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnSuburb

The name of the suburb.

◆ ColumnSuburbId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.ColumnSuburbId = 6
static

used for generic TTypedDataTable functions

◆ DontThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataTable.DontThrowAwayAfterSubmitChanges = false
inherited

if you want no warning about that the datatable should be cleared after submitchanges. in some cases you must keep the data, eg when you need the new keys after INSERT

◆ TableId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.TableId = 38
static

TableId for Ict.Common.Data generic functions.

◆ TableInfo

SortedList<short, TTypedTableInfo> Ict.Common.Data.TTypedDataTable.TableInfo = new SortedList <short, TTypedTableInfo>()
staticprotectedinherited

stores information about typed tables

◆ ThrowAwayAfterSubmitChanges

bool Ict.Common.Data.TTypedDataTable.ThrowAwayAfterSubmitChanges = false
inherited

if you want the datatable to be cleared after submitchanges. This will increase the speed significantly: no updating of modificationID, no slow AcceptChanges.

Property Documentation

◆ Count

int Ict.Common.Data.TTypedDataTable.Count
getinherited

the number of rows in the current table

◆ TableDBLabel

override string Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.TableDBLabel
get

instance property to get the 'Label' of the table as it is used in the database (the 'Label' is usually a short description of what the db table is about)

◆ this[int i]

PLocationRow Ict.Petra.Shared.MPartner.Partner.Data.PLocationTable.this[int i]
get

Access a typed row by index.


The documentation for this class was generated from the following file: