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

Details of which partners receive which publications. More...

Inheritance diagram for Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable:
Ict.Common.Data.TTypedDataTable

Public Member Functions

 PSubscriptionTable ()
 constructor More...
 
 PSubscriptionTable (string ATablename)
 constructor More...
 
 PSubscriptionTable (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...
 
PSubscriptionRow NewRowTyped (bool AWithDefaultValues)
 create a new typed row More...
 
PSubscriptionRow NewRowTyped ()
 create a new typed row, always with default values More...
 
PSubscriptionTable 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 GetPublicationCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetPublicationCodeLength ()
 get character length for column More...
 
static string GetPublicationCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetPartnerKeyDBName ()
 get the name of the field in the database for this column More...
 
static short GetPartnerKeyLength ()
 get character length for column More...
 
static string GetPartnerKeyHelp ()
 get the help text for the field in the database for this column More...
 
static string GetPublicationCopiesDBName ()
 get the name of the field in the database for this column More...
 
static short GetPublicationCopiesLength ()
 get character length for column More...
 
static string GetPublicationCopiesHelp ()
 get the help text for the field in the database for this column More...
 
static string GetReasonSubsGivenCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetReasonSubsGivenCodeLength ()
 get character length for column More...
 
static string GetReasonSubsGivenCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetReasonSubsCancelledCodeDBName ()
 get the name of the field in the database for this column More...
 
static short GetReasonSubsCancelledCodeLength ()
 get character length for column More...
 
static string GetReasonSubsCancelledCodeHelp ()
 get the help text for the field in the database for this column More...
 
static string GetExpiryDateDBName ()
 get the name of the field in the database for this column More...
 
static short GetExpiryDateLength ()
 get character length for column More...
 
static string GetExpiryDateHelp ()
 get the help text for the field in the database for this column More...
 
static string GetProvisionalExpiryDateDBName ()
 get the name of the field in the database for this column More...
 
static short GetProvisionalExpiryDateLength ()
 get character length for column More...
 
static string GetProvisionalExpiryDateHelp ()
 get the help text for the field in the database for this column More...
 
static string GetGratisSubscriptionDBName ()
 get the name of the field in the database for this column More...
 
static short GetGratisSubscriptionLength ()
 get character length for column More...
 
static string GetGratisSubscriptionHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateNoticeSentDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateNoticeSentLength ()
 get character length for column More...
 
static string GetDateNoticeSentHelp ()
 get the help text for the field in the database for this column More...
 
static string GetDateCancelledDBName ()
 get the name of the field in the database for this column More...
 
static short GetDateCancelledLength ()
 get character length for column More...
 
static string GetDateCancelledHelp ()
 get the help text for the field in the database for this column More...
 
static string GetStartDateDBName ()
 get the name of the field in the database for this column More...
 
static short GetStartDateLength ()
 get character length for column More...
 
static string GetStartDateHelp ()
 get the help text for the field in the database for this column More...
 
static string GetNumberIssuesReceivedDBName ()
 get the name of the field in the database for this column More...
 
static short GetNumberIssuesReceivedLength ()
 get character length for column More...
 
static string GetNumberIssuesReceivedHelp ()
 get the help text for the field in the database for this column More...
 
static string GetNumberComplimentaryDBName ()
 get the name of the field in the database for this column More...
 
static short GetNumberComplimentaryLength ()
 get character length for column More...
 
static string GetNumberComplimentaryHelp ()
 get the help text for the field in the database for this column More...
 
static string GetSubscriptionRenewalDateDBName ()
 get the name of the field in the database for this column More...
 
static short GetSubscriptionRenewalDateLength ()
 get character length for column More...
 
static string GetSubscriptionRenewalDateHelp ()
 get the help text for the field in the database for this column More...
 
static string GetSubscriptionStatusDBName ()
 get the name of the field in the database for this column More...
 
static short GetSubscriptionStatusLength ()
 get character length for column More...
 
static string GetSubscriptionStatusHelp ()
 get the help text for the field in the database for this column More...
 
static string GetFirstIssueDBName ()
 get the name of the field in the database for this column More...
 
static short GetFirstIssueLength ()
 get character length for column More...
 
static string GetFirstIssueHelp ()
 get the help text for the field in the database for this column More...
 
static string GetLastIssueDBName ()
 get the name of the field in the database for this column More...
 
static short GetLastIssueLength ()
 get character length for column More...
 
static string GetLastIssueHelp ()
 get the help text for the field in the database for this column More...
 
static string GetGiftFromKeyDBName ()
 get the name of the field in the database for this column More...
 
static short GetGiftFromKeyLength ()
 get character length for column More...
 
static string GetGiftFromKeyHelp ()
 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 ColumnPublicationCode
 The is the key to the publication table. More...
 
DataColumn ColumnPartnerKey
 This is the partner key assigned to each partner. It consists of the fund id followed by a computer generated six digit number. More...
 
DataColumn ColumnPublicationCopies
 
DataColumn ColumnReasonSubsGivenCode
 
DataColumn ColumnReasonSubsCancelledCode
 
DataColumn ColumnExpiryDate
 Date the subscription expires. More...
 
DataColumn ColumnProvisionalExpiryDate
 Provisional date on which the subscription may expire. More...
 
DataColumn ColumnGratisSubscription
 
DataColumn ColumnDateNoticeSent
 
DataColumn ColumnDateCancelled
 
DataColumn ColumnStartDate
 
DataColumn ColumnNumberIssuesReceived
 
DataColumn ColumnNumberComplimentary
 The number of issues sent after a subscription has ceased. More...
 
DataColumn ColumnSubscriptionRenewalDate
 
DataColumn ColumnSubscriptionStatus
 
DataColumn ColumnFirstIssue
 
DataColumn ColumnLastIssue
 
DataColumn ColumnGiftFromKey
 
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 = 98
 TableId for Ict.Common.Data generic functions. More...
 
static readonly short ColumnPublicationCodeId = 0
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPartnerKeyId = 1
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnPublicationCopiesId = 2
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnReasonSubsGivenCodeId = 3
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnReasonSubsCancelledCodeId = 4
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnExpiryDateId = 5
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnProvisionalExpiryDateId = 6
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnGratisSubscriptionId = 7
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateNoticeSentId = 8
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnDateCancelledId = 9
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnStartDateId = 10
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnNumberIssuesReceivedId = 11
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnNumberComplimentaryId = 12
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnSubscriptionRenewalDateId = 13
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnSubscriptionStatusId = 14
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnFirstIssueId = 15
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnLastIssueId = 16
 used for generic TTypedDataTable functions More...
 
static readonly short ColumnGiftFromKeyId = 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

PSubscriptionRow 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

Details of which partners receive which publications.

Constructor & Destructor Documentation

◆ PSubscriptionTable() [1/3]

Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.PSubscriptionTable ( )
inline

constructor

◆ PSubscriptionTable() [2/3]

Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.PSubscriptionTable ( string  ATablename)
inline

constructor

◆ PSubscriptionTable() [3/3]

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

◆ GetChanges()

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

make sure that we use GetChangesType instead of GetChanges

Returns
throws an exception

◆ GetChangesTyped()

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

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

◆ GetCreatedByHelp()

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

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

◆ GetCreatedByLength()

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

◆ GetDateCancelledDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetDateCancelledDBName ( )
inlinestatic

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

◆ GetDateCancelledHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetDateCancelledHelp ( )
inlinestatic

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

◆ GetDateCancelledLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetDateCancelledLength ( )
inlinestatic

get character length for column

◆ GetDateCreatedDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetDateCreatedDBName ( )
inlinestatic

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

◆ GetDateCreatedHelp()

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

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

◆ GetDateCreatedLength()

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

get character length for column

◆ GetDateModifiedDBName()

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

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

◆ GetDateModifiedHelp()

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

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

◆ GetDateModifiedLength()

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

get character length for column

◆ GetDateNoticeSentDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetDateNoticeSentDBName ( )
inlinestatic

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

◆ GetDateNoticeSentHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetDateNoticeSentHelp ( )
inlinestatic

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

◆ GetDateNoticeSentLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetDateNoticeSentLength ( )
inlinestatic

get character length for column

◆ GetExpiryDateDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetExpiryDateDBName ( )
inlinestatic

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

◆ GetExpiryDateHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetExpiryDateHelp ( )
inlinestatic

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

◆ GetExpiryDateLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetExpiryDateLength ( )
inlinestatic

get character length for column

◆ GetFirstIssueDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetFirstIssueDBName ( )
inlinestatic

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

◆ GetFirstIssueHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetFirstIssueHelp ( )
inlinestatic

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

◆ GetFirstIssueLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetFirstIssueLength ( )
inlinestatic

get character length for column

◆ GetGiftFromKeyDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetGiftFromKeyDBName ( )
inlinestatic

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

◆ GetGiftFromKeyHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetGiftFromKeyHelp ( )
inlinestatic

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

◆ GetGiftFromKeyLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetGiftFromKeyLength ( )
inlinestatic

get character length for column

◆ GetGratisSubscriptionDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetGratisSubscriptionDBName ( )
inlinestatic

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

◆ GetGratisSubscriptionHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetGratisSubscriptionHelp ( )
inlinestatic

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

◆ GetGratisSubscriptionLength()

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

◆ GetLastIssueDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetLastIssueDBName ( )
inlinestatic

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

◆ GetLastIssueHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetLastIssueHelp ( )
inlinestatic

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

◆ GetLastIssueLength()

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

◆ GetModificationIdDBName()

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

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

◆ GetModificationIdHelp()

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

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

◆ GetModificationIdLength()

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

get character length for column

◆ GetModifiedByDBName()

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

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

◆ GetModifiedByHelp()

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

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

◆ GetModifiedByLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetModifiedByLength ( )
inlinestatic

get character length for column

◆ GetNumberComplimentaryDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetNumberComplimentaryDBName ( )
inlinestatic

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

◆ GetNumberComplimentaryHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetNumberComplimentaryHelp ( )
inlinestatic

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

◆ GetNumberComplimentaryLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetNumberComplimentaryLength ( )
inlinestatic

get character length for column

◆ GetNumberIssuesReceivedDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetNumberIssuesReceivedDBName ( )
inlinestatic

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

◆ GetNumberIssuesReceivedHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetNumberIssuesReceivedHelp ( )
inlinestatic

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

◆ GetNumberIssuesReceivedLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetNumberIssuesReceivedLength ( )
inlinestatic

get character length for column

◆ GetPartnerKeyDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetPartnerKeyDBName ( )
inlinestatic

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

◆ GetPartnerKeyHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetPartnerKeyHelp ( )
inlinestatic

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

◆ GetPartnerKeyLength()

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

◆ GetProvisionalExpiryDateDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetProvisionalExpiryDateDBName ( )
inlinestatic

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

◆ GetProvisionalExpiryDateHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetProvisionalExpiryDateHelp ( )
inlinestatic

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

◆ GetProvisionalExpiryDateLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetProvisionalExpiryDateLength ( )
inlinestatic

get character length for column

◆ GetPublicationCodeDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetPublicationCodeDBName ( )
inlinestatic

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

◆ GetPublicationCodeHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetPublicationCodeHelp ( )
inlinestatic

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

◆ GetPublicationCodeLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetPublicationCodeLength ( )
inlinestatic

get character length for column

◆ GetPublicationCopiesDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetPublicationCopiesDBName ( )
inlinestatic

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

◆ GetPublicationCopiesHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetPublicationCopiesHelp ( )
inlinestatic

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

◆ GetPublicationCopiesLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetPublicationCopiesLength ( )
inlinestatic

get character length for column

◆ GetReasonSubsCancelledCodeDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetReasonSubsCancelledCodeDBName ( )
inlinestatic

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

◆ GetReasonSubsCancelledCodeHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetReasonSubsCancelledCodeHelp ( )
inlinestatic

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

◆ GetReasonSubsCancelledCodeLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetReasonSubsCancelledCodeLength ( )
inlinestatic

get character length for column

◆ GetReasonSubsGivenCodeDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetReasonSubsGivenCodeDBName ( )
inlinestatic

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

◆ GetReasonSubsGivenCodeHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetReasonSubsGivenCodeHelp ( )
inlinestatic

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

◆ GetReasonSubsGivenCodeLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetReasonSubsGivenCodeLength ( )
inlinestatic

get character length for column

◆ GetStartDateDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetStartDateDBName ( )
inlinestatic

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

◆ GetStartDateHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetStartDateHelp ( )
inlinestatic

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

◆ GetStartDateLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetStartDateLength ( )
inlinestatic

get character length for column

◆ GetSubscriptionRenewalDateDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetSubscriptionRenewalDateDBName ( )
inlinestatic

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

◆ GetSubscriptionRenewalDateHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetSubscriptionRenewalDateHelp ( )
inlinestatic

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

◆ GetSubscriptionRenewalDateLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetSubscriptionRenewalDateLength ( )
inlinestatic

get character length for column

◆ GetSubscriptionStatusDBName()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetSubscriptionStatusDBName ( )
inlinestatic

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

◆ GetSubscriptionStatusHelp()

static string Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetSubscriptionStatusHelp ( )
inlinestatic

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

◆ GetSubscriptionStatusLength()

static short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.GetSubscriptionStatusLength ( )
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.PSubscriptionTable.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.PSubscriptionTable.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.PSubscriptionTable.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.Mailroom.Data.PSubscriptionTable.InitClass ( )
inlineprotectedvirtual

create the columns

Implements Ict.Common.Data.TTypedDataTable.

◆ InitVars()

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

new typed row using DataRowBuilder

◆ NewRowTyped() [1/2]

PSubscriptionRow Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.NewRowTyped ( )
inline

create a new typed row, always with default values

◆ NewRowTyped() [2/2]

PSubscriptionRow Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.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

◆ ColumnCreatedBy

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

User ID of who created this record.

◆ ColumnCreatedById

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnCreatedById = 19
static

used for generic TTypedDataTable functions

◆ ColumnDateCancelled

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnDateCancelled

◆ ColumnDateCancelledId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnDateCancelledId = 9
static

used for generic TTypedDataTable functions

◆ ColumnDateCreated

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

The date the record was created.

◆ ColumnDateCreatedId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnDateCreatedId = 18
static

used for generic TTypedDataTable functions

◆ ColumnDateModified

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

The date the record was modified.

◆ ColumnDateModifiedId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnDateModifiedId = 20
static

used for generic TTypedDataTable functions

◆ ColumnDateNoticeSent

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnDateNoticeSent

◆ ColumnDateNoticeSentId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnDateNoticeSentId = 8
static

used for generic TTypedDataTable functions

◆ ColumnExpiryDate

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnExpiryDate

Date the subscription expires.

◆ ColumnExpiryDateId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnExpiryDateId = 5
static

used for generic TTypedDataTable functions

◆ ColumnFirstIssue

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnFirstIssue

◆ ColumnFirstIssueId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnFirstIssueId = 15
static

used for generic TTypedDataTable functions

◆ ColumnGiftFromKey

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnGiftFromKey

◆ ColumnGiftFromKeyId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnGiftFromKeyId = 17
static

used for generic TTypedDataTable functions

◆ ColumnGratisSubscription

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnGratisSubscription

◆ ColumnGratisSubscriptionId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnGratisSubscriptionId = 7
static

used for generic TTypedDataTable functions

◆ ColumnLastIssue

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnLastIssue

◆ ColumnLastIssueId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnLastIssueId = 16
static

used for generic TTypedDataTable functions

◆ ColumnModificationId

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

This identifies the current version of the record.

◆ ColumnModificationIdId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnModificationIdId = 22
static

used for generic TTypedDataTable functions

◆ ColumnModifiedBy

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

User ID of who last modified this record.

◆ ColumnModifiedById

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnModifiedById = 21
static

used for generic TTypedDataTable functions

◆ ColumnNumberComplimentary

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnNumberComplimentary

The number of issues sent after a subscription has ceased.

◆ ColumnNumberComplimentaryId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnNumberComplimentaryId = 12
static

used for generic TTypedDataTable functions

◆ ColumnNumberIssuesReceived

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnNumberIssuesReceived

◆ ColumnNumberIssuesReceivedId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnNumberIssuesReceivedId = 11
static

used for generic TTypedDataTable functions

◆ ColumnPartnerKey

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnPartnerKey

This is the partner key assigned to each partner. It consists of the fund id followed by a computer generated six digit number.

◆ ColumnPartnerKeyId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnPartnerKeyId = 1
static

used for generic TTypedDataTable functions

◆ ColumnProvisionalExpiryDate

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnProvisionalExpiryDate

Provisional date on which the subscription may expire.

◆ ColumnProvisionalExpiryDateId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnProvisionalExpiryDateId = 6
static

used for generic TTypedDataTable functions

◆ ColumnPublicationCode

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnPublicationCode

The is the key to the publication table.

◆ ColumnPublicationCodeId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnPublicationCodeId = 0
static

used for generic TTypedDataTable functions

◆ ColumnPublicationCopies

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnPublicationCopies

◆ ColumnPublicationCopiesId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnPublicationCopiesId = 2
static

used for generic TTypedDataTable functions

◆ ColumnReasonSubsCancelledCode

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnReasonSubsCancelledCode

◆ ColumnReasonSubsCancelledCodeId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnReasonSubsCancelledCodeId = 4
static

used for generic TTypedDataTable functions

◆ ColumnReasonSubsGivenCode

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnReasonSubsGivenCode

◆ ColumnReasonSubsGivenCodeId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnReasonSubsGivenCodeId = 3
static

used for generic TTypedDataTable functions

◆ ColumnStartDate

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnStartDate

◆ ColumnStartDateId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnStartDateId = 10
static

used for generic TTypedDataTable functions

◆ ColumnSubscriptionRenewalDate

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnSubscriptionRenewalDate

◆ ColumnSubscriptionRenewalDateId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnSubscriptionRenewalDateId = 13
static

used for generic TTypedDataTable functions

◆ ColumnSubscriptionStatus

DataColumn Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnSubscriptionStatus

◆ ColumnSubscriptionStatusId

readonly short Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.ColumnSubscriptionStatusId = 14
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.PSubscriptionTable.TableId = 98
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.PSubscriptionTable.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]

PSubscriptionRow Ict.Petra.Shared.MPartner.Mailroom.Data.PSubscriptionTable.this[int i]
get

Access a typed row by index.


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