Holds various Partner Attribute Types. More...

Inheritance diagram for Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable:

Public Member Functions
	PPartnerAttributeTypeTable ()
	constructor More...

	PPartnerAttributeTypeTable (string ATablename)
	constructor More...

	PPartnerAttributeTypeTable (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...

PPartnerAttributeTypeRow	NewRowTyped (bool AWithDefaultValues)
	create a new typed row More...

PPartnerAttributeTypeRow	NewRowTyped ()
	create a new typed row, always with default values More...

PPartnerAttributeTypeTable	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	GetCategoryCodeDBName ()
	get the name of the field in the database for this column More...

static short	GetCategoryCodeLength ()
	get character length for column More...

static string	GetCategoryCodeHelp ()
	get the help text for the field in the database for this column More...

static string	GetAttributeTypeDBName ()
	get the name of the field in the database for this column More...

static short	GetAttributeTypeLength ()
	get character length for column More...

static string	GetAttributeTypeHelp ()
	get the help text for the field in the database for this column More...

static string	GetDescriptionDBName ()
	get the name of the field in the database for this column More...

static short	GetDescriptionLength ()
	get character length for column More...

static string	GetDescriptionHelp ()
	get the help text for the field in the database for this column More...

static string	GetIndexDBName ()
	get the name of the field in the database for this column More...

static short	GetIndexLength ()
	get character length for column More...

static string	GetIndexHelp ()
	get the help text for the field in the database for this column More...

static string	GetAttributeTypeValueKindDBName ()
	get the name of the field in the database for this column More...

static short	GetAttributeTypeValueKindLength ()
	get character length for column More...

static string	GetAttributeTypeValueKindHelp ()
	get the help text for the field in the database for this column More...

static string	GetHyperlinkFormatDBName ()
	get the name of the field in the database for this column More...

static short	GetHyperlinkFormatLength ()
	get character length for column More...

static string	GetHyperlinkFormatHelp ()
	get the help text for the field in the database for this column More...

static string	GetSpecialLabelDBName ()
	get the name of the field in the database for this column More...

static short	GetSpecialLabelLength ()
	get character length for column More...

static string	GetSpecialLabelHelp ()
	get the help text for the field in the database for this column More...

static string	GetUnassignableDBName ()
	get the name of the field in the database for this column More...

static short	GetUnassignableLength ()
	get character length for column More...

static string	GetUnassignableHelp ()
	get the help text for the field in the database for this column More...

static string	GetUnassignableDateDBName ()
	get the name of the field in the database for this column More...

static short	GetUnassignableDateLength ()
	get character length for column More...

static string	GetUnassignableDateHelp ()
	get the help text for the field in the database for this column More...

static string	GetDeletableDBName ()
	get the name of the field in the database for this column More...

static short	GetDeletableLength ()
	get character length for column More...

static string	GetDeletableHelp ()
	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	ColumnCategoryCode
	Category of the Partner Attribute Type. More...

DataColumn	ColumnAttributeType
	Attribute Type. This can be anything really: Phone Number, Mobile Number, Email Address, etc (not limited to Partner Contact Details, though). Use singular words/phrases (e.g. 'Phone Number' and not 'Phone Numbers'). More...

DataColumn	ColumnDescription
	Description of what this Partner Attribute Type is all about. More...

DataColumn	ColumnIndex
	Allows for manual ordering of Partner Attribute Types by the user (e.g. to list all Partner Attributes that have a Partner Attribute Type of 'phone number' grouped together first, then list all that have a Partner Attribute Type of 'assistant phone number' grouped together). More...

DataColumn	ColumnAttributeTypeValueKind
	Describes the kind (type) of Value that the Partner Attributes that are linked to this Partner Attribute Type are. Valid values for Contact Detail Attributes: 'CONTACTDETAIL_GENERAL', 'CONTACTDETAIL_HYPERLINK', 'CONTACTDETAIL_HYPERLINK_WITHVALUE', 'CONTACTDETAIL_EMAILADDRESS', 'CONTACTDETAIL_SKYPEID'. More...

DataColumn	ColumnHyperlinkFormat
	For use with p_attribute_type_value_kind_c 'CONTACTDETAIL_HYPERLINK_WITHVALUE' only. Specifies how to 'construct' a hyperlink where the Value of a Partner Attribute is part of the URL. More...

DataColumn	ColumnSpecialLabel
	Label that should be displayed/printed instead of p_code_c if a Partner Attribute's 'specialised' Flag is set. More...

DataColumn	ColumnUnassignable
	Can this Partner Attribute Type be assigned? More...

DataColumn	ColumnUnassignableDate
	This is the date where the record was set to unassignable. More...

DataColumn	ColumnDeletable
	Flag to indicate whether this Partner Attribute Type is deletable by a user or not. 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 = 42
	TableId for Ict.Common.Data generic functions. More...

static readonly short	ColumnCategoryCodeId = 0
	used for generic TTypedDataTable functions More...

static readonly short	ColumnAttributeTypeId = 1
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDescriptionId = 2
	used for generic TTypedDataTable functions More...

static readonly short	ColumnIndexId = 3
	used for generic TTypedDataTable functions More...

static readonly short	ColumnAttributeTypeValueKindId = 4
	used for generic TTypedDataTable functions More...

static readonly short	ColumnHyperlinkFormatId = 5
	used for generic TTypedDataTable functions More...

static readonly short	ColumnSpecialLabelId = 6
	used for generic TTypedDataTable functions More...

static readonly short	ColumnUnassignableId = 7
	used for generic TTypedDataTable functions More...

static readonly short	ColumnUnassignableDateId = 8
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDeletableId = 9
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDateCreatedId = 10
	used for generic TTypedDataTable functions More...

static readonly short	ColumnCreatedById = 11
	used for generic TTypedDataTable functions More...

static readonly short	ColumnDateModifiedId = 12
	used for generic TTypedDataTable functions More...

static readonly short	ColumnModifiedById = 13
	used for generic TTypedDataTable functions More...

static readonly short	ColumnModificationIdId = 14
	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, TTypedTableInfo >	TableInfo = new SortedList <short, TTypedTableInfo>()
	stores information about typed tables More...

Properties
PPartnerAttributeTypeRow	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

Holds various Partner Attribute Types.

Constructor & Destructor Documentation

◆ PPartnerAttributeTypeTable() [1/3]

Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.PPartnerAttributeTypeTable ( )

inline

constructor

◆ PPartnerAttributeTypeTable() [2/3]

Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.PPartnerAttributeTypeTable ( string ATablename )

inline

constructor

◆ PPartnerAttributeTypeTable() [3/3]

Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.PPartnerAttributeTypeTable	(	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.PPartnerAttributeTypeTable.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

◆ GetAttributeTypeDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetAttributeTypeDBName ( )

inlinestatic

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

◆ GetAttributeTypeHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetAttributeTypeHelp ( )

inlinestatic

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

◆ GetAttributeTypeLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetAttributeTypeLength ( )

inlinestatic

get character length for column

◆ GetAttributeTypeValueKindDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetAttributeTypeValueKindDBName ( )

inlinestatic

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

◆ GetAttributeTypeValueKindHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetAttributeTypeValueKindHelp ( )

inlinestatic

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

◆ GetAttributeTypeValueKindLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetAttributeTypeValueKindLength ( )

inlinestatic

get character length for column

◆ GetCategoryCodeDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetCategoryCodeDBName ( )

inlinestatic

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

◆ GetCategoryCodeHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetCategoryCodeHelp ( )

inlinestatic

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

◆ GetCategoryCodeLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetCategoryCodeLength ( )

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()

PPartnerAttributeTypeTable Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.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

◆ 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

◆ GetCreatedByDBName()

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

inlinestatic

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

◆ GetCreatedByHelp()

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

inlinestatic

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

◆ GetCreatedByLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.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.PPartnerAttributeTypeTable.GetDateCreatedDBName ( )

inlinestatic

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

◆ GetDateCreatedHelp()

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

inlinestatic

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

◆ GetDateCreatedLength()

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

inlinestatic

get character length for column

◆ GetDateModifiedDBName()

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

inlinestatic

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

◆ GetDateModifiedHelp()

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

inlinestatic

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

◆ GetDateModifiedLength()

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

inlinestatic

get character length for column

◆ GetDeletableDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetDeletableDBName ( )

inlinestatic

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

◆ GetDeletableHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetDeletableHelp ( )

inlinestatic

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

◆ GetDeletableLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetDeletableLength ( )

inlinestatic

get character length for column

◆ GetDescriptionDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetDescriptionDBName ( )

inlinestatic

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

◆ GetDescriptionHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetDescriptionHelp ( )

inlinestatic

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

◆ GetDescriptionLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetDescriptionLength ( )

inlinestatic

get character length for column

◆ GetHyperlinkFormatDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetHyperlinkFormatDBName ( )

inlinestatic

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

◆ GetHyperlinkFormatHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetHyperlinkFormatHelp ( )

inlinestatic

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

◆ GetHyperlinkFormatLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetHyperlinkFormatLength ( )

inlinestatic

get character length for column

◆ GetIndexDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetIndexDBName ( )

inlinestatic

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

◆ GetIndexHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetIndexHelp ( )

inlinestatic

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

◆ GetIndexLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetIndexLength ( )

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

◆ GetModificationIdDBName()

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

inlinestatic

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

◆ GetModificationIdHelp()

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

inlinestatic

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

◆ GetModificationIdLength()

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

inlinestatic

get character length for column

◆ GetModifiedByDBName()

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

inlinestatic

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

◆ GetModifiedByHelp()

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

inlinestatic

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

◆ GetModifiedByLength()

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

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

◆ GetSpecialLabelDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetSpecialLabelDBName ( )

inlinestatic

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

◆ GetSpecialLabelHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetSpecialLabelHelp ( )

inlinestatic

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

◆ GetSpecialLabelLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetSpecialLabelLength ( )

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.PPartnerAttributeTypeTable.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.PPartnerAttributeTypeTable.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.PPartnerAttributeTypeTable.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

◆ GetUnassignableDateDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetUnassignableDateDBName ( )

inlinestatic

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

◆ GetUnassignableDateHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetUnassignableDateHelp ( )

inlinestatic

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

◆ GetUnassignableDateLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetUnassignableDateLength ( )

inlinestatic

get character length for column

◆ GetUnassignableDBName()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetUnassignableDBName ( )

inlinestatic

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

◆ GetUnassignableHelp()

static string Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetUnassignableHelp ( )

inlinestatic

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

◆ GetUnassignableLength()

static short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.GetUnassignableLength ( )

inlinestatic

get character length for column

◆ 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.PPartnerAttributeTypeTable.InitClass ( )

inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

override void Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.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.PPartnerAttributeTypeTable.NewRowFromBuilder ( System.Data.DataRowBuilder builder )

inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

PPartnerAttributeTypeRow Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.NewRowTyped ( )

inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

PPartnerAttributeTypeRow Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.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

ATableTemplate this 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

◆ ColumnAttributeType

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnAttributeType

Attribute Type. This can be anything really: Phone Number, Mobile Number, Email Address, etc (not limited to Partner Contact Details, though). Use singular words/phrases (e.g. 'Phone Number' and not 'Phone Numbers').

◆ ColumnAttributeTypeId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnAttributeTypeId = 1

static

used for generic TTypedDataTable functions

◆ ColumnAttributeTypeValueKind

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnAttributeTypeValueKind

Describes the kind (type) of Value that the Partner Attributes that are linked to this Partner Attribute Type are. Valid values for Contact Detail Attributes: 'CONTACTDETAIL_GENERAL', 'CONTACTDETAIL_HYPERLINK', 'CONTACTDETAIL_HYPERLINK_WITHVALUE', 'CONTACTDETAIL_EMAILADDRESS', 'CONTACTDETAIL_SKYPEID'.

◆ ColumnAttributeTypeValueKindId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnAttributeTypeValueKindId = 4

static

used for generic TTypedDataTable functions

◆ ColumnCategoryCode

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnCategoryCode

Category of the Partner Attribute Type.

◆ ColumnCategoryCodeId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnCategoryCodeId = 0

static

used for generic TTypedDataTable functions

◆ ColumnCreatedBy

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

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnCreatedById = 11

static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

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

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnDateCreatedId = 10

static

used for generic TTypedDataTable functions

◆ ColumnDateModified

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

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnDateModifiedId = 12

static

used for generic TTypedDataTable functions

◆ ColumnDeletable

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnDeletable

Flag to indicate whether this Partner Attribute Type is deletable by a user or not.

◆ ColumnDeletableId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnDeletableId = 9

static

used for generic TTypedDataTable functions

◆ ColumnDescription

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnDescription

Description of what this Partner Attribute Type is all about.

◆ ColumnDescriptionId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnDescriptionId = 2

static

used for generic TTypedDataTable functions

◆ ColumnHyperlinkFormat

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnHyperlinkFormat

For use with p_attribute_type_value_kind_c 'CONTACTDETAIL_HYPERLINK_WITHVALUE' only. Specifies how to 'construct' a hyperlink where the Value of a Partner Attribute is part of the URL.

◆ ColumnHyperlinkFormatId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnHyperlinkFormatId = 5

static

used for generic TTypedDataTable functions

◆ ColumnIndex

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnIndex

Allows for manual ordering of Partner Attribute Types by the user (e.g. to list all Partner Attributes that have a Partner Attribute Type of 'phone number' grouped together first, then list all that have a Partner Attribute Type of 'assistant phone number' grouped together).

◆ ColumnIndexId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnIndexId = 3

static

used for generic TTypedDataTable functions

◆ ColumnModificationId

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

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnModificationIdId = 14

static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

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

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnModifiedById = 13

static

used for generic TTypedDataTable functions

◆ ColumnSpecialLabel

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnSpecialLabel

Label that should be displayed/printed instead of p_code_c if a Partner Attribute's 'specialised' Flag is set.

◆ ColumnSpecialLabelId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnSpecialLabelId = 6

static

used for generic TTypedDataTable functions

◆ ColumnUnassignable

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnUnassignable

Can this Partner Attribute Type be assigned?

◆ ColumnUnassignableDate

DataColumn Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnUnassignableDate

This is the date where the record was set to unassignable.

◆ ColumnUnassignableDateId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnUnassignableDateId = 8

static

used for generic TTypedDataTable functions

◆ ColumnUnassignableId

readonly short Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.ColumnUnassignableId = 7

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.PPartnerAttributeTypeTable.TableId = 42

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.PPartnerAttributeTypeTable.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]

PPartnerAttributeTypeRow Ict.Petra.Shared.MPartner.Partner.Data.PPartnerAttributeTypeTable.this[int i]

get

Access a typed row by index.

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

csharp/ICT/Petra/Shared/lib/data/Partner.Tables-generated.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Static Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PPartnerAttributeTypeTable() [1/3]

◆ PPartnerAttributeTypeTable() [2/3]

◆ PPartnerAttributeTypeTable() [3/3]

Member Function Documentation

◆ CreateOdbcParameter() [1/3]

◆ CreateOdbcParameter() [2/3]

◆ CreateOdbcParameter() [3/3]

◆ GetAttributeTypeDBName()

◆ GetAttributeTypeHelp()

◆ GetAttributeTypeLength()

◆ GetAttributeTypeValueKindDBName()

◆ GetAttributeTypeValueKindHelp()

◆ GetAttributeTypeValueKindLength()

◆ GetCategoryCodeDBName()

◆ GetCategoryCodeHelp()

◆ GetCategoryCodeLength()

◆ GetChanges()

◆ GetChangesTyped()

◆ GetChangesTypedInternal()

◆ GetColumnNameSQL()

◆ GetColumnStringList()

◆ GetCreatedByDBName()

◆ GetCreatedByHelp()

◆ GetCreatedByLength()

◆ GetCustomReportFieldList()

◆ GetCustomReportPermission()

◆ GetDateCreatedDBName()

◆ GetDateCreatedHelp()

◆ GetDateCreatedLength()

◆ GetDateModifiedDBName()

◆ GetDateModifiedHelp()

◆ GetDateModifiedLength()

◆ GetDeletableDBName()

◆ GetDeletableHelp()

◆ GetDeletableLength()

◆ GetDescriptionDBName()

◆ GetDescriptionHelp()

◆ GetDescriptionLength()

◆ GetHyperlinkFormatDBName()

◆ GetHyperlinkFormatHelp()

◆ GetHyperlinkFormatLength()

◆ GetIndexDBName()

◆ GetIndexHelp()

◆ GetIndexLength()

◆ GetKeyColumnStringList()

◆ GetLabel()

◆ GetLength() [1/2]

◆ GetLength() [2/2]

◆ GetModificationIdDBName()

◆ GetModificationIdHelp()

◆ GetModificationIdLength()

◆ GetModifiedByDBName()

◆ GetModifiedByHelp()

◆ GetModifiedByLength()

◆ GetPrimaryKeyColumnOrdList()

◆ GetPrimaryKeyColumnStringList()

◆ GetSpecialLabelDBName()

◆ GetSpecialLabelHelp()

◆ GetSpecialLabelLength()

◆ GetTableByName()

◆ GetTableDBLabel()

◆ GetTableDBName()

◆ GetTableName() [1/2]

◆ GetTableName() [2/2]

◆ GetTableNameSQL()

◆ GetUnassignableDateDBName()

◆ GetUnassignableDateHelp()

◆ GetUnassignableDateLength()

◆ GetUnassignableDBName()

◆ GetUnassignableHelp()

◆ GetUnassignableLength()