Ict.Petra.Shared.MCommon Namespace Reference

Namespaces
namespace	Data

Classes
class	CommonCodeHelper
	Gets descriptions for codes in the Common Module. More...
class	MCommonConstants
	this class defines some data types that can be used for Office Specific Data Labels More...
class	MCommonTypes
	collection of static methods that are useful for the types defined in MCommon More...
class	TFormData
	Base Class for mail merge form data More...
class	TFormDataAPPayment
	Contains data for individual AP Invoice payments More...
class	TFormDataApplicant
class	TFormDataAttendee
class	TFormDataCommitment
	Contains data for a commitment record for a person More...
class	TFormDataContactDetail
	Contains data for a contact detail entry for a partner More...
class	TFormDataContactLog
	Contains data for a contact log entry for a partner More...
class	TFormDataDegree
	Contains data for a degree record for a person More...
class	TFormDataFamilyMember
	Contains data for a family member More...
class	TFormDataGift
	Contains data for a gift detail for/from a partner More...
class	TFormDataKeyDescription
	Contains data for key/description pairs of data (used e.g. for printing setup screen keys and descriptions) (includes extra data fields) More...
class	TFormDataKeyDescriptionList
	Contains metadata and a list of key/description pairs of data (used e.g. for printing setup screen keys and descriptions) More...
class	TFormDataLanguage
	Contains data for a language record for a person More...
class	TFormDataPartner
	Contains data for a Partner to be used for export to forms More...
class	TFormDataPartnerList
	List Class for partner form data objects More...
class	TFormDataPassport
	Contains data for a passport record for a person More...
class	TFormDataPerson
	Contains data for a Person to be used for export to forms More...
class	TFormDataSkill
	Contains data for a skill record for a person More...
class	TFormDataSubscription
	Contains data for a subscription for a partner More...
class	TFormDataUnit
	Contains data for a Unit to be used for export to forms More...
class	TFormDataWorkExperience
	Contains data for a work experience record for a person More...
class	TFormLetterFinanceInfo
	Class to keep information about form letter creation process for finance letters More...
class	TFormLetterInfo
	Class to keep information about form letter creation process More...
class	TSharedAddressHandling
	Contains functions for handling of Addresses. More...

Enumerations
enum	TFormDataTarget { Excel , Word }
	enum to determine target platform for form data More...
enum	TFormDataRetrievalSection {   eGeneral , eFormalGreetings , ePartner , ePerson ,   eGiftTotal , eGiftDetail , eLocation , eLocationBlock ,   eContact , eContactDetail , eContactLog , eSubscription ,   eBanking , eLanguage , ePassport , eWorkExperience ,   eSkill , eFamilyMember , eSpecialNeeds , ePersonalData ,   eCommitment , eFutureCommitment }
	enum to determine target platform for form data More...
enum	TOfficeSpecificDataLabelUseEnum {   Person , Family , Church , Organisation ,   Unit , Bank , Venue , Personnel ,   LongTermApp , ShortTermApp }
	enumeration of values for items that can be associated with Office specific data labels More...

Enumeration Type Documentation

TFormDataRetrievalSection

enum Ict.Petra.Shared.MCommon.TFormDataRetrievalSection

enum to determine target platform for form data

Enumerator
eGeneral	retrieve general system info
eFormalGreetings	retrieve formality related data
ePartner	retrieve info from Partner Table
ePerson	retrieve info from Person Table
eGiftTotal	retrieve info from Gift Table
eGiftDetail	retrieve info from Gift Detail Table
eLocation	retrieve info from Location Table
eLocationBlock	retrieve info from Location Table for address layout block
eContact	retrieve info from Contacts Table (primary information)
eContactDetail	retrieve info from Contact Details Table
eContactLog	retrieve info from Contact Log Table
eSubscription	retrieve info from Subscription Table
eBanking	retrieve info from Bank tables
eLanguage	retrieve info from Language Table
ePassport	retrieve info from Passport Table
eWorkExperience	retrieve info from past experience Table
eSkill	retrieve info from Skill Table
eFamilyMember	retrieve basic info for family members
eSpecialNeeds	retrieve info from Special Needs Table
ePersonalData	retrieve info from Personal Data Table
eCommitment	retrieve info from Commitment Table
eFutureCommitment	retrieve info from Commitment Table (only future commitment needed)

TFormDataTarget

enum Ict.Petra.Shared.MCommon.TFormDataTarget

enum to determine target platform for form data

Enumerator
Excel	target is Excel (.xlsx)
Word	target is Word (.docx)

TOfficeSpecificDataLabelUseEnum

enum Ict.Petra.Shared.MCommon.TOfficeSpecificDataLabelUseEnum

enumeration of values for items that can be associated with Office specific data labels

Enumerator
Person	partner of class person
Family	partner of class family
Church	partner of class church
Organisation	partner of class organisation
Unit	partner of class unit
Bank	partner of class bank
Venue	partner of class venue
Personnel	personnel module
LongTermApp	long term application
ShortTermApp	short term application