General.Contacts.PartyContactMechanisms Entity

Namespace: General.Contacts
Inherited From: General.Contacts.ContactMechanisms

Specifies the contact mechanisms, which are attached to the parties. Currently each contact mechanism is attached to strictly one party. Entity: Cm_Party_Contact_Mechanisms

Default Visualization

Default Display Text Format:
{ContactMechanismType}: {Name}
Default Search Members:
Name
Name Data Member:
Name
Category: Definitions
Show in UI: ShownByDefault

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Parent:
General.Contacts.Parties
Aggregate Root:
General.Contacts.Parties

Attributes

Name	Type	Description
ContactMechanismType	ContactMechanismType	A=Address; E=e-mail; T=Telephone. `Required` `Default("A")` `Filter(multi eq)` (Inherited from ContactMechanisms)
DisplayText	string	Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
FromDate	datetime nullable	The first date when the contact mechanism was valid. null means unknown date. `Default(Today)` `Filter(eq;ge;le)`
Id	guid
IsActive	boolean	True if the contact mechanism is currently active and can be used to contact the party. `Required` `Default(true)` `Filter(eq)`
IsDefault	boolean	True - when this is the default contact mechanism for this party; false - otherwise. `Required` `Default(false)` `Filter(eq)`
LineOrd	int32	Consecutive number of the contact information. The number is unique within the party. `Required`
Name	string (254)	Contact mechanism description. `Required` `Filter(eq;like)` (Inherited from ContactMechanisms)
NonSolicitation	boolean	If true then Don't use the mechanism for solicitation purposes. `Required` `Default(false)` `Filter(eq)`
Notes	string (254) nullable	Notes for this PartyContactMechanism.
ObjectVersion	int32	The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
ThruDate	datetime nullable	The last date on which the contact mechanism was valid for the party. null if the contact mechanism is still valid. `Filter(eq;ge;le)`

References

Name	Type	Description
AdministrativeRegion	AdministrativeRegions (nullable)	The administrative region, where the contact mechanism is situated. Null if this is unknown or N/A. `Filter(multi eq)` `Introduced in version 18.2` (Inherited from ContactMechanisms)
ContactMechanism	ContactMechanisms	Returns this `PartyContactMechanism`(General.Contacts.PartyContactMechanisms.md). DO NOT USE! Kept for backward compatibility. When a contact mechanism is set, the old inner contact mechanism becomes an orphan. If the orphan is newly added in this transaction it is deleted.
ContactMechanismPurpose	ContactMechanismPurposes (nullable)	The purpose of this contact mechanism. Unique within the party. Can be used to seek for specific contact mechanisms. `Filter(multi eq)` `Introduced in version 18.2`
GeoPoint	GeoPoints (nullable)	The geographical point, where the contact mechanism is situated. Null if this is unknown or N/A. `Filter(multi eq)` `Introduced in version 18.2` (Inherited from ContactMechanisms)
Party	Parties	The party, having the contact mechanism. `Required` `Filter(multi eq)` `Owner`
PersonalDataProcess	PersonalDataProcesses (nullable)	The personal data process, which is used to process the current data. Null when the data is not personal or when the process is unknown. `Filter(multi eq)` `Introduced in version 18.2`

Attribute Details

ContactMechanismType

A=Address; E=e-mail; T=Telephone. Required Default("A") Filter(multi eq) (Inherited from ContactMechanisms)

