| |  | Aqualogic Interaction API | |
| | IPTProperty Members
|
IPTProperty overview
Public Instance Methods
 GetCharacteristicsAsInt | Properties have a number of characteristics which determine how the Property is used. These characteristics are defined by the PT_PROPERTY_CHARACTERISTICS constants. Call this function to return a characteristic that is stored as an integer. |
| GetCharacteristicsAsObject2DArray | Properties have a number of characteristics which determine how the Property is used. These characteristics are defined by the PT_PROPERTY_CHARACTERISTICS constants. Call this function to return a characteristic that is stored as a 2D array. |
| GetCharacteristicsAsString | Properties have a number of characteristics which determine how the Property is used. These characteristics are defined by the PT_PROPERTY_CHARACTERISTICS constants. Call this function to return a characteristic that is stored as an string. |
| GetMappings | Properties are associated with specified classes of Plumtree objects. For example, the "Home Address" Property might apply to User objects, but not to Portlet objects. The GetMappings call returns the Class IDs to which this Property is relevant. |
| GetPickList | Properties may optionally be associated with picklists. These picklists are used to supply choices to the user for the value of the Property. For example, if a system had a Nationality Property, it might make sense to display a picklist containing values like "Canada, USA, Mexico". This way, the values are standardized (e.g. a user won't type in "America" or "United States of America" instead of "USA") |
| GetType | Returns the PT_PROPERTY_TYPES value with which this object was initialized |
| Initialize | Initialize must be called before the Property can be stored. This is a one time operation- new Properties must be initialized, but when a Property is loaded from the database, Initialize should NOT be called |
| SetCharacteristics | Overloaded. Properties have a number of characteristics which determine how the Property is used. These characteristics are defined by the PT_PROPERTY_CHARACTERISTICS constants. Call this function to set the value of a characteristic. |
| SetMappings | Properties are associated with specified classes of Plumtree objects. For example, the "Home Address" Property might apply to User objects, but not to Portlet objects. The SetMappings call specifies to which Class IDs this Property is relevant. |
| UpdateValues | Property values can be updated "in bulk." For instance, suppose that each Plumtree object contained a Department Property, which recorded the department in the company that was responsible for maintaining the object. If a department changed names, it would be awkward to change every object associated with the department, and change the name in the object. Instead, UpdateValues can be used to replace all instances of the old department name with the new department name in a single API call. To change data in bulk, call the UpdateValues function with a 2D array of data. The columns in the array are described by the PT_EDIT_BULK_PROPDATA_COLUMNS constants. Create one row for each value that should be updated. |
See Also
IPTProperty Interface | com.plumtree.server Namespace | IPTObjectProperties | IPTCardPropertyValues