com.plumtree.server
Interface IPTPropertyFilterStatement

All Superinterfaces:
IPTPropertyFilterItem, IPTUnknown

public interface IPTPropertyFilterStatement
extends IPTPropertyFilterItem

A PropertyFilterStatement is an element within a filter that specifies an atomic condition, such as "Name = 'Fred'". PropertyFilterStatements can be combined through the use of IPTPropertyFilterClauses. See the documentation on IPTPropertyFilterItem for information on the relation between clauses, items, and statements.

Author:
micahels
See Also:
IPTFilter, IPTPropertyFilterClauses, IPTPropertyFilterItem

Method Summary
 int GetOperand()
          Returns the operand for the filter statement.
 int GetOperator()
          Returns the operator for the filter statement.
 double GetValueAsDouble()
          Returns the value for the filter statement.
 float GetValueAsFloat()
          Returns the value for the filter statement.
 int GetValueAsInt()
          Returns the value for the filter statement.
 java.lang.Object GetValueAsObject()
          Returns the value for the filter statement.
 java.lang.String GetValueAsString()
          Returns the value for the filter statement.
 com.plumtree.openfoundation.util.XPDateTime GetValueAsXPDateTime()
          Returns the value for the filter statement.
 void SetOperand(int Value)
          Sets the operand for the filter statement.
 void SetOperator(int Value)
          Sets the operator for the filter statement.
 void SetValue(double Value)
          Sets the value for the filter statement.
 void SetValue(float Value)
          Sets the value for the filter statement.
 void SetValue(int Value)
          Sets the value for the filter statement.
 void SetValue(java.lang.Object Value)
          Sets the value for the filter statement.
 void SetValue(java.lang.String Value)
          Sets the value for the filter statement.
 void SetValue(com.plumtree.openfoundation.util.XPDateTime Value)
          Sets the value for the filter statement.
 
Methods inherited from interface com.plumtree.server.IPTPropertyFilterItem
Clone, Export, GetType, Import
 
Methods inherited from interface com.plumtree.server.IPTUnknown
GetInterfaces
 

Method Detail

SetOperand

void SetOperand(int Value)
Sets the operand for the filter statement. In the example "Name = 'Fred'", the operand is Name. This should be a value from PT_PROPIDS.

Parameters:
Value - the operand
See Also:
PT_PROPIDS

GetOperand

int GetOperand()
Returns the operand for the filter statement. In the example "Name = 'Fred'", the operand is Name. This will be a value from PT_PROPIDS.

Returns:
the operand
See Also:
PT_PROPIDS

SetOperator

void SetOperator(int Value)
Sets the operator for the filter statement. In the example "Name = 'Fred'", the operand is "=". This should be a value from PT_FILTEROPS.

Parameters:
Value - the operator
See Also:
PT_FILTEROPS

GetOperator

int GetOperator()
Returns the operator for the filter statement. In the example "Name = 'Fred'", the operand is "=". This will be a value from PT_FILTEROPS.

Returns:
the operator
See Also:
PT_FILTEROPS

SetValue

void SetValue(int Value)
Sets the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Parameters:
Value - the value to set

SetValue

void SetValue(java.lang.String Value)
Sets the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Parameters:
Value - the value to set

SetValue

void SetValue(com.plumtree.openfoundation.util.XPDateTime Value)
Sets the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Parameters:
Value - the value to set

SetValue

void SetValue(float Value)
Sets the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Parameters:
Value - the value to set

SetValue

void SetValue(double Value)
Sets the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Parameters:
Value - the value to set

SetValue

void SetValue(java.lang.Object Value)
Sets the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Parameters:
Value - the value to set

GetValueAsInt

int GetValueAsInt()
Returns the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Returns:
the current value

GetValueAsString

java.lang.String GetValueAsString()
Returns the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Returns:
the current value

GetValueAsXPDateTime

com.plumtree.openfoundation.util.XPDateTime GetValueAsXPDateTime()
Returns the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Returns:
the current value

GetValueAsFloat

float GetValueAsFloat()
Returns the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Returns:
the current value

GetValueAsDouble

double GetValueAsDouble()
Returns the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Returns:
the current value

GetValueAsObject

java.lang.Object GetValueAsObject()
Returns the value for the filter statement. In the example "Name = 'Fred'", the value is "Fred".

Returns:
the current value


Copyright © 2008 Plumtree Software Inc. All Rights Reserved.