Type: ContactMechanismType
Category: System
Allowed values for the ContactMechanismType(General.Contacts.ContactMechanisms.md#contactmechanismtype) data attribute
Allowed Values (General.Contacts.ContactMechanismsRepository.ContactMechanismType Enum Members)

Value	Description
Address	Address value. Stored as 'A'. Database Value: 'A' Model Value: 0 Domain API Value: 'Address'
Mail	Mail value. Stored as 'E'. Database Value: 'E' Model Value: 1 Domain API Value: 'Mail'
Fax	Fax value. Stored as 'F'. Database Value: 'F' Model Value: 2 Domain API Value: 'Fax'
MobilePhone	MobilePhone value. Stored as 'M'. Database Value: 'M' Model Value: 3 Domain API Value: 'MobilePhone'
Other	Other value. Stored as 'O'. Database Value: 'O' Model Value: 4 Domain API Value: 'Other'
Telephone	Telephone value. Stored as 'T'. Database Value: 'T' Model Value: 5 Domain API Value: 'Telephone'
WebSite	WebSite value. Stored as 'W'. Database Value: 'W' Model Value: 6 Domain API Value: 'WebSite'
PostalCode	PostalCode value. Stored as 'P'. Database Value: 'P' Model Value: 7 Domain API Value: 'PostalCode'
WebProfile	WebProfile value. Stored as 'X'. Database Value: 'X' Model Value: 8 Domain API Value: 'WebProfile'

Supported Filters: Equals, EqualsIn
Supports Order By: False
Default Value: Address
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

FromDate

The first date when the contact mechanism was valid. null means unknown date. Default(Today) Filter(eq;ge;le)

Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDate
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsActive

True if the contact mechanism is currently active and can be used to contact the party. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

IsDefault

True - when this is the default contact mechanism for this party; false - otherwise. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

LineOrd

Consecutive number of the contact information. The number is unique within the party. Required

Type: int32
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

Back-End Default Expression:
( obj.Party.ContactMechanisms.Select( c => c.LineOrd).DefaultIfEmpty( 0).Max( ) + 1)

Front-End Recalc Expressions:
( obj.Party.ContactMechanisms.Select( c => c.LineOrd).DefaultIfEmpty( 0).Max( ) + 1)

Name

Contact mechanism description. Required Filter(eq;like) (Inherited from ContactMechanisms)

Type: string (254)
Category: System
Supported Filters: Equals, Like
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

NonSolicitation

If true then Don't use the mechanism for solicitation purposes. Required Default(false) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: False
Show in UI: ShownByDefault

Notes

Notes for this PartyContactMechanism.

Type: string (254) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 254
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

ThruDate

The last date on which the contact mechanism was valid for the party. null if the contact mechanism is still valid. Filter(eq;ge;le)

Type: datetime nullable
Category: System
Supported Filters: Equals, GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

Reference Details

AdministrativeRegion

The administrative region, where the contact mechanism is situated. Null if this is unknown or N/A. Filter(multi eq) Introduced in version 18.2 (Inherited from ContactMechanisms)

Type: AdministrativeRegions (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

ContactMechanism

Returns this PartyContactMechanism(General.Contacts.PartyContactMechanisms.md). DO NOT USE! Kept for backward compatibility. When a contact mechanism is set, the old inner contact mechanism becomes an orphan. If the orphan is newly added in this transaction it is deleted.

Type: ContactMechanisms
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: CannotBeShown

ContactMechanismPurpose

The purpose of this contact mechanism. Unique within the party. Can be used to seek for specific contact mechanisms. Filter(multi eq) Introduced in version 18.2

Type: ContactMechanismPurposes (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

GeoPoint

The geographical point, where the contact mechanism is situated. Null if this is unknown or N/A. Filter(multi eq) Introduced in version 18.2 (Inherited from ContactMechanisms)

Type: GeoPoints (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Party

The party, having the contact mechanism. Required Filter(multi eq) Owner

Type: Parties
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Filterable Reference: True
Show in UI: ShownByDefault

PersonalDataProcess

The personal data process, which is used to process the current data. Null when the data is not personal or when the process is unknown. Filter(multi eq) Introduced in version 18.2

Type: PersonalDataProcesses (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

customPropertyCode
The code of the custom property
Type: string
search
The search text - searches by value or description. Can contain wildcard character %.
Type: string
Optional: True
Default Value: null
exactMatch
If true the search text should be equal to the property value
Type: boolean
Optional: True
Default Value: False
orderByDescription
If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
Type: boolean
Optional: True
Default Value: False
top
The top clause - default is 10
Type: int32
Optional: True
Default Value: 10
skip
The skip clause - default is 0
Type: int32
Optional: True
Default Value: 0

CreateNotification

Creates a notification and sends a real time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST