HPE Content Manager SDK 9.1
HP.HPTRIM.SDK.CommunicationDetail Class Reference

Describes one of the Locations involved in the parent communication More...

Inheritance diagram for HP.HPTRIM.SDK.CommunicationDetail:
HP.HPTRIM.SDK.TrimChildObject HP.HPTRIM.SDK.TrimObject HP.HPTRIM.SDK.TrimPropertySet

Properties

string AddressDescription [get]
 Gets a formatted string of the address used for communication with this location. More...
 
string AddressDescriptionISO [get]
 Gets a formatted string (in ISO format) of the address used for communication with this location. More...
 
string AddressLines [get]
 Gets the address lines of the address used for communication with this location. More...
 
SnapAddressType AddressType [get]
 Gets the address type enum value that was used for communication with this location. More...
 
TrimURI AddressUri [get]
 Gets the URI identifying the particular address of the location used (see location locAddress list). More...
 
string City [get]
 Gets the city of the address used for communication with this location. More...
 
string Country [get]
 Gets the country of the address used for communication with this location. More...
 
string CountryISO [get]
 Gets the country (in ISO format) of the address used for communication with this location. More...
 
TrimDateTime Dated [get]
 Gets the actual date of the communication with this location. More...
 
CommunicatorType Direction [get, set]
 Gets the communicator type enum value indicating whether this communicator is sending or receiving the record. More...
 
string EmailAddress [get]
 Gets the email address used for communication with this location. More...
 
string FaxNumber [get]
 Gets the facsimile number used for communication with this location. More...
 
Location Location [get]
 Gets the location object associated with this communication. More...
 
string LocationName [get]
 Gets a description of the location at the time the communication was registered. More...
 
string Postcode [get]
 Gets the postcode of the address used for communication with this location. More...
 
Record RecordSent [get]
 Gets the Record object for this communication. More...
 
string Reference [get, set]
 Gets or sets a string representing a reference number that may have been associated with the communication (ie a registered mail registration number). More...
 
string Region [get]
 Gets the region of the address used for communication with this location. More...
 
string State [get]
 Gets the state of the address used for communication with this location. More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimChildObject
string Name [get]
 Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...
 
uint Idx [get]
 Gets the position in the child object list that this child object occupies. More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimObject
BaseObjectTypes TrimType [get]
 Gets a BaseObjectTypes enum value indicating the type of this object. More...
 
TrimURI Uri [get]
 Gets the unique row identifier for this object. Once an object has been committed to the database, typically by calling a Save method, this unique identifier is allocated. From that time on, the uri will remain constant and can never be changed. It is always unique across all objects of the same Type. More...
 
string URN [get]
 Gets the uniform resource name for this object. More...
 
string NameString [get]
 Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...
 
string NameStringExtra [get]
 Gets a more verbose description of this object, particularly when the name is perhaps a little cryptic or not enough to fully describe the object. More...
 
bool IsReadOnly [get]
 Gets a boolean parameter indicating if this object is "ReadOnly". This would generally indicate that none of the object's properties could be modified, in some cases there are exceptions that can be tested via CanModifyProperty method. More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimPropertySet
string ErrorMessage [get]
 All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
 
TrimException Error [get]
 All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...
 
Database Database [get]
 Gets the TRIM Database object in which this object resides. All Trim objects live within a particular TRIM database and cannot be created without one. More...
 
virtual string Caption [get]
 Gets the user-defined caption that has been associated with all TrimPropertySets of this type. More...
 
virtual TrimIcon Icon [get]
 Gets the icon value associated this TrimPropertySet. More...
 
bool IsModified [get]
 Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved. More...
 

Additional Inherited Members

- Public Member Functions inherited from HP.HPTRIM.SDK.TrimChildObject
void Delete ()
 Permanently removes this object and all its associated child objects from the database. More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimObject
bool IsMandatory (FieldDefinition field)
 Gets a boolean value indication whether the specified field must have a non-NULL value for this object. More...
 
bool IsValidFor (int purpose)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. More...
 
bool IsValidFor (int purpose, TrimMainObject purposeExtraObject)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraObject is necessary for some purpose types - once again, the derived class will have more information. More...
 
bool IsValidFor (int purpose, int purposeExtraEnumValue)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraInformation is necessary for some purpose types - once again, the derived class will have more information. More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimPropertySet
TrimIcon GetPropertyIcon (PropertyIds propertyId)
 Gets the icon value associated the a property of this object. More...
 
TrimMainObject GetPropertyTrimObject (PropertyIds dnPropId)
 
string GetPropertyString (PropertyIds dnPropId)
 
int GetPropertyLong (PropertyIds dnPropId)
 
long GetPropertyLong64 (PropertyIds dnPropId)
 
