methods related to form templates in the MCommon namespace More...

Static Public Member Functions
static bool	UploadFinanceFormTemplate (String AFormCode, String AFormName, String ALanguageCode, String ATemplateText, String AUserID, DateTime AUploadDateTime, String ATemplateFileExtension)
	Uploads a finance form template to the specified data row More...

static bool	UploadPartnerFormTemplate (String AFormName, String ALanguageCode, String ATemplateText, String AUserID, DateTime AUploadDateTime, String ATemplateFileExtension)
	Uploads a partner form template to the specified data row. The FormCode for this is always PARTNER More...

static bool	UploadPersonnelFormTemplate (String AFormName, String ALanguageCode, String ATemplateText, String AUserID, DateTime AUploadDateTime, String ATemplateFileExtension)
	Uploads a personnel form template to the specified data row. The FormCode for this is always PERSONNEL More...

static bool	UploadConferenceFormTemplate (String AFormName, String ALanguageCode, String ATemplateText, String AUserID, DateTime AUploadDateTime, String ATemplateFileExtension)
	Uploads a conference form template to the specified data row. The FormCode for this is always CONFERENCE More...

static PFormTable	DownloadFinanceFormTemplate (String AFormCode, String AFormName, String ALanguageCode)
	Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are the three elements of the table primary key. Use for Finance form downloads More...

static PFormTable	DownloadPartnerFormTemplate (String AFormName, String ALanguageCode)
	Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are two of the three elements of the table primary key. Use for Partner form downloads More...

static PFormTable	DownloadSystemFormTemplate (String AFormName, String ALanguageCode)
	Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are two of the three elements of the table primary key. Use for Partner form downloads More...

static PFormTable	DownloadPersonnelFormTemplate (String AFormName, String ALanguageCode)
	Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are two of the three elements of the table primary key. Use for Personnel form downloads More...

static PFormTable	DownloadConferenceFormTemplate (String AFormName, String ALanguageCode)
	Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are two of the three elements of the table primary key. Use for Personnel form downloads More...

static PFormTable	GetFinanceForms (String AFormCode, String AFormTypeCode)
	return a table with forms for given finance form code and form type code More...

static PFormTable	GetPartnerForms ()
	return a table with forms for the partner module More...

static PFormTable	GetConferenceForms ()
	return a table with forms for the partner module More...

static PFormTable	GetPersonnelForms ()
	return a table with forms for the personnel module More...

static bool	GetCHDefinitionFiles (out String APostalCodeDefinition, out String ACountryDefinition, out String AFailMessage)
	Reads the two definition files used by the CH sort algorithm More...

Detailed Description

methods related to form templates in the MCommon namespace

Member Function Documentation

◆ DownloadConferenceFormTemplate()

static PFormTable Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.DownloadConferenceFormTemplate	(	String	AFormName,
		String	ALanguageCode
	)

inlinestatic

Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are two of the three elements of the table primary key. Use for Personnel form downloads

◆ DownloadFinanceFormTemplate()

static PFormTable Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.DownloadFinanceFormTemplate	(	String	AFormCode,
		String	AFormName,
		String	ALanguageCode
	)

inlinestatic

Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are the three elements of the table primary key. Use for Finance form downloads

◆ DownloadPartnerFormTemplate()

static PFormTable Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.DownloadPartnerFormTemplate	(	String	AFormName,
		String	ALanguageCode
	)

inlinestatic

Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are two of the three elements of the table primary key. Use for Partner form downloads

◆ DownloadPersonnelFormTemplate()

static PFormTable Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.DownloadPersonnelFormTemplate	(	String	AFormName,
		String	ALanguageCode
	)

inlinestatic

Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are two of the three elements of the table primary key. Use for Personnel form downloads

◆ DownloadSystemFormTemplate()

static PFormTable Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.DownloadSystemFormTemplate	(	String	AFormName,
		String	ALanguageCode
	)

inlinestatic

Returns a single row PFormTable that contains the full template text as a base64 string. The parameters are two of the three elements of the table primary key. Use for Partner form downloads

◆ GetCHDefinitionFiles()

static bool Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.GetCHDefinitionFiles	(	out String	APostalCodeDefinition,
		out String	ACountryDefinition,
		out String	AFailMessage
	)

inlinestatic

Reads the two definition files used by the CH sort algorithm

Parameters

APostalCodeDefinition	The content of the Post code definition file
ACountryDefinition	The content of the country definition file
AFailMessage	A message for the client in case of failure.

