methods for extract master list More...

Static Public Member Functions
static ExtractTDSMExtractMasterTable	GetAllExtractHeaders ()
	retrieve all extract master records More...

static MExtractMasterTable	GetAllExtractHeaders (String AExtractNameFilter, Boolean AAllUsers, String AUserCreated, String AUserModified)
	retrieve all extract master records that match given criteria More...

static ExtractTDSMExtractMasterTable	GetAllExtractHeaders (String AExtractNameFilter, String AExtractDescFilter, Boolean AAllUsers, String AUserCreated, String AUserModified, DateTime? ADateCreatedFrom, DateTime? ADateCreatedTo, DateTime? ADateModifiedFrom, DateTime ? ADateModifiedTo)
	retrieve all extract master records that match given criteria More...

static Boolean	ExtractExists (String AExtractName)
	check if extract with given name already exists More...

static Int32	GetExtractId (String AExtractName)
	return extract id for given extract name More...

static String	GetExtractName (Int32 AExtractId)
	return extract id for given extract name More...

static Boolean	CreateEmptyExtract (ref int AExtractId, String AExtractName, String AExtractDescription)
	create an empty extract with given name and description More...

static Boolean	CreateNewExtractFromPartnerKeys (ref int AExtractId, String AExtractName, String AExtractDescription, DataTable APartnerKeysTable, int APartnerKeysColumnId, bool AIgnoreInactive, bool AIgnoreNonMailingLocations, bool AIgnoreNoSolicitations, out int ANumberOfRowsCreated, out List< long >AIgnoredKeyList)
	Creates a new extract containing the partners whose keys are specified in the table More...

static Boolean	CreateFamilyMembersExtract (int ABaseExtractId, ref int AExtractId, String AExtractName, String AExtractDescription)
	create an extract of all family members (persons) existing in a base extract More...

static Boolean	CreateFamilyExtractForPersons (int ABaseExtractId, ref int AExtractId, String AExtractName, String AExtractDescription)
	create an extract containing all families of persons in a base extract More...

static Int32	PurgeExtractsCount (int ANumberOfDays, Boolean AAllUsers, String AUserName)
	Get the number of extracts that would be deleted if a purge (delete) operation were executed for specific users and older than x days. This method can be used to give the client an idea of how many extract swill get deleted if they proceed with an actual purge. More...

static Boolean	PurgeExtracts (int ANumberOfDays, Boolean AAllUsers, String AUserName)
	purge (delete) extracts for specific users and older than x days More...

static ExtractTDSMExtractTable	GetExtractRowsWithPartnerData (int AExtractId)
	retrieve extract records and include partner name and class More...

static TSubmitChangesResult	SaveExtractMaster (ref MExtractMasterTable AExtractMasterTable)
	save extract master table records (includes cascading delete if record is deleted) More...

static TSubmitChangesResult	SaveExtract (int AExtractId, ref MExtractTable AExtractTable)
	save extract table records More...

static Boolean	SubscriptionExists (Int64 APartnerKey, String APublicationCode)
	retrieve information if partner has subscription for certain publication More...

static void	AddSubscription (int AExtractId, ref PSubscriptionTable ATable, out PPartnerTable AExistingSubscriptionPartners, out int ASubscriptionsAdded)
	add subscription for all partners in a given extract More...

static void	ChangeSubscription (int AExtractId, ref PSubscriptionTable ATable, List< String >AFieldsToChange, out PPartnerTable APartnersWithoutSubscription, out int ASubscriptionsChanged)
	change subscription for all partners in a given extract for which the subscription exists More...

static Boolean	DeleteSubscription (int AExtractId, Int64 APartnerKey, String APublicationCode)
	delete subscription for a partner in a given extract More...

static void	UpdatePartnerType (int AExtractId, Boolean AAdd, String ATypeCode)
	update solicitations flag for all partners in given extract More...

static Boolean	UpdateSolicitationFlag (int AExtractId, Boolean ANoSolicitations, out int ARowsAffected)
	update solicitations flag for all partners in given extract More...

static Boolean	UpdateEmailGiftStatement (int AExtractId, Boolean AEmailGiftStatement, out int ARowsAffected)
	update email gift statement flag for all partners in given extract More...

static Boolean	UpdateReceiptFrequency (int AExtractId, Boolean AUpdateReceiptLetterFrequency, String AReceiptLetterFrequency, Boolean AUpdateReceiptEachGift, Boolean AReceiptEachGift)
	update receipt letter frequency and 'receipt each gift' flag for all partners in given extract More...

