Master file for extracts. Contains names for the extract id. More...

Inheritance diagram for Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable:

Public Member Functions
	MExtractMasterTable ()
	constructor More...

	MExtractMasterTable (string ATablename)
	constructor More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static string	GetLastRefHelp ()
	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	GetFrozenDBName ()
	get the name of the field in the database for this column More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static string	GetTemplateHelp ()
	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	ColumnExtractId
	Identifier for the extract. More...

DataColumn	ColumnExtractName
	Short name for the extract to be used in filenames. More...

DataColumn	ColumnExtractDesc
	This is a long description for the extract. More...

DataColumn	ColumnLastRef

DataColumn	ColumnDeletable

DataColumn	ColumnFrozen
	The user can set the frozen field when the extract should not be updated. More...

DataColumn	ColumnKeyCount

DataColumn	ColumnPublic

DataColumn	ColumnManualModication
	Indicates that the extract has been edited by a user. More...

DataColumn	ColumnManualModicationDate
	Date the extract was manually modified. More...

DataColumn	ColumnManualModBy
	Who made the last manual modification ? More...

DataColumn	ColumnExtractTypeCode
	Indicate the extract type. Which function was the extract created through? More...

DataColumn	ColumnTemplate
	Is this extract just a template that has not yet been run? More...

DataColumn	ColumnRestricted
	Indicates whether or not the extract has restricted access. If it does then the access will be controlled by s_group_extract. 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 = 74
	TableId for Ict.Common.Data generic functions. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

static readonly short	ColumnModificationIdId = 18
	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
MExtractMasterRow	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

Master file for extracts. Contains names for the extract id.

Constructor & Destructor Documentation

◆ MExtractMasterTable() [1/3]

Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.MExtractMasterTable ( )

inline

constructor

◆ MExtractMasterTable() [2/3]

Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.MExtractMasterTable ( string ATablename )

inline

constructor

