The form description for user definable forms such as receipts. More...

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

Public Member Functions
	PFormRow (System.Data.DataRowBuilder rb)
	Constructor. More...

virtual void	InitValues ()
	set default values More...

bool	IsFormCodeNull ()
	test for NULL value More...

void	SetFormCodeNull ()
	assign NULL value More...

bool	IsFormNameNull ()
	test for NULL value More...

void	SetFormNameNull ()
	assign NULL value More...

bool	IsFormLanguageNull ()
	test for NULL value More...

void	SetFormLanguageNull ()
	assign NULL value More...

bool	IsFormDescriptionNull ()
	test for NULL value More...

void	SetFormDescriptionNull ()
	assign NULL value More...

bool	IsFormTypeCodeNull ()
	test for NULL value More...

void	SetFormTypeCodeNull ()
	assign NULL value More...

bool	IsAddressLayoutCodeNull ()
	test for NULL value More...

void	SetAddressLayoutCodeNull ()
	assign NULL value More...

bool	IsFormalityLevelNull ()
	test for NULL value More...

void	SetFormalityLevelNull ()
	assign NULL value More...

bool	IsTemplateAvailableNull ()
	test for NULL value More...

void	SetTemplateAvailableNull ()
	assign NULL value More...

bool	IsTemplateDocumentNull ()
	test for NULL value More...

void	SetTemplateDocumentNull ()
	assign NULL value More...

bool	IsTemplateFileExtensionNull ()
	test for NULL value More...

void	SetTemplateFileExtensionNull ()
	assign NULL value More...

bool	IsTemplateUploadDateNull ()
	test for NULL value More...

void	SetTemplateUploadDateNull ()
	assign NULL value More...

bool	IsTemplateUploadTimeNull ()
	test for NULL value More...

void	SetTemplateUploadTimeNull ()
	assign NULL value More...

bool	IsTemplateUploadedByUserIdNull ()
	test for NULL value More...

void	SetTemplateUploadedByUserIdNull ()
	assign NULL value More...

bool	IsMinimumAmountNull ()
	test for NULL value More...

void	SetMinimumAmountNull ()
	assign NULL value More...

bool	IsOptionsNull ()
	test for NULL value More...

void	SetOptionsNull ()
	assign NULL value More...

bool	IsDateCreatedNull ()
	test for NULL value More...

void	SetDateCreatedNull ()
	assign NULL value More...

bool	IsCreatedByNull ()
	test for NULL value More...

void	SetCreatedByNull ()
	assign NULL value More...

bool	IsDateModifiedNull ()
	test for NULL value More...

void	SetDateModifiedNull ()
	assign NULL value More...

bool	IsModifiedByNull ()
	test for NULL value More...

void	SetModifiedByNull ()
	assign NULL value More...

bool	IsModificationIdNull ()
	test for NULL value More...

void	SetModificationIdNull ()
	assign NULL value More...

Properties
String	FormCode `[get, set]`
	The code which defines the type of form described in the table. More...

String	FormName `[get, set]`
	The name of the form being created for the form code. More...

String	FormLanguage `[get, set]`
	The language that this form is written in. Use 99 if the form can be used for unspecified languages. More...

String	FormDescription `[get, set]`
	Description of the form. More...

String	FormTypeCode `[get, set]`
	If there are several types of form then it can be specified here. Eg an annual receipt and an individual receipt. More...

String	AddressLayoutCode `[get, set]`
	The address layout code that defines the address block content. More...

Int32	FormalityLevel `[get, set]`
	The formality level to use if the template contains greetings or salutations. 1=Informal, 6=Very formal. More...

Boolean	TemplateAvailable `[get, set]`
	Is the template available in the database. More...

String	TemplateDocument `[get, set]`
	The binary template file encoded as Base64 text. More...

String	TemplateFileExtension `[get, set]`
	The file type associated with the template. More...

System.? DateTime	TemplateUploadDate `[get, set]`
	Date the template was uploaded to the database. More...

Int32	TemplateUploadTime `[get, set]`
	Time the template was uploaded to the database. More...

String	TemplateUploadedByUserId `[get, set]`

Decimal	MinimumAmount `[get, set]`
	The minimum amount that is acceptable on a receipt. More...

String	Options `[get, set]`
	Allows the exclusion of certain records from a report. More...

System.? DateTime	DateCreated `[get, set]`
	The date the record was created. More...

String	CreatedBy `[get, set]`
	User ID of who created this record. More...