static Boolean	CombineExtracts (String ANewExtractName, String ANewExtractDescription, List< Int32 >ACombineExtractIdList, out Int32 ANewExtractId)
	Creates a new extract by combining a list of given extracts. More...

static Boolean	IntersectExtracts (String ANewExtractName, String ANewExtractDescription, List< Int32 >AIntersectExtractIdList, out Int32 ANewExtractId)
	Creates a new extract by intersecting a list of given extracts. More...

static Boolean	SubtractExtracts (String ANewExtractName, String ANewExtractDescription, String ABaseExtractName, List< Int32 >ASubtractExtractIdList, out Int32 ANewExtractId)
	Creates a new extract by subractin a list of given extracts from a base extract. More...

Detailed Description

methods for extract master list

Member Function Documentation

◆ AddSubscription()

static void Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.AddSubscription	(	int	AExtractId,
		ref PSubscriptionTable	ATable,
		out PPartnerTable	AExistingSubscriptionPartners,
		out int	ASubscriptionsAdded
	)

inlinestatic

add subscription for all partners in a given extract

Parameters

AExtractId	extract to add subscription to
ATable	table with only one subscription row to be added for each partner
AExistingSubscriptionPartners	table containing partners that already have subscription for given publication
ASubscriptionsAdded	number of subscriptions added

Returns: true if adding was successful

◆ ChangeSubscription()

static void Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.ChangeSubscription	(	int	AExtractId,
		ref PSubscriptionTable	ATable,
		List< String >	AFieldsToChange,
		out PPartnerTable	APartnersWithoutSubscription,
		out int	ASubscriptionsChanged
	)

inlinestatic

change subscription for all partners in a given extract for which the subscription exists

Parameters

AExtractId	extract to add subscription to
ATable	table with only one subscription row to be changed for each partner
AFieldsToChange	table with only one subscription row to be changed for each partner
APartnersWithoutSubscription	table containing partners that do not have the given subscription
ASubscriptionsChanged	number of subscriptions changed

Returns: true if change was successful

◆ CombineExtracts()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.CombineExtracts	(	String	ANewExtractName,
		String	ANewExtractDescription,
		List< Int32 >	ACombineExtractIdList,
		out Int32	ANewExtractId
	)

inlinestatic

Creates a new extract by combining a list of given extracts.

Parameters

ANewExtractName	Name of the Extract to be created.
ANewExtractDescription	Description of the Extract to be created.
ACombineExtractIdList	List of Ids of extracts to be combined.
ANewExtractId	Extract Id of the created Extract, or -1 if the creation of the Extract was not successful.

Returns: True if the new combined Extract was created, otherwise false.

◆ CreateEmptyExtract()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.CreateEmptyExtract	(	ref int	AExtractId,
		String	AExtractName,
		String	AExtractDescription
	)

inlinestatic

create an empty extract with given name and description

Parameters

AExtractId
AExtractName
AExtractDescription

Returns: returns true if extract was created successfully

◆ CreateFamilyExtractForPersons()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.CreateFamilyExtractForPersons	(	int	ABaseExtractId,
		ref int	AExtractId,
		String	AExtractName,
		String	AExtractDescription
	)

inlinestatic

create an extract containing all families of persons in a base extract

Parameters

ABaseExtractId
AExtractId
AExtractName
AExtractDescription

Returns: returns true if extract was created successfully

◆ CreateFamilyMembersExtract()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.CreateFamilyMembersExtract	(	int	ABaseExtractId,
		ref int	AExtractId,
		String	AExtractName,
		String	AExtractDescription
	)

inlinestatic

create an extract of all family members (persons) existing in a base extract

Parameters

ABaseExtractId
AExtractId
AExtractName
AExtractDescription

Returns: returns true if extract was created successfully

◆ CreateNewExtractFromPartnerKeys()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.CreateNewExtractFromPartnerKeys	(	ref int	AExtractId,
		String	AExtractName,
		String	AExtractDescription,
		DataTable	APartnerKeysTable,
		int	APartnerKeysColumnId,
		bool	AIgnoreInactive,
		bool	AIgnoreNonMailingLocations,
		bool	AIgnoreNoSolicitations,
		out int	ANumberOfRowsCreated,
		out List< long >	AIgnoredKeyList
	)

inlinestatic

Creates a new extract containing the partners whose keys are specified in the table

Parameters