bool GetPropertyBool (PropertyIds dnPropId)
 
TrimDateTime GetPropertyDate (PropertyIds dnPropId)
 
TrimDecimal GetPropertyDecimal (PropertyIds dnPropId)
 
TrimCurrency GetPropertyCurrency (PropertyIds dnPropId)
 
TrimURI GetPropertyUri (PropertyIds dnPropId)
 
bool SetPropertyTrimObject (PropertyIds dnPropId, TrimMainObject newValue)
 
bool SetPropertyString (PropertyIds dnPropId, string newValue)
 
bool SetPropertyLong (PropertyIds dnPropId, int newValue)
 
bool SetPropertyLong64 (PropertyIds dnPropId, long newValue)
 
bool SetPropertyBool (PropertyIds dnPropId, bool newValue)
 
bool SetPropertyDate (PropertyIds dnPropId, TrimDateTime newValue)
 
bool SetPropertyCurrency (PropertyIds dnPropId, TrimCurrency newValue)
 
bool SetPropertyDecimal (PropertyIds dnPropId, TrimDecimal newValue)
 
bool SetPropertyDouble (PropertyIds dnPropId, double newValue)
 
bool SetPropertyUri (PropertyIds dnPropId, TrimURI newValue)
 
bool ClearProperty (PropertyIds dnPropId)
 
object GetProperty (PropertyIds propId)
 
bool SetProperty (PropertyIds propId, object newValue)
 
string GetPropertyAsString (PropertyIds propertyId, StringDisplayType propertyValueStringType, bool useHTMLEscapeChars)
 Gets a string representation of a property value in a format appropriate for a specific use. More...
 
bool IsMandatory (PropertyIds propertyId)
 Gets a boolean value indication whether the specified property must have a non-NULL value for this object. More...
 
bool VerifyProperty (PropertyIds propertyId, bool doMandatoryChecks)
 Verifies the value of a particular property, by cross checking it against other property values. The ErrorMessage property provides details if the verification fails. More...
 
bool CanModifyProperty (PropertyIds propertyId)
 Indicates whether the current user has the permission to modify the specified property. More...
 

Detailed Description

Describes one of the Locations involved in the parent communication

Property Documentation

string HP.HPTRIM.SDK.CommunicationDetail.AddressDescription
get

Gets a formatted string of the address used for communication with this location.

string HP.HPTRIM.SDK.CommunicationDetail.AddressDescriptionISO
get

Gets a formatted string (in ISO format) of the address used for communication with this location.

string HP.HPTRIM.SDK.CommunicationDetail.AddressLines
get

Gets the address lines of the address used for communication with this location.

SnapAddressType HP.HPTRIM.SDK.CommunicationDetail.AddressType
get

Gets the address type enum value that was used for communication with this location.

TrimURI HP.HPTRIM.SDK.CommunicationDetail.AddressUri
get

Gets the URI identifying the particular address of the location used (see location locAddress list).

string HP.HPTRIM.SDK.CommunicationDetail.City
get

Gets the city of the address used for communication with this location.

string HP.HPTRIM.SDK.CommunicationDetail.Country
get

Gets the country of the address used for communication with this location.

string HP.HPTRIM.SDK.CommunicationDetail.CountryISO
get

Gets the country (in ISO format) of the address used for communication with this location.

TrimDateTime HP.HPTRIM.SDK.CommunicationDetail.Dated
get

Gets the actual date of the communication with this location.

CommunicatorType HP.HPTRIM.SDK.CommunicationDetail.Direction
getset

Gets the communicator type enum value indicating whether this communicator is sending or receiving the record.

string HP.HPTRIM.SDK.CommunicationDetail.EmailAddress
get

Gets the email address used for communication with this location.

string HP.HPTRIM.SDK.CommunicationDetail.FaxNumber
get

Gets the facsimile number used for communication with this location.

Location HP.HPTRIM.SDK.CommunicationDetail.Location
get

Gets the location object associated with this communication.

string HP.HPTRIM.SDK.CommunicationDetail.LocationName
get

Gets a description of the location at the time the communication was registered.

string HP.HPTRIM.SDK.CommunicationDetail.Postcode
get

Gets the postcode of the address used for communication with this location.

Record HP.HPTRIM.SDK.CommunicationDetail.RecordSent
get

Gets the Record object for this communication.

string HP.HPTRIM.SDK.CommunicationDetail.Reference
getset

Gets or sets a string representing a reference number that may have been associated with the communication (ie a registered mail registration number).

string HP.HPTRIM.SDK.CommunicationDetail.Region
get

Gets the region of the address used for communication with this location.

string HP.HPTRIM.SDK.CommunicationDetail.State
get

Gets the state of the address used for communication with this location.