System.? DateTime	DateModified `[get, set]`
	The date the record was modified. More...

String	ModifiedBy `[get, set]`
	User ID of who last modified this record. More...

DateTime	ModificationId `[get, set]`
	This identifies the current version of the record. More...

Detailed Description

The form description for user definable forms such as receipts.

Constructor & Destructor Documentation

◆ PFormRow()

Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.PFormRow ( System.Data.DataRowBuilder rb )

inline

Constructor.

Member Function Documentation

◆ InitValues()

virtual void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.InitValues ( )

inlinevirtual

set default values

◆ IsAddressLayoutCodeNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsAddressLayoutCodeNull ( )

inline

test for NULL value

◆ IsCreatedByNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsCreatedByNull ( )

inline

test for NULL value

◆ IsDateCreatedNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsDateCreatedNull ( )

inline

test for NULL value

◆ IsDateModifiedNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsDateModifiedNull ( )

inline

test for NULL value

◆ IsFormalityLevelNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsFormalityLevelNull ( )

inline

test for NULL value

◆ IsFormCodeNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsFormCodeNull ( )

inline

test for NULL value

◆ IsFormDescriptionNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsFormDescriptionNull ( )

inline

test for NULL value

◆ IsFormLanguageNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsFormLanguageNull ( )

inline

test for NULL value

◆ IsFormNameNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsFormNameNull ( )

inline

test for NULL value

◆ IsFormTypeCodeNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsFormTypeCodeNull ( )

inline

test for NULL value

◆ IsMinimumAmountNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsMinimumAmountNull ( )

inline

test for NULL value

◆ IsModificationIdNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsModificationIdNull ( )

inline

test for NULL value

◆ IsModifiedByNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsModifiedByNull ( )

inline

test for NULL value

◆ IsOptionsNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsOptionsNull ( )

inline

test for NULL value

◆ IsTemplateAvailableNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsTemplateAvailableNull ( )

inline

test for NULL value

◆ IsTemplateDocumentNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsTemplateDocumentNull ( )

inline

test for NULL value

◆ IsTemplateFileExtensionNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsTemplateFileExtensionNull ( )

inline

test for NULL value

◆ IsTemplateUploadDateNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsTemplateUploadDateNull ( )

inline

test for NULL value

◆ IsTemplateUploadedByUserIdNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsTemplateUploadedByUserIdNull ( )

inline

test for NULL value

◆ IsTemplateUploadTimeNull()

bool Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.IsTemplateUploadTimeNull ( )

inline

test for NULL value

◆ SetAddressLayoutCodeNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetAddressLayoutCodeNull ( )

inline

assign NULL value

◆ SetCreatedByNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetCreatedByNull ( )

inline

assign NULL value

◆ SetDateCreatedNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetDateCreatedNull ( )

inline

assign NULL value

◆ SetDateModifiedNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetDateModifiedNull ( )

inline

assign NULL value

◆ SetFormalityLevelNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetFormalityLevelNull ( )

inline

assign NULL value

◆ SetFormCodeNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetFormCodeNull ( )

inline

assign NULL value

◆ SetFormDescriptionNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetFormDescriptionNull ( )

inline

assign NULL value

◆ SetFormLanguageNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetFormLanguageNull ( )

inline

assign NULL value

◆ SetFormNameNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetFormNameNull ( )

inline

assign NULL value

◆ SetFormTypeCodeNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetFormTypeCodeNull ( )

inline

assign NULL value

◆ SetMinimumAmountNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetMinimumAmountNull ( )

inline

assign NULL value

◆ SetModificationIdNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetModificationIdNull ( )

inline

assign NULL value

◆ SetModifiedByNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetModifiedByNull ( )

inline

assign NULL value

◆ SetOptionsNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetOptionsNull ( )

inline

assign NULL value

◆ SetTemplateAvailableNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetTemplateAvailableNull ( )

inline

assign NULL value

◆ SetTemplateDocumentNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetTemplateDocumentNull ( )

inline

assign NULL value

◆ SetTemplateFileExtensionNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetTemplateFileExtensionNull ( )

inline

assign NULL value

◆ SetTemplateUploadDateNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetTemplateUploadDateNull ( )

inline

assign NULL value

◆ SetTemplateUploadedByUserIdNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetTemplateUploadedByUserIdNull ( )

inline

assign NULL value

◆ SetTemplateUploadTimeNull()

void Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.SetTemplateUploadTimeNull ( )

inline

assign NULL value

Property Documentation

◆ AddressLayoutCode

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.AddressLayoutCode

getset

The address layout code that defines the address block content.

◆ CreatedBy

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.CreatedBy

getset

User ID of who created this record.

◆ DateCreated

System.? DateTime Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.DateCreated

getset

The date the record was created.

◆ DateModified

System.? DateTime Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.DateModified

getset

The date the record was modified.

◆ FormalityLevel

Int32 Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.FormalityLevel

getset

The formality level to use if the template contains greetings or salutations. 1=Informal, 6=Very formal.

◆ FormCode

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.FormCode

getset

The code which defines the type of form described in the table.

◆ FormDescription

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.FormDescription

getset

Description of the form.

◆ FormLanguage

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.FormLanguage

getset

The language that this form is written in. Use 99 if the form can be used for unspecified languages.

◆ FormName

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.FormName

getset

The name of the form being created for the form code.

◆ FormTypeCode

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.FormTypeCode

getset

If there are several types of form then it can be specified here. Eg an annual receipt and an individual receipt.

◆ MinimumAmount

Decimal Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.MinimumAmount

getset

The minimum amount that is acceptable on a receipt.

◆ ModificationId

DateTime Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.ModificationId

getset

This identifies the current version of the record.

◆ ModifiedBy

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.ModifiedBy

getset

User ID of who last modified this record.

◆ Options

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.Options

getset

Allows the exclusion of certain records from a report.

◆ TemplateAvailable

Boolean Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.TemplateAvailable

getset

Is the template available in the database.

◆ TemplateDocument

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.TemplateDocument

getset

The binary template file encoded as Base64 text.

◆ TemplateFileExtension

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.TemplateFileExtension

getset

The file type associated with the template.

◆ TemplateUploadDate

System.? DateTime Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.TemplateUploadDate

getset

Date the template was uploaded to the database.

◆ TemplateUploadedByUserId

String Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.TemplateUploadedByUserId

getset

◆ TemplateUploadTime

Int32 Ict.Petra.Shared.MPartner.Mailroom.Data.PFormRow.TemplateUploadTime

getset

Time the template was uploaded to the database.

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ PFormRow()

Member Function Documentation

◆ InitValues()

◆ IsAddressLayoutCodeNull()

◆ IsCreatedByNull()

◆ IsDateCreatedNull()

◆ IsDateModifiedNull()

◆ IsFormalityLevelNull()

◆ IsFormCodeNull()

◆ IsFormDescriptionNull()

◆ IsFormLanguageNull()

◆ IsFormNameNull()

◆ IsFormTypeCodeNull()

◆ IsMinimumAmountNull()

◆ IsModificationIdNull()

◆ IsModifiedByNull()

◆ IsOptionsNull()

◆ IsTemplateAvailableNull()

◆ IsTemplateDocumentNull()

◆ IsTemplateFileExtensionNull()

◆ IsTemplateUploadDateNull()

◆ IsTemplateUploadedByUserIdNull()

◆ IsTemplateUploadTimeNull()

◆ SetAddressLayoutCodeNull()

◆ SetCreatedByNull()

◆ SetDateCreatedNull()

◆ SetDateModifiedNull()

◆ SetFormalityLevelNull()

◆ SetFormCodeNull()

◆ SetFormDescriptionNull()

◆ SetFormLanguageNull()

◆ SetFormNameNull()

◆ SetFormTypeCodeNull()

◆ SetMinimumAmountNull()

◆ SetModificationIdNull()

◆ SetModifiedByNull()

◆ SetOptionsNull()

◆ SetTemplateAvailableNull()

◆ SetTemplateDocumentNull()

◆ SetTemplateFileExtensionNull()

◆ SetTemplateUploadDateNull()

◆ SetTemplateUploadedByUserIdNull()

◆ SetTemplateUploadTimeNull()

Property Documentation

◆ AddressLayoutCode

◆ CreatedBy

◆ DateCreated

◆ DateModified

◆ FormalityLevel

◆ FormCode

◆ FormDescription

◆ FormLanguage

◆ FormName

◆ FormTypeCode

◆ MinimumAmount

◆ ModificationId

◆ ModifiedBy

◆ Options

◆ TemplateAvailable

◆ TemplateDocument

◆ TemplateFileExtension

◆ TemplateUploadDate

◆ TemplateUploadedByUserId

◆ TemplateUploadTime