AExtractId	The resulting extract ID
AExtractName	A name for the extract
AExtractDescription	A description for the extract
APartnerKeysTable	A table of partner keys
APartnerKeysColumnId	The column ID for the partner keys
AIgnoreInactive	true if inactive partners should be ignored
AIgnoreNonMailingLocations	true to ignore if the partner's best address is a non-mailing location
AIgnoreNoSolicitations	true to ignore partners where the No Solicitations flag is set
ANumberOfRowsCreated	Returns the number of partner keys in the final extract (any duplicates are excluded)
AIgnoredKeyList	A reference to a List of long. If not null the server will fill it with the partner keys that were ignored. Does not include duplicates.

Returns: True if the extract was successfully created

◆ DeleteSubscription()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.DeleteSubscription	(	int	AExtractId,
		Int64	APartnerKey,
		String	APublicationCode
	)

inlinestatic

delete subscription for a partner in a given extract

Parameters

AExtractId
APublicationCode
APartnerKey

Returns: true if deletion was successful

◆ ExtractExists()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.ExtractExists ( String AExtractName )

inlinestatic

check if extract with given name already exists

Parameters

AExtractName

Returns: returns true if extract already exists

◆ GetAllExtractHeaders() [1/3]

static ExtractTDSMExtractMasterTable Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.GetAllExtractHeaders ( )

inlinestatic

retrieve all extract master records

Returns: returns table filled with all extract headers

◆ GetAllExtractHeaders() [2/3]

static MExtractMasterTable Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.GetAllExtractHeaders	(	String	AExtractNameFilter,
		Boolean	AAllUsers,
		String	AUserCreated,
		String	AUserModified
	)

inlinestatic

retrieve all extract master records that match given criteria

Parameters

AExtractNameFilter
AAllUsers
AUserCreated
AUserModified

Returns: returns table filled with all extract headers

◆ GetAllExtractHeaders() [3/3]

static ExtractTDSMExtractMasterTable Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.GetAllExtractHeaders	(	String	AExtractNameFilter,
		String	AExtractDescFilter,
		Boolean	AAllUsers,
		String	AUserCreated,
		String	AUserModified,
		DateTime?	ADateCreatedFrom,
		DateTime?	ADateCreatedTo,
		DateTime?	ADateModifiedFrom,
		DateTime ?	ADateModifiedTo
	)

inlinestatic

retrieve all extract master records that match given criteria

Parameters

AExtractNameFilter
AExtractDescFilter
AAllUsers
AUserCreated
AUserModified
ADateCreatedFrom
ADateCreatedTo
ADateModifiedFrom
ADateModifiedTo

Returns: returns table filled with all extract headers

◆ GetExtractId()

static Int32 Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.GetExtractId ( String AExtractName )

inlinestatic

return extract id for given extract name

Parameters

AExtractName

Returns: returns extract id or -1 if extract does not exist

◆ GetExtractName()

static String Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.GetExtractName ( Int32 AExtractId )

inlinestatic

return extract id for given extract name

Parameters

AExtractId

Returns: returns extract name or "" if extract does not exist

◆ GetExtractRowsWithPartnerData()

static ExtractTDSMExtractTable Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.GetExtractRowsWithPartnerData ( int AExtractId )

inlinestatic

retrieve extract records and include partner name and class

Parameters

AExtractId

Returns: returns table filled with extract rows including partner name and class

◆ IntersectExtracts()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.IntersectExtracts	(	String	ANewExtractName,
		String	ANewExtractDescription,
		List< Int32 >	AIntersectExtractIdList,
		out Int32	ANewExtractId
	)

inlinestatic

Creates a new extract by intersecting a list of given extracts.

Parameters

ANewExtractName	Name of the Extract to be created.
ANewExtractDescription	Description of the Extract to be created.
AIntersectExtractIdList	List of Ids of extracts to be intersected.
ANewExtractId	Extract Id of the created Extract, or -1 if the creation of the Extract was not successful.

Returns: True if the new intersected Extract was created, otherwise false.

◆ PurgeExtracts()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.PurgeExtracts	(	int	ANumberOfDays,
		Boolean	AAllUsers,
		String	AUserName
	)

inlinestatic

purge (delete) extracts for specific users and older than x days

Parameters

ANumberOfDays
AAllUsers
AUserName

Returns: returns true if extract was created successfully

◆ PurgeExtractsCount()

static Int32 Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.PurgeExtractsCount	(	int	ANumberOfDays,
		Boolean	AAllUsers,
		String	AUserName
	)

inlinestatic

Get the number of extracts that would be deleted if a purge (delete) operation were executed for specific users and older than x days. This method can be used to give the client an idea of how many extract swill get deleted if they proceed with an actual purge.

Parameters

ANumberOfDays
AAllUsers
AUserName

Returns: returns the number of extracts that would be deleted or -1 if an error occurred.