◆ MExtractMasterTable() [3/3]

Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.MExtractMasterTable	(	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.Mailroom.Data.MExtractMasterTable.CreateOdbcParameter ( Int32 AColumnNr )

inlinevirtual

get an odbc parameter for the given column

Implements Ict.Common.Data.TTypedDataTable.

Reimplemented in Ict.Petra.Shared.MPartner.Partner.Data.ExtractTDSMExtractMasterTable.

◆ 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

◆ GetChanges()

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

inlineinherited

make sure that we use GetChangesType instead of GetChanges

Returns: throws an exception

◆ GetChangesTyped()

MExtractMasterTable Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.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.Mailroom.Data.MExtractMasterTable.GetCreatedByDBName ( )

inlinestatic

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

◆ GetCreatedByHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetCreatedByHelp ( )

inlinestatic

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

◆ GetCreatedByLength()

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

inlinestatic

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

◆ GetDateCreatedHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetDateCreatedHelp ( )

inlinestatic

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

◆ GetDateCreatedLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetDateCreatedLength ( )

inlinestatic

get character length for column

◆ GetDateModifiedDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetDateModifiedDBName ( )

inlinestatic

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

◆ GetDateModifiedHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetDateModifiedHelp ( )

inlinestatic

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

◆ GetDateModifiedLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetDateModifiedLength ( )

inlinestatic

get character length for column

◆ GetDeletableDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetDeletableDBName ( )

inlinestatic

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

◆ GetDeletableHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetDeletableHelp ( )

inlinestatic

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

◆ GetDeletableLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetDeletableLength ( )

inlinestatic

get character length for column

◆ GetExtractDescDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractDescDBName ( )

inlinestatic

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

◆ GetExtractDescHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractDescHelp ( )

inlinestatic

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

◆ GetExtractDescLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractDescLength ( )

inlinestatic

get character length for column

◆ GetExtractIdDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractIdDBName ( )

inlinestatic

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

◆ GetExtractIdHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractIdHelp ( )

inlinestatic

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

◆ GetExtractIdLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractIdLength ( )

inlinestatic

get character length for column

◆ GetExtractNameDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractNameDBName ( )

inlinestatic

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

◆ GetExtractNameHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractNameHelp ( )

inlinestatic

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

◆ GetExtractNameLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractNameLength ( )

inlinestatic

get character length for column

◆ GetExtractTypeCodeDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractTypeCodeDBName ( )

inlinestatic

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

◆ GetExtractTypeCodeHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractTypeCodeHelp ( )

inlinestatic

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

◆ GetExtractTypeCodeLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetExtractTypeCodeLength ( )

inlinestatic

get character length for column

◆ GetFrozenDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetFrozenDBName ( )

inlinestatic

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

◆ GetFrozenHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetFrozenHelp ( )

inlinestatic

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

◆ GetFrozenLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetFrozenLength ( )

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

◆ GetKeyCountDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetKeyCountDBName ( )

inlinestatic

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

◆ GetKeyCountHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetKeyCountHelp ( )

inlinestatic

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

◆ GetKeyCountLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetKeyCountLength ( )

inlinestatic

get character length for column

◆ GetLabel()

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

inlinestaticinherited

returns the translated label for the column

◆ GetLastRefDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetLastRefDBName ( )

inlinestatic

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

◆ GetLastRefHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetLastRefHelp ( )

inlinestatic

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

◆ GetLastRefLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetLastRefLength ( )

inlinestatic

get character length for 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

◆ GetManualModByDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetManualModByDBName ( )

inlinestatic

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

◆ GetManualModByHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetManualModByHelp ( )

inlinestatic

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

◆ GetManualModByLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetManualModByLength ( )

inlinestatic

get character length for column

◆ GetManualModicationDateDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetManualModicationDateDBName ( )

inlinestatic

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

◆ GetManualModicationDateHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetManualModicationDateHelp ( )

inlinestatic

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

◆ GetManualModicationDateLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetManualModicationDateLength ( )

inlinestatic

get character length for column

◆ GetManualModicationDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetManualModicationDBName ( )

inlinestatic

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

◆ GetManualModicationHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetManualModicationHelp ( )

inlinestatic

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

◆ GetManualModicationLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetManualModicationLength ( )

inlinestatic

get character length for column

◆ GetModificationIdDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetModificationIdDBName ( )

inlinestatic

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

◆ GetModificationIdHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetModificationIdHelp ( )

inlinestatic

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

◆ GetModificationIdLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetModificationIdLength ( )

inlinestatic

get character length for column

◆ GetModifiedByDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetModifiedByDBName ( )

inlinestatic

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

◆ GetModifiedByHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetModifiedByHelp ( )

inlinestatic

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

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.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

◆ GetPublicDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetPublicDBName ( )

inlinestatic

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

◆ GetPublicHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetPublicHelp ( )

inlinestatic

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

◆ GetPublicLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetPublicLength ( )

inlinestatic

get character length for column

◆ GetRestrictedDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetRestrictedDBName ( )

inlinestatic

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

◆ GetRestrictedHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetRestrictedHelp ( )

inlinestatic

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

◆ GetRestrictedLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetRestrictedLength ( )

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.Mailroom.Data.MExtractMasterTable.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.Mailroom.Data.MExtractMasterTable.GetTableDBName ( )

inlinestatic

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

◆ GetTableName() [1/2]

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.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

◆ GetTemplateDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetTemplateDBName ( )

inlinestatic

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

◆ GetTemplateHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetTemplateHelp ( )

inlinestatic

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

◆ GetTemplateLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.GetTemplateLength ( )

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.Mailroom.Data.MExtractMasterTable.InitClass ( )

inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

Reimplemented in Ict.Petra.Shared.MPartner.Partner.Data.ExtractTDSMExtractMasterTable.

◆ InitVars()

override void Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.InitVars ( )

inlinevirtual

assign columns to properties, set primary key

Implements Ict.Common.Data.TTypedDataTable.

Reimplemented in Ict.Petra.Shared.MPartner.Partner.Data.ExtractTDSMExtractMasterTable.

◆ 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.Mailroom.Data.MExtractMasterTable.NewRowFromBuilder ( System.Data.DataRowBuilder builder )

inlineprotected

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

MExtractMasterRow Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.NewRowTyped ( )

inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

MExtractMasterRow Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.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

◆ ColumnCreatedBy

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnCreatedBy

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnCreatedById = 15

static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnDateCreated

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnDateCreatedId = 14

static

used for generic TTypedDataTable functions

◆ ColumnDateModified

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnDateModified

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnDateModifiedId = 16

static

used for generic TTypedDataTable functions

◆ ColumnDeletable

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnDeletable

◆ ColumnDeletableId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnDeletableId = 4

static

used for generic TTypedDataTable functions

◆ ColumnExtractDesc

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnExtractDesc

This is a long description for the extract.

◆ ColumnExtractDescId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnExtractDescId = 2

static

used for generic TTypedDataTable functions

◆ ColumnExtractId

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnExtractId

Identifier for the extract.

◆ ColumnExtractIdId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnExtractIdId = 0

static

used for generic TTypedDataTable functions

◆ ColumnExtractName

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnExtractName

Short name for the extract to be used in filenames.

◆ ColumnExtractNameId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnExtractNameId = 1

static

used for generic TTypedDataTable functions

◆ ColumnExtractTypeCode

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnExtractTypeCode

Indicate the extract type. Which function was the extract created through?

◆ ColumnExtractTypeCodeId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnExtractTypeCodeId = 11

static

used for generic TTypedDataTable functions

◆ ColumnFrozen

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnFrozen

The user can set the frozen field when the extract should not be updated.

◆ ColumnFrozenId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnFrozenId = 5

static

used for generic TTypedDataTable functions

◆ ColumnKeyCount

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnKeyCount

◆ ColumnKeyCountId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnKeyCountId = 6

static

used for generic TTypedDataTable functions

◆ ColumnLastRef

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnLastRef

◆ ColumnLastRefId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnLastRefId = 3

static

used for generic TTypedDataTable functions

◆ ColumnManualModBy

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnManualModBy

Who made the last manual modification ?

◆ ColumnManualModById

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnManualModById = 10

static

used for generic TTypedDataTable functions

◆ ColumnManualModication

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnManualModication

Indicates that the extract has been edited by a user.

◆ ColumnManualModicationDate

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnManualModicationDate

Date the extract was manually modified.

◆ ColumnManualModicationDateId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnManualModicationDateId = 9

static

used for generic TTypedDataTable functions

◆ ColumnManualModicationId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnManualModicationId = 8

static

used for generic TTypedDataTable functions

◆ ColumnModificationId

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnModificationId

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnModificationIdId = 18

static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnModifiedBy

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnModifiedById = 17

static

used for generic TTypedDataTable functions

◆ ColumnPublic

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnPublic

◆ ColumnPublicId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnPublicId = 7

static

used for generic TTypedDataTable functions

◆ ColumnRestricted

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnRestricted

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

◆ ColumnRestrictedId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnRestrictedId = 13

static

used for generic TTypedDataTable functions

◆ ColumnTemplate

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnTemplate

Is this extract just a template that has not yet been run?

◆ ColumnTemplateId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.ColumnTemplateId = 12

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.Mailroom.Data.MExtractMasterTable.TableId = 74

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.Mailroom.Data.MExtractMasterTable.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]

