Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector Class Reference

methods related to form letters More...

Static Public Member Functions
static Boolean	FillFormDataFromExtract (Int32 AExtractId, TFormLetterInfo AFormLetterInfo, out List< TFormData >AFormDataList)
	populate form data for given extract and list of fields More...
static TFormDataPartner	FillFormDataFromPartner (Int64 APartnerKey, TFormDataPartner AFormDataPartner, TFormLetterInfo AFormLetterInfo, Int64 ASiteKey=0, Int32 ALocationKey=0)
	Populate form data for given partner key and list of fields. This only fills Partner Data, not Personnel or Finance. This method can be called from Personnel and Finance Form Letter methods to fill Partner Data. More...
static TFormDataPerson	FillFormDataFromPerson (Int64 APartnerKey, TFormDataPerson AFormDataPerson, TFormLetterInfo AFormLetterInfo, Int64 ASiteKey=0, Int32 ALocationKey=0)
	Populate form data for given partner key and list of fields. This only fills Partner Data, not Personnel or Finance. This method can be called from Personnel and Finance Form Letter methods to fill Partner Data. More...
static void	FillFormDataFromPartner (Int64 APartnerKey, TFormDataPartner AFormDataPartner, TFormLetterInfo AFormLetterInfo, TDBTransaction AReadTransaction, Int64 ASiteKey=0, Int32 ALocationKey=0)
	Populate form data for given partner key and list of fields. This only fills Partner Data, not Personnel or Finance. This method can be called from Personnel and Finance Form Letter methods to fill Partner Data. More...
static void	FillFormDataFromPerson (Int64 APartnerKey, TFormDataPerson AFormDataPerson, TFormLetterInfo AFormLetterInfo, TDBTransaction AReadTransaction, Int64 ASiteKey=0, Int32 ALocationKey=0)
	Populate form data for given partner key and list of fields. This only fills Partner Data, not Personnel or Finance. This method can be called from Personnel and Finance Form Letter methods to fill Partner Data. More...
static String	PreviewAddressBlock (String AAddressLayoutBlock)
	build and return the address according to country and address layout code More...
static String	BuildAddressBlock (TFormDataPartner AFormData, String AAddressLayoutCode, TPartnerClass APartnerClass)
	Public Method to return the Address Block More...
static bool	UpdateSubscriptionsReceivedFromExtract (Int32 AExtractId, String APublicationsCSVList, out TVerificationResultCollection AResultMessages)
	Update the partner subscriptions for specifed publications. Partner keys come from an extract More...
static bool	UpdateSubscriptionsReceivedForPartner (long APartnerKey, String APublicationsCSVList)
	Update the partner subscriptions for specifed publications. An individual Partner keys is supplied More...

Detailed Description

methods related to form letters

Member Function Documentation

BuildAddressBlock()

static String Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector.BuildAddressBlock ( TFormDataPartner  AFormData, String  AAddressLayoutCode, TPartnerClass  APartnerClass  )

inlinestatic

Public Method to return the Address Block

Parameters

AFormData
AAddressLayoutCode
APartnerClass

Returns

FillFormDataFromExtract()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector.FillFormDataFromExtract ( Int32  AExtractId, TFormLetterInfo  AFormLetterInfo, out List< TFormData >  AFormDataList  )

inlinestatic

populate form data for given extract and list of fields

Parameters

AExtractId	Extract of partners to be used
AFormLetterInfo	Info about form letter (tag list etc.)
AFormDataList	list with populated form data

Returns

returns true if list was created successfully

FillFormDataFromPartner() [1/2]

static TFormDataPartner Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector.FillFormDataFromPartner ( Int64  APartnerKey, TFormDataPartner  AFormDataPartner, TFormLetterInfo  AFormLetterInfo, Int64  ASiteKey = 0, Int32  ALocationKey = 0  )

inlinestatic