Returns: True if successful, otherwise false and a message is contained in AFailMessage

◆ GetConferenceForms()

static PFormTable Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.GetConferenceForms ( )

inlinestatic

return a table with forms for the partner module

Returns: Result Form Table

◆ GetFinanceForms()

static PFormTable Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.GetFinanceForms	(	String	AFormCode,
		String	AFormTypeCode
	)

inlinestatic

return a table with forms for given finance form code and form type code

Parameters

AFormCode	Form Code Filter
AFormTypeCode	Form Type Code Filter, ignore this filter if empty string

Returns: Result Form Table

◆ GetPartnerForms()

static PFormTable Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.GetPartnerForms ( )

inlinestatic

return a table with forms for the partner module

Returns: Result Form Table

◆ GetPersonnelForms()

static PFormTable Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.GetPersonnelForms ( )

inlinestatic

return a table with forms for the personnel module

Returns: Result Form Table

◆ UploadConferenceFormTemplate()

static bool Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.UploadConferenceFormTemplate	(	String	AFormName,
		String	ALanguageCode,
		String	ATemplateText,
		String	AUserID,
		DateTime	AUploadDateTime,
		String	ATemplateFileExtension
	)

inlinestatic

Uploads a conference form template to the specified data row. The FormCode for this is always CONFERENCE

Parameters

AFormName	Form name
ALanguageCode	language code
ATemplateText	The template as a base64 string
AUserID	User ID who is doing the upload
AUploadDateTime	Local date and time from the user PC that is doing the upload
ATemplateFileExtension	File extension of template file (eg docx)

Returns: True if the table record was modified successfully

◆ UploadFinanceFormTemplate()

static bool Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.UploadFinanceFormTemplate	(	String	AFormCode,
		String	AFormName,
		String	ALanguageCode,
		String	ATemplateText,
		String	AUserID,
		DateTime	AUploadDateTime,
		String	ATemplateFileExtension
	)

inlinestatic

Uploads a finance form template to the specified data row

Parameters

AFormCode	Form Code
AFormName	Form name
ALanguageCode	language code
ATemplateText	The template as a base64 string
AUserID	User ID who is doing the upload
AUploadDateTime	Local date and time from the user PC that is doing the upload
ATemplateFileExtension	File extension of template file (eg docx)

Returns: True if the table record was modified successfully

◆ UploadPartnerFormTemplate()

static bool Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.UploadPartnerFormTemplate	(	String	AFormName,
		String	ALanguageCode,
		String	ATemplateText,
		String	AUserID,
		DateTime	AUploadDateTime,
		String	ATemplateFileExtension
	)

inlinestatic

Uploads a partner form template to the specified data row. The FormCode for this is always PARTNER

Parameters

AFormName	Form name
ALanguageCode	language code
ATemplateText	The template as a base64 string
AUserID	User ID who is doing the upload
AUploadDateTime	Local date and time from the user PC that is doing the upload
ATemplateFileExtension	File extension of template file (eg docx)

Returns: True if the table record was modified successfully

◆ UploadPersonnelFormTemplate()

static bool Ict.Petra.Server.MCommon.FormTemplates.WebConnectors.TFormTemplatesWebConnector.UploadPersonnelFormTemplate	(	String	AFormName,
		String	ALanguageCode,
		String	ATemplateText,
		String	AUserID,
		DateTime	AUploadDateTime,
		String	ATemplateFileExtension
	)

inlinestatic

Uploads a personnel form template to the specified data row. The FormCode for this is always PERSONNEL

Parameters

AFormName	Form name
ALanguageCode	language code
ATemplateText	The template as a base64 string
AUserID	User ID who is doing the upload
AUploadDateTime	Local date and time from the user PC that is doing the upload
ATemplateFileExtension	File extension of template file (eg docx)

Returns: True if the table record was modified successfully

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

csharp/ICT/Petra/Server/lib/MCommon/web/FormTemplates.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ DownloadConferenceFormTemplate()

◆ DownloadFinanceFormTemplate()

◆ DownloadPartnerFormTemplate()

◆ DownloadPersonnelFormTemplate()

◆ DownloadSystemFormTemplate()

◆ GetCHDefinitionFiles()

◆ GetConferenceForms()

◆ GetFinanceForms()

◆ GetPartnerForms()

◆ GetPersonnelForms()

◆ UploadConferenceFormTemplate()

◆ UploadFinanceFormTemplate()

◆ UploadPartnerFormTemplate()

◆ UploadPersonnelFormTemplate()