◆ SaveExtract()

static TSubmitChangesResult Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.SaveExtract	(	int	AExtractId,
		ref MExtractTable	AExtractTable
	)

inlinestatic

save extract table records

Parameters

AExtractId
AExtractTable

Returns: TSubmitChangesResult,scrOK if everything went fine, otherwise an Exception is thrown.

◆ SaveExtractMaster()

static TSubmitChangesResult Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.SaveExtractMaster ( ref MExtractMasterTable AExtractMasterTable )

inlinestatic

save extract master table records (includes cascading delete if record is deleted)

Parameters

AExtractMasterTable

Returns: TSubmitChangesResult.scrOK in case everything went fine, otherwise throws an Exception.

◆ SubscriptionExists()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.SubscriptionExists	(	Int64	APartnerKey,
		String	APublicationCode
	)

inlinestatic

retrieve information if partner has subscription for certain publication

Parameters

APartnerKey
APublicationCode

Returns: true if subscription exists

◆ SubtractExtracts()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.SubtractExtracts	(	String	ANewExtractName,
		String	ANewExtractDescription,
		String	ABaseExtractName,
		List< Int32 >	ASubtractExtractIdList,
		out Int32	ANewExtractId
	)

inlinestatic

Creates a new extract by subractin a list of given extracts from a base extract.

Parameters

ANewExtractName	Name of the Extract to be created.
ANewExtractDescription	Description of the Extract to be created.
ABaseExtractName	Base extract to subtract other extracts from.
ASubtractExtractIdList	List of Ids of extracts to be subtracted from base extract.
ANewExtractId	Extract Id of the created Extract, or -1 if the creation of the Extract was not successful.

Returns: True if the new intersected Extract was created, otherwise false.

◆ UpdateEmailGiftStatement()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.UpdateEmailGiftStatement	(	int	AExtractId,
		Boolean	AEmailGiftStatement,
		out int	ARowsAffected
	)

inlinestatic

update email gift statement flag for all partners in given extract

Parameters

AExtractId
AEmailGiftStatement
ARowsAffected

Returns: true if update was successful

◆ UpdatePartnerType()

static void Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.UpdatePartnerType	(	int	AExtractId,
		Boolean	AAdd,
		String	ATypeCode
	)

inlinestatic

update solicitations flag for all partners in given extract

Parameters

AExtractId
AAdd	if true then add type, otherwise delete it
ATypeCode

Returns: true if update was successful

◆ UpdateReceiptFrequency()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.UpdateReceiptFrequency	(	int	AExtractId,
		Boolean	AUpdateReceiptLetterFrequency,
		String	AReceiptLetterFrequency,
		Boolean	AUpdateReceiptEachGift,
		Boolean	AReceiptEachGift
	)

inlinestatic

update receipt letter frequency and 'receipt each gift' flag for all partners in given extract

Parameters

AExtractId
AUpdateReceiptLetterFrequency
AReceiptLetterFrequency
AUpdateReceiptEachGift
AReceiptEachGift

Returns: true if update was successful

◆ UpdateSolicitationFlag()

static Boolean Ict.Petra.Server.MPartner.Partner.WebConnectors.TExtractMasterWebConnector.UpdateSolicitationFlag	(	int	AExtractId,
		Boolean	ANoSolicitations,
		out int	ARowsAffected
	)

inlinestatic

update solicitations flag for all partners in given extract

Parameters

AExtractId
ANoSolicitations
ARowsAffected

Returns: true if update was successful

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

csharp/ICT/Petra/Server/lib/MPartner/web/ExtractMaster.cs

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AddSubscription()

◆ ChangeSubscription()

◆ CombineExtracts()

◆ CreateEmptyExtract()

◆ CreateFamilyExtractForPersons()

◆ CreateFamilyMembersExtract()

◆ CreateNewExtractFromPartnerKeys()

◆ DeleteSubscription()

◆ ExtractExists()

◆ GetAllExtractHeaders() [1/3]

◆ GetAllExtractHeaders() [2/3]

◆ GetAllExtractHeaders() [3/3]

◆ GetExtractId()

◆ GetExtractName()

◆ GetExtractRowsWithPartnerData()

◆ IntersectExtracts()

◆ PurgeExtracts()

◆ PurgeExtractsCount()

◆ SaveExtract()

◆ SaveExtractMaster()

◆ SubscriptionExists()

◆ SubtractExtracts()

◆ UpdateEmailGiftStatement()

◆ UpdatePartnerType()

◆ UpdateReceiptFrequency()

◆ UpdateSolicitationFlag()