Populate form data for given partner key and list of fields. This only fills Partner Data, not Personnel or Finance. This method can be called from Personnel and Finance Form Letter methods to fill Partner Data.

Parameters

APartnerKey	Key of partner record to be used
AFormDataPartner	Form Data Object
AFormLetterInfo	Info class for form letter
ASiteKey	Site key for location record
ALocationKey	Key for location record

Returns

returns list with populated form data

FillFormDataFromPartner() [2/2]

static void Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector.FillFormDataFromPartner ( Int64  APartnerKey, TFormDataPartner  AFormDataPartner, TFormLetterInfo  AFormLetterInfo, TDBTransaction  AReadTransaction, Int64  ASiteKey = 0, Int32  ALocationKey = 0  )

inlinestatic

Populate form data for given partner key and list of fields. This only fills Partner Data, not Personnel or Finance. This method can be called from Personnel and Finance Form Letter methods to fill Partner Data.

Parameters

APartnerKey	Key of partner record to be used
AFormDataPartner	form letter data object to be filled
AFormLetterInfo	Info class for form letter
AReadTransaction	Db transaction
ASiteKey	Site key for location record
ALocationKey	Key for location record

Returns

returns list with populated form data

FillFormDataFromPerson() [1/2]

static TFormDataPerson Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector.FillFormDataFromPerson ( Int64  APartnerKey, TFormDataPerson  AFormDataPerson, TFormLetterInfo  AFormLetterInfo, Int64  ASiteKey = 0, Int32  ALocationKey = 0  )

inlinestatic

Populate form data for given partner key and list of fields. This only fills Partner Data, not Personnel or Finance. This method can be called from Personnel and Finance Form Letter methods to fill Partner Data.

Parameters

APartnerKey	Key of partner record to be used
AFormDataPerson	Form Data Object
AFormLetterInfo	Info class for form letter
ASiteKey	Site key for location record
ALocationKey	Key for location record

Returns

returns list with populated form data

FillFormDataFromPerson() [2/2]

static void Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector.FillFormDataFromPerson ( Int64  APartnerKey, TFormDataPerson  AFormDataPerson, TFormLetterInfo  AFormLetterInfo, TDBTransaction  AReadTransaction, Int64  ASiteKey = 0, Int32  ALocationKey = 0  )

inlinestatic

Populate form data for given partner key and list of fields. This only fills Partner Data, not Personnel or Finance. This method can be called from Personnel and Finance Form Letter methods to fill Partner Data.

Parameters

APartnerKey	Key of partner record to be used
AFormDataPerson	form letter data object to be filled
AFormLetterInfo	Info class for form letter
AReadTransaction	Db transaction
ASiteKey	Site key for location record
ALocationKey	Key for location record

Returns

returns list with populated form data

PreviewAddressBlock()

static String Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector.PreviewAddressBlock ( String  AAddressLayoutBlock )

inlinestatic

build and return the address according to country and address layout code

Parameters

AAddressLayoutBlock

Returns

UpdateSubscriptionsReceivedForPartner()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector.UpdateSubscriptionsReceivedForPartner ( long  APartnerKey, String  APublicationsCSVList  )

inlinestatic

Update the partner subscriptions for specifed publications. An individual Partner keys is supplied

Parameters

APartnerKey	The specific partner key
APublicationsCSVList	CSV list of publications

Returns

UpdateSubscriptionsReceivedFromExtract()

static bool Ict.Petra.Server.MPartner.Partner.WebConnectors.TFormLettersWebConnector.UpdateSubscriptionsReceivedFromExtract ( Int32  AExtractId, String  APublicationsCSVList, out TVerificationResultCollection  AResultMessages  )

inlinestatic

Update the partner subscriptions for specifed publications. Partner keys come from an extract

Parameters

AExtractId	Extract ID
APublicationsCSVList	CSV list of publications
AResultMessages

Returns

---

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

• csharp/ICT/Petra/Server/lib/MPartner/web/FormLetters.cs