Property Object

Manages the maintenance of Property objects.
Property Description
Country String - Country code. The country to which this property is specific, or an empty string if applicable to all countries.
Description String - Property description
Id Long - database identifier for this item (read only)
IsDeleted True/False - item has been flagged for deletion
IsDirty True/False - item has been modified but not saved yet
IsEditing True/false - item is in the process of being edited
IsNew True/false - item is new and has not been saved
IsValid True/false - indicates if the item has any errors
Propety String - Property name
Description String - Property description
PropertyType Long - Property type (text, number, date, etc)
PropertyTypes Textlist object - containing a list of valid property types
PropertyTypeName String - Property type description
PropertyValue String - Property values. Empty if no restriction on value
PropertyValues Collection - PropertyValue string converted to a collection, where the values are delimited by a comma, , or
Scope Long - property's scope (payroll, pay group, payee or pay item)
Scopes Textlist object - containing a list of valid scopes
SysytemProperty Boolean - true if this property is required by the system and should not be changed

In order to apply any changes to an object, the BeginEdit method must be called setting any property values. To save the changes, call the ApplyEdit method, and to undo the changes call the CancelEdit method.

Method Description
ApplyEdit(Server, Connection) Saves the item in the database. Server is a string containing the name of the network server to provide the data, and Connection is the ADO connection string to establish a connection with the database on that server.
BeginEdit Prepares the item for updating.
CancelEdit Reverses the changes in the current edit session and restores the state of the item to that preceding the last BeginEdit.
Delete Flags the item for deletion. The item will be deleted from the database when the next ApplyEdit is called. A Delete must be preceded by a BeginEdit.
Load(Server, Connection, Id) Loads into this object the data from the database for the specified database record id.