com.plumtree.server
Interface IPTCardPropertyValue

All Superinterfaces:
IPTUnknown

public interface IPTCardPropertyValue
extends IPTUnknown


Method Summary
 double GetFieldValueAsDouble()
          Returns the underlying double value currently assigned to the property represented by this object.
 float GetFieldValueAsFloat()
          Returns the underlying float value currently assigned to the property represented by this object.
 int GetFieldValueAsInt()
          Returns the underlying int value currently assigned to the property represented by this object.
 java.lang.String GetFieldValueAsString()
          Returns the underlying String value currently assigned to the property represented by this object.
 com.plumtree.openfoundation.util.XPDateTime GetFieldValueAsXPDateTime()
          Returns the underlying XPDateTime value currently assigned to the property represented by this object.
 boolean GetOverrideEnabled()
          Retrieves a boolean indicating whether an override value has been set for the property represented by this object
 double GetOverrideValueAsDouble()
          Gets the overriding double value for the property represented by this object.
 float GetOverrideValueAsFloat()
          Gets the overriding float value for the property represented by this object.
 int GetOverrideValueAsInt()
          Sets the underlying double value for the property represented by this object.
 java.lang.Object GetOverrideValueAsObject()
          Gets the overriding object value for the property represented by this object.
 java.lang.String GetOverrideValueAsString()
          Gets the overriding String value for the property represented by this object.
 com.plumtree.openfoundation.util.XPDateTime GetOverrideValueAsXPDateTime()
          Gets the overriding XPDateTime value for the property represented by this object.
 int GetPropertyID()
          Returns the property ID for which this object contains value assignments.
 int GetPropertyType()
          Returns the type of the property value.
 double GetValueAsDouble()
          Returns the double value currently assigned to the property represented by this object.
 float GetValueAsFloat()
          Returns the Float value currently assigned to the property represented by this object.
 int GetValueAsInt()
          Retrieves the int value currently assigned to the property represented by this object.
 java.lang.String GetValueAsString()
          Returns the String value currently assigned to the property represented by this object.
 com.plumtree.openfoundation.util.XPDateTime GetValueAsXPDateTime()
          Returns the XPDateTime value currently assigned to the property represented by this object.
 void SetFieldValue(double Value)
          Sets the underlying double value for the property represented by this object.
 void SetFieldValue(float Value)
          Sets the underlying float value for the property represented by this object.
 void SetFieldValue(int Value)
          Sets the underlying int value for the property represented by this object.
 void SetFieldValue(java.lang.String Value)
          Sets the underlying String value for the property represented by this object.
 void SetFieldValue(com.plumtree.openfoundation.util.XPDateTime Value)
          Sets the underlying XPDateTime value for the property represented by this object.
 void SetOverrideValue(double Value)
          Sets the overriding double value for the property represented by this object.
 void SetOverrideValue(float Value)
          Sets the overriding float value for the property represented by this object.
 void SetOverrideValue(int Value)
          Sets the overriding int value for the property represented by this object.
 void SetOverrideValue(java.lang.Object Value)
          Sets the overriding Object value for the property represented by this object.
 void SetOverrideValue(java.lang.String Value)
          Sets the overriding String value for the property represented by this object.
 void SetOverrideValue(com.plumtree.openfoundation.util.XPDateTime Value)
          Sets the overriding XPDateTime value for the property represented by this object.
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

GetPropertyID

public int GetPropertyID()
Returns the property ID for which this object contains value assignments.
Returns:
an int value for the property ID

GetValueAsInt

public int GetValueAsInt()
Retrieves the int value currently assigned to the property represented by this object.
Returns:
a simple int identifying the property ID.

GetValueAsString

public java.lang.String GetValueAsString()
Returns the String value currently assigned to the property represented by this object.
Returns:
A String value stored for this card property

GetValueAsXPDateTime

public com.plumtree.openfoundation.util.XPDateTime GetValueAsXPDateTime()
Returns the XPDateTime value currently assigned to the property represented by this object.
Returns:
An XPDateTime value stored for this card property.

GetValueAsFloat

public float GetValueAsFloat()
Returns the Float value currently assigned to the property represented by this object.
Returns:
A Float value stored for this card property.

GetValueAsDouble

public double GetValueAsDouble()
Returns the double value currently assigned to the property represented by this object.
Returns:
A double value stored for this card property.

GetFieldValueAsInt

public int GetFieldValueAsInt()
Returns the underlying int value currently assigned to the property represented by this object. (ignores any override)
Returns:
An underlying int field value stored for this card property

GetFieldValueAsString

public java.lang.String GetFieldValueAsString()
Returns the underlying String value currently assigned to the property represented by this object. (ignores any override)
Returns:
An underlying String field value stored for this card property

GetFieldValueAsXPDateTime

public com.plumtree.openfoundation.util.XPDateTime GetFieldValueAsXPDateTime()
Returns the underlying XPDateTime value currently assigned to the property represented by this object. (ignores any override)
Returns:
An underlying XPDateTime field value stored for this card property

GetFieldValueAsFloat

public float GetFieldValueAsFloat()
Returns the underlying float value currently assigned to the property represented by this object. (ignores any override)
Returns:
An underlying float field value stored for this card property

GetFieldValueAsDouble

public double GetFieldValueAsDouble()
Returns the underlying double value currently assigned to the property represented by this object. (ignores any override)
Returns:
An underlying double field value stored for this card property

SetFieldValue

public void SetFieldValue(int Value)
Sets the underlying int value for the property represented by this object. (ignores any override)
Parameters:
Value - an int stored as the field value for the property instance

SetFieldValue

public void SetFieldValue(java.lang.String Value)
Sets the underlying String value for the property represented by this object. (ignores any override)
Parameters:
Value - a String stored as the field value for the property instance

SetFieldValue

public void SetFieldValue(com.plumtree.openfoundation.util.XPDateTime Value)
Sets the underlying XPDateTime value for the property represented by this object. (ignores any override)
Parameters:
Value - an XPDateTime stored as the field value for the property instance

SetFieldValue

public void SetFieldValue(float Value)
Sets the underlying float value for the property represented by this object. (ignores any override)
Parameters:
Value - a float stored as the field value for the property instance

SetFieldValue

public void SetFieldValue(double Value)
Sets the underlying double value for the property represented by this object. (ignores any override)
Parameters:
Value - a double stored as the field value for the property instance

GetOverrideValueAsInt

public int GetOverrideValueAsInt()
Sets the underlying double value for the property represented by this object. (ignores any override)
Parameters:
Value - a double stored as the field value for the property instance

GetOverrideValueAsString

public java.lang.String GetOverrideValueAsString()
Gets the overriding String value for the property represented by this object.
Returns:
a String stored as the override value for the property instance

GetOverrideValueAsXPDateTime

public com.plumtree.openfoundation.util.XPDateTime GetOverrideValueAsXPDateTime()
Gets the overriding XPDateTime value for the property represented by this object.
Returns:
an XPDateTime stored as the override value for the property instance

GetOverrideValueAsFloat

public float GetOverrideValueAsFloat()
Gets the overriding float value for the property represented by this object.
Returns:
a float stored as the override value for the property instance

GetOverrideValueAsDouble

public double GetOverrideValueAsDouble()
Gets the overriding double value for the property represented by this object.
Returns:
a double stored as the override value for the property instance

GetOverrideValueAsObject

public java.lang.Object GetOverrideValueAsObject()
Gets the overriding object value for the property represented by this object.
Returns:
an object stored as the override value for the property instance

SetOverrideValue

public void SetOverrideValue(int Value)
Sets the overriding int value for the property represented by this object.
Parameters:
an - int stored as the override value for the property instance

SetOverrideValue

public void SetOverrideValue(java.lang.String Value)
Sets the overriding String value for the property represented by this object.
Parameters:
a - String stored as the override value for the property instance

SetOverrideValue

public void SetOverrideValue(com.plumtree.openfoundation.util.XPDateTime Value)
Sets the overriding XPDateTime value for the property represented by this object.
Parameters:
an - XPDateTime stored as the override value for the property instance

SetOverrideValue

public void SetOverrideValue(float Value)
Sets the overriding float value for the property represented by this object.
Parameters:
a - float stored as the override value for the property instance

SetOverrideValue

public void SetOverrideValue(double Value)
Sets the overriding double value for the property represented by this object.
Parameters:
a - double stored as the override value for the property instance

SetOverrideValue

public void SetOverrideValue(java.lang.Object Value)
Sets the overriding Object value for the property represented by this object.
Parameters:
an - Object stored as the override value for the property instance

GetOverrideEnabled

public boolean GetOverrideEnabled()
Retrieves a boolean indicating whether an override value has been set for the property represented by this object
Returns:
boolean, true means override value has been provided

GetPropertyType

public int GetPropertyType()
Returns the type of the property value. This can be used to determine which of the GetValueAsXXX methods to use.
Returns:
int enumerated value of PT_PROPERTY_TYPE


Copyright © 2003 Plumtree Software Inc. All Rights Reserved.