com.plumtree.server
Interface IPTProperty

All Superinterfaces:
IPTLocalizable, IPTObject, IPTServerContext, IPTStorable, IPTUnknown

public interface IPTProperty
extends IPTObject

A Property represents normalized extended metadata about Plumtree objects. For example, a Card contains metadata such as the Card name, last modified date, etc. This is "standard" Plumtree metadata. A Card may also contain information such as the author of the underlying document, or the last modified time of the file. This data is associated with particular, named Properties (such as the "Author" Property.)

Author:
michaels
See Also:
IPTObjectProperties, IPTCardPropertyValues

Method Summary
 int GetCharacteristicsAsInt(int propertyCharacteristic)
          Properties have a number of characteristics which determine how the Property is used.
 java.lang.Object[][] GetCharacteristicsAsObject2DArray(int propertyCharacteristic)
          Properties have a number of characteristics which determine how the Property is used.
 java.lang.String GetCharacteristicsAsString(int propertyCharacteristic)
          Properties have a number of characteristics which determine how the Property is used.
 int[] GetMappings()
          Properties are associated with specified classes of Plumtree objects.
 IPTPickListEditor GetPickList()
          Properties may optionally be associated with picklists.
 int GetType()
          Returns the PT_PROPERTY_TYPES value with which this object was initialized
 void Initialize(int propType)
          Initialize must be called before the Property can be stored.
 void SetCharacteristics(int propertyCharacteristic, int characteristicValue)
          Properties have a number of characteristics which determine how the Property is used.
 void SetCharacteristics(int propertyCharacteristic, java.lang.Object[][] characteristicValue)
          Properties have a number of characteristics which determine how the Property is used.
 void SetCharacteristics(int propertyCharacteristic, java.lang.String characteristicValue)
          Properties have a number of characteristics which determine how the Property is used.
 void SetMappings(int[] classIDs)
          Properties are associated with specified classes of Plumtree objects.
 void UpdateValues(java.lang.Object[][] propertyValueInfo)
          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.
 
Methods inherited from interface com.plumtree.server.IPTObject
GetAdminFolderID, GetClassID, GetCreated, GetImageUUID, GetLastModified, GetObjectProperties, SetAdminFolderID, SetImageUUID, SetLastModified
 
Methods inherited from interface com.plumtree.server.IPTLocalizable
GetDescription, GetIsLocalized, GetLocalizedDescription, GetLocalizedDescriptions, GetLocalizedName, GetLocalizedNames, GetName, GetPrimaryLang, GetSupportsLocalization, SetDescription, SetIsLocalized, SetLocalizedDescriptions, SetLocalizedNames, SetName, SetPrimaryLang
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 
Methods inherited from interface com.plumtree.server.IPTServerContext
GetAccessLevel, GetACL, GetLastModifiedBy, GetLockState, GetObjectID, GetOwnerID, GetServerContextSettings, GetSession, GetSettings, LockObject, SetLastModifiedBy, SetObjectID, SetOwnerID, SetServerContextSettings, SetSettings, UnlockObject
 
Methods inherited from interface com.plumtree.server.IPTStorable
Store
 

Method Detail

Initialize

void Initialize(int propType)
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

Parameters:
propType - the Property type, from PT_PROPERTY_TYPES
See Also:
PT_PROPERTY_TYPES

GetType

int GetType()
Returns the PT_PROPERTY_TYPES value with which this object was initialized

Returns:
the PT_PROPERTY_TYPES value
See Also:
PT_PROPERTY_TYPES

GetCharacteristicsAsInt

int GetCharacteristicsAsInt(int propertyCharacteristic)
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.

Parameters:
propertyCharacteristic - the ID of the characteristic desired
Returns:
the value of the characteristic
See Also:
PT_PROPERTY_TYPES

GetCharacteristicsAsString

java.lang.String GetCharacteristicsAsString(int propertyCharacteristic)
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.

Parameters:
propertyCharacteristic - the ID of the characteristic desired
Returns:
the value of the characteristic
See Also:
PT_PROPERTY_TYPES

GetCharacteristicsAsObject2DArray

java.lang.Object[][] GetCharacteristicsAsObject2DArray(int propertyCharacteristic)
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.

Parameters:
propertyCharacteristic - the ID of the characteristic desired
Returns:
the value of the characteristic
See Also:
PT_PROPERTY_TYPES

SetCharacteristics

void SetCharacteristics(int propertyCharacteristic,
                        int characteristicValue)
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.

Parameters:
propertyCharacteristic - the ID of the characteristic
characteristicValue - the value to be assigned to the characteristic
See Also:
PT_PROPERTY_TYPES

SetCharacteristics

void SetCharacteristics(int propertyCharacteristic,
                        java.lang.String characteristicValue)
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.

Parameters:
propertyCharacteristic - the ID of the characteristic
characteristicValue - the value to be assigned to the characteristic
See Also:
PT_PROPERTY_TYPES

SetCharacteristics

void SetCharacteristics(int propertyCharacteristic,
                        java.lang.Object[][] characteristicValue)
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.

Parameters:
propertyCharacteristic - the ID of the characteristic
characteristicValue - the value to be assigned to the characteristic
See Also:
PT_PROPERTY_TYPES

GetPickList

IPTPickListEditor 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")

Returns:
the editor for the picklist
See Also:
IPTPickListEditor

UpdateValues

void UpdateValues(java.lang.Object[][] propertyValueInfo)
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.

Parameters:
propertyValueInfo - a 2D array describing the values to be changed. The columns in the array are described by the PT_EDIT_BULK_PROPDATA_COLUMNS constants.
See Also:
PT_EDIT_BULK_PROPDATA_COLUMNS

GetMappings

int[] 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.

Returns:
a 1D int array of the class IDs of the relevant classes, from the PT_CLASSIDS constants.

SetMappings

void SetMappings(int[] classIDs)
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.

Parameters:
classIDs - a 1D int array of the class IDs of the relevant classes, from the PT_CLASSIDS constants.


Copyright 2008 Plumtree Software Inc. All Rights Reserved.