Ict.Petra.Shared.MPartner Namespace Reference

Namespaces
namespace	Mailroom
namespace	Partner

Classes
class	EPartnerFamilyIDException
	Throw this exception to signalize that there is a problem in finding a family ID More...
class	EPartnerLocationNotExistantException
	Can be thrown to signalise that a PPartnerLocation Key does not exist in the DB More...
class	EPartnerNotExistantException
	Throw this Exception when a Business Object is asked to load data for a Partner that does either not exist or is deleted, not active, etc. whatever is applicable to the situation. More...
class	ESecurityPartnerAccessDeniedException
	Thrown if a Partner cannot be opened for security reasons More...
class	MPartnerConstants
	some constants used in the partner module More...
class	TLocationPK
	Class that holds a combination of SiteKey and LocationKey. More...
class	TLocationPKCopyHelper
	Static helper class for creating 'deep copies' of two-dimensional TLocationPK arrays. More...
class	TSecurity
	Contains security-related functions for Partners that that can be used by any Class. More...

Enumerations
enum	TPartnerEditTabPageEnum {   petpDefault , petpAddresses , petpDetails , petpContactDetails ,   petpFoundationDetails , petpSubscriptions , petpPartnerTypes , petpFamilyMembers ,   petpOfficeSpecific , petpInterests , petpReminders , petpPartnerRelationships ,   petpContacts , petpNotes , petpFinanceDetails , petpPersonnelIndividualData ,   petpPersonnelApplications }
	enumeration for the tab pages on Partner Edit screen More...
enum	TPartnerInfoScopeEnum {   pisHeadOnly , pisPartnerLocationOnly , pisPartnerLocationAndRestOnly , pisLocationPartnerLocationOnly ,   pisLocationPartnerLocationAndRestOnly , pisPartnerAttributesOnly , pisFull }
	Specifies the Scope of data that is to be returned to the Partner Info UserControl. More...
enum	eShortNameFormat {   eShortname , eReverseShortname , eOnlyTitle , eOnlySurname ,   eOnlyFirstname , eOnlySurnameFirstNameInitial , eReverseLastnameInitialsOnly , eReverseWithoutTitle ,   eJustRemoveTitle }
enum	TPartnerAttributeTypeValueKind {   CONTACTDETAIL_GENERAL , CONTACTDETAIL_HYPERLINK , CONTACTDETAIL_HYPERLINK_WITHVALUE , CONTACTDETAIL_EMAILADDRESS ,   CONTACTDETAIL_SKYPEID }
	'Value Kinds' of PPartnerAttributeType records. They describe what kind of value the 'Value' of a PPartnerAttribute record represents. More...
enum	TMergeActionEnum { ADDRESS , CONTACTDETAIL , BANKACCOUNT }
	Defines which merge action we need data for (used in Partner Merge) More...

Enumeration Type Documentation

eShortNameFormat

enum Ict.Petra.Shared.MPartner.eShortNameFormat

different ways to format the shortname of a partner used eg by Ict.Petra.Server.MPartner.Common.Calculations.FormatShortName()

Enumerator
eShortname	lastname, firstname, title
eReverseShortname	title firstname lastname
eOnlyTitle	title
eOnlySurname	family name
eOnlyFirstname	first name
eOnlySurnameFirstNameInitial	family name, f.
eReverseLastnameInitialsOnly	firstname l.; useful for data protection
eReverseWithoutTitle	firstname lastname
eJustRemoveTitle	lastname, firstname (just remove title field)

TMergeActionEnum

enum Ict.Petra.Shared.MPartner.TMergeActionEnum

Defines which merge action we need data for (used in Partner Merge)

Enumerator
ADDRESS	Address
CONTACTDETAIL	Contact Detail
BANKACCOUNT	Bank Account

TPartnerAttributeTypeValueKind

enum Ict.Petra.Shared.MPartner.TPartnerAttributeTypeValueKind

'Value Kinds' of PPartnerAttributeType records. They describe what kind of value the 'Value' of a PPartnerAttribute record represents.

Enumerator
CONTACTDETAIL_GENERAL	Value which is not a kind of value that the other members of this Enumeration represent.
CONTACTDETAIL_HYPERLINK	Hyperlink (for various protocols, e.g. HTTP, HTTPS, FTP, etc. )
CONTACTDETAIL_HYPERLINK_WITHVALUE	Hyperlink that contains a text part that is replaced with a variable value
CONTACTDETAIL_EMAILADDRESS	E-Mail Address
CONTACTDETAIL_SKYPEID	Skype ID

TPartnerEditTabPageEnum

enum Ict.Petra.Shared.MPartner.TPartnerEditTabPageEnum

enumeration for the tab pages on Partner Edit screen

Enumerator
petpDefault	the default page
petpAddresses	address page
petpDetails	detail page (different for each partner class)
petpContactDetails	page for contacts
petpFoundationDetails	detail page for partner class foundations
petpSubscriptions	page for subscriptions
petpPartnerTypes	page for partner types
petpFamilyMembers	page for family members
petpOfficeSpecific	page for office specific data labels
petpInterests	page for interests
petpReminders	page for reminders
petpPartnerRelationships	page for relationships between partners
petpContacts	page for contact management
petpNotes	page for notes about the partner
petpFinanceDetails	page for bank accounts and other finance details of the partner
petpPersonnelIndividualData	page for individual data about the partner (Personnel Module)
petpPersonnelApplications	page for applications of the partner (Personnel Module)

TPartnerInfoScopeEnum

enum Ict.Petra.Shared.MPartner.TPartnerInfoScopeEnum

Specifies the Scope of data that is to be returned to the Partner Info UserControl.

Enumerator
pisHeadOnly	Partner 'head' data only
pisPartnerLocationOnly	Partner Location only, excluding rest of the data and 'head' data
pisPartnerLocationAndRestOnly	Partner Location and rest of the data only, excluding 'head' data
pisLocationPartnerLocationOnly	Location and Partner Location only, excluding rest of the data and 'head' data
pisLocationPartnerLocationAndRestOnly	Location, Partner Location and rest of the data only, excluding 'head' data
pisPartnerAttributesOnly	Partner Contact Details only, excluding rest of the data and 'head' data
pisFull	All PartnerInfo data