com.plumtree.server
Interface IPTCardPropertyValues

All Superinterfaces:
IPTUnknown

public interface IPTCardPropertyValues
extends IPTUnknown


Method Summary
 IPTCardPropertyValue Add(int nPropertyID)
          Extends the list of properties stored with this card.
 void Clear()
          Clears from the object in memory all existing property data.
 void ClearFieldValues()
          Clears values from the object in memory for all existing property data, but retains the value-less IPTCardPropertyValue(s).
 IPTCardPropertyValues Clone()
          Creates an in-memory copy of the IPTCardPropertyValues object.
 com.plumtree.openfoundation.util.IXPEnumerator GetEnumerator()
          Retrieves an enumerator of IPTCardPropertyValue objects which can be used to modify the values of properties stored with the card representing this document.
 IPTCardPropertyValue GetItem(int nPropertyID)
          Returns a property value object for the property ID specified.
 java.lang.Object[] GetPropertyIDs()
          Creates and returns an array of Integers identifying property IDs currently stored with this card
 void Remove(int nPropertyID)
          Removes a property and its values from the list of properties stored with this card.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetItem

public IPTCardPropertyValue GetItem(int nPropertyID)
Returns a property value object for the property ID specified. The returned object can then be modified and will be serialized when the card is stored.
Parameters:
nPropertyID - An ID specifying an existing card property
Returns:
a property value object containing the value for the desired property

GetEnumerator

public com.plumtree.openfoundation.util.IXPEnumerator GetEnumerator()
Retrieves an enumerator of IPTCardPropertyValue objects which can be used to modify the values of properties stored with the card representing this document.
Returns:
An IXPEnumerator containing all existing card properties represented in IPTCardPropertyValue objects

Add

public IPTCardPropertyValue Add(int nPropertyID)
Extends the list of properties stored with this card. The returned IPTCardPropertyValue interface can be used to assign a specific value to the new property.
Parameters:
nPropertyID - The ID of an existing property not currently stored with this card.
Returns:
An IPTCardPropertyValue object corresponding to the requested ID.

Remove

public void Remove(int nPropertyID)
Removes a property and its values from the list of properties stored with this card.
Parameters:
nPropertyID - The ID of a property currently stored with this card.

Clear

public void Clear()
Clears from the object in memory all existing property data.

ClearFieldValues

public void ClearFieldValues()
Clears values from the object in memory for all existing property data, but retains the value-less IPTCardPropertyValue(s).

Clone

public IPTCardPropertyValues Clone()
Creates an in-memory copy of the IPTCardPropertyValues object. Convenient for seeding new cards with a custom set of base properties.
Returns:
A duplicate IPTCardPropertyValues object.

GetPropertyIDs

public java.lang.Object[] GetPropertyIDs()
Creates and returns an array of Integers identifying property IDs currently stored with this card
Returns:
An Integer array of Property IDs.


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.