MExtractMasterRow Ict.Petra.Shared.MPartner.Mailroom.Data.MExtractMasterTable.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/Mailroom.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

◆ MExtractMasterTable() [1/3]

◆ MExtractMasterTable() [2/3]

◆ MExtractMasterTable() [3/3]

Member Function Documentation

◆ CreateOdbcParameter() [1/3]

◆ CreateOdbcParameter() [2/3]

◆ CreateOdbcParameter() [3/3]

◆ GetChanges()

◆ GetChangesTyped()

◆ GetChangesTypedInternal()

◆ GetColumnNameSQL()

◆ GetColumnStringList()

◆ GetCreatedByDBName()

◆ GetCreatedByHelp()

◆ GetCreatedByLength()

◆ GetCustomReportFieldList()

◆ GetCustomReportPermission()

◆ GetDateCreatedDBName()

◆ GetDateCreatedHelp()

◆ GetDateCreatedLength()

◆ GetDateModifiedDBName()

◆ GetDateModifiedHelp()

◆ GetDateModifiedLength()

◆ GetDeletableDBName()

◆ GetDeletableHelp()

◆ GetDeletableLength()

◆ GetExtractDescDBName()

◆ GetExtractDescHelp()

◆ GetExtractDescLength()

◆ GetExtractIdDBName()

◆ GetExtractIdHelp()

◆ GetExtractIdLength()

◆ GetExtractNameDBName()

◆ GetExtractNameHelp()

◆ GetExtractNameLength()

◆ GetExtractTypeCodeDBName()

◆ GetExtractTypeCodeHelp()

◆ GetExtractTypeCodeLength()

◆ GetFrozenDBName()

◆ GetFrozenHelp()

◆ GetFrozenLength()

◆ GetKeyColumnStringList()

◆ GetKeyCountDBName()

◆ GetKeyCountHelp()

◆ GetKeyCountLength()

◆ GetLabel()

◆ GetLastRefDBName()

◆ GetLastRefHelp()

◆ GetLastRefLength()

◆ GetLength() [1/2]

◆ GetLength() [2/2]

◆ GetManualModByDBName()

◆ GetManualModByHelp()

◆ GetManualModByLength()

◆ GetManualModicationDateDBName()

◆ GetManualModicationDateHelp()

◆ GetManualModicationDateLength()

◆ GetManualModicationDBName()

◆ GetManualModicationHelp()

◆ GetManualModicationLength()

◆ GetModificationIdDBName()

◆ GetModificationIdHelp()

◆ GetModificationIdLength()

◆ GetModifiedByDBName()

◆ GetModifiedByHelp()

◆ GetModifiedByLength()

◆ GetPrimaryKeyColumnOrdList()

◆ GetPrimaryKeyColumnStringList()

◆ GetPublicDBName()

◆ GetPublicHelp()

◆ GetPublicLength()