com.plumtree.server
Interface IPTPropertyMap

All Superinterfaces:

IPTUnknown

public interface IPTPropertyMap
extends IPTUnknown

The Property Map provides a mapping of Card Properties to Document Attributes

Version:

$Revision$

Author:

StephenC

Method Summary

void	Clear() Clears all Properties and their mappings.
java.lang.Object[][]	GetMappedFieldNames(int idProperty) Retrieves the mapped Field Names for a given property
java.lang.Object	GetMappedProperties() Returns all the property IDs that are mapped
void	Initialize(IPTSession pSession, IPTPropertyMap pParentMap) Associates a Session with this PropertyMap and optionally sets a Parent Map.
java.lang.Object	MapFields(java.lang.Object[][] vSafeArrayFields) Maps Fields to Properties.
void	RemovePropertyFromMap(int idProperty) Removes a particular Property from the map.
void	SetMappedFieldNames(int idProperty, java.lang.Object[][] pvSafeArrayFieldNames) Sets the mapped Field Names for a given property

Methods inherited from interface com.plumtree.server.IPTUnknown

GetInterfaces

Method Detail

Initialize

void Initialize(IPTSession pSession,
                IPTPropertyMap pParentMap)

Associates a Session with this PropertyMap and optionally sets a Parent Map. If no parent map is set, then this will be the top-level map.

Parameters:

pSession - Session to be associated with this Property Map

pParentMap - Top level map to inherit from (can be null)

GetMappedFieldNames

java.lang.Object[][] GetMappedFieldNames(int idProperty)

Retrieves the mapped Field Names for a given property

Parameters:

idProperty - ID of the property being mapped

Returns:

Returns a 1 column 2 dimensional array of the associated Field Names

SetMappedFieldNames

void SetMappedFieldNames(int idProperty,
                         java.lang.Object[][] pvSafeArrayFieldNames)

Sets the mapped Field Names for a given property

Parameters:

idProperty - ID of the property being mapped

pvSafeArrayFieldNames - a 1 column 2 dimensional array of the associated Field Names

GetMappedProperties

java.lang.Object GetMappedProperties()

Returns all the property IDs that are mapped

Returns:

Returns a 1 column 2 dimensional array of the mapped propertyIDs

RemovePropertyFromMap

void RemovePropertyFromMap(int idProperty)

Removes a particular Property from the map.

Parameters:

idProperty - ID of the Property to be removed

Clear

void Clear()

Clears all Properties and their mappings. This also clears the mappings in the Parent Property Map.

MapFields

java.lang.Object MapFields(java.lang.Object[][] vSafeArrayFields)

Maps Fields to Properties. Given a list of field names and their values, the mapping is used to generate a list of Property IDs and their values. If a Field is found to be unmapped in the local mapping, then the parent mapping is consulted.

Parameters:

vSafeArrayFields - A 2D array of Field Names and their values.

Returns:

A 2D array of Property IDs and the Field values that they are mapped to.