Micro Focus Content Manager SDK 9.3
HP.HPTRIM.SDK.LocationAddress Class Reference

A physical address (ie street / post office box, etc) associated with the parent Location More...

Inheritance diagram for HP.HPTRIM.SDK.LocationAddress:
HP.HPTRIM.SDK.TrimChildObject HP.HPTRIM.SDK.ITrimActiveDates HP.HPTRIM.SDK.TrimObject HP.HPTRIM.SDK.TrimPropertySet

Public Member Functions

void SetActiveDateRange (TrimDateTime validFromDate, TrimDateTime validToDate)
 Sets the date range for which this object is active. Note that only the date component of the date and time is relevant for active date ranges. More...
 
- 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...
 
bool HasPermission (GenericPermissions prm)
 Checks to see if the currently logged in user has permission to perform the generic action on this object More...
 
bool HasPropertyPermission (GenericPermissions prm, PropertyIds propId)
 Checks to see if the currently logged in user has permission to perform the generic action on the specified property of this object 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...
 

Properties

string AddressLines [get, set]
 Gets or sets a string containing the house number and street name of this LocAddress. More...
 
AddressTypes AddressType [get, set]
 Gets or sets a atAddressType enum value indicating the Address Type of this LocAddress. For example, 'atStreet' or 'atPostal'. More...
 
string City [get, set]
 Gets or sets a string containing the city of this LocAddress (this property was used to contain the suburb in an older version of Content Manager). More...
 
string Country [get, set]
 Gets or sets a string containing the country for this address. More...
 
string Description [get, set]
 Gets or sets a string containing the full Address of this locAddress; including house number and street name ('AddressLines' property), city ('Suburb' property), state ('State' property) and postcode ('Postcode' property). More...
 
bool IsCurrent [get]
 Gets a Boolean value indicating whether this LocAddress is the current address for the Location. More...
 
string Postcode [get, set]
 Gets or sets a string containing the postcode for this LocAddress. More...
 
string Region [get, set]
 Gets or sets a string containing the region for this LocAddress More...
 
string State [get, set]
 Gets or sets a string containing the state for this LocAddress. More...
 
TrimDateTime DateActiveFrom [get]
 
TrimDateTime DateActiveTo [get]
 
string ActiveDateRangeDescription [get]
 
bool IsActive [get]
 
- 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...
 
bool PossiblyHasSubordinates [get]
 Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. 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...
 
- Properties inherited from HP.HPTRIM.SDK.ITrimActiveDates
TrimDateTime DateActiveFrom [get]
 Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...
 
TrimDateTime DateActiveTo [get]
 Gets the TrimDateTime property corresponding to when this object first became active. If the returned value is blank, it indicates that the item has always been active (until the DateActiveTo value). More...
 
string ActiveDateRangeDescription [get]
 Gets a string describing the period during which this object was active. More...
 
bool IsActive [get]
 Gets a boolean value indicating whether this object is currently active. More...
 

Detailed Description

A physical address (ie street / post office box, etc) associated with the parent Location

Member Function Documentation

void HP.HPTRIM.SDK.LocationAddress.SetActiveDateRange ( TrimDateTime  validFromDate,
TrimDateTime  validToDate 
)

Sets the date range for which this object is active. Note that only the date component of the date and time is relevant for active date ranges.

Implements HP.HPTRIM.SDK.ITrimActiveDates.

Property Documentation

string HP.HPTRIM.SDK.LocationAddress.ActiveDateRangeDescription
get
string HP.HPTRIM.SDK.LocationAddress.AddressLines
getset

Gets or sets a string containing the house number and street name of this LocAddress.

AddressTypes HP.HPTRIM.SDK.LocationAddress.AddressType
getset

Gets or sets a atAddressType enum value indicating the Address Type of this LocAddress. For example, 'atStreet' or 'atPostal'.

string HP.HPTRIM.SDK.LocationAddress.City
getset

Gets or sets a string containing the city of this LocAddress (this property was used to contain the suburb in an older version of Content Manager).

string HP.HPTRIM.SDK.LocationAddress.Country
getset

Gets or sets a string containing the country for this address.

TrimDateTime HP.HPTRIM.SDK.LocationAddress.DateActiveFrom
get
TrimDateTime HP.HPTRIM.SDK.LocationAddress.DateActiveTo
get
string HP.HPTRIM.SDK.LocationAddress.Description
getset

Gets or sets a string containing the full Address of this locAddress; including house number and street name ('AddressLines' property), city ('Suburb' property), state ('State' property) and postcode ('Postcode' property).

bool HP.HPTRIM.SDK.LocationAddress.IsActive
get
bool HP.HPTRIM.SDK.LocationAddress.IsCurrent
get

Gets a Boolean value indicating whether this LocAddress is the current address for the Location.

string HP.HPTRIM.SDK.LocationAddress.Postcode
getset

Gets or sets a string containing the postcode for this LocAddress.

string HP.HPTRIM.SDK.LocationAddress.Region
getset

Gets or sets a string containing the region for this LocAddress

string HP.HPTRIM.SDK.LocationAddress.State
getset

Gets or sets a string containing the state for this LocAddress.