com.ibm.edms.od
Class ODCriteria

java.lang.Object
  |
  +--com.ibm.edms.od.ODCriteria

public class ODCriteria
extends java.lang.Object

A class representing a OnDemand folder criteria. The criteria class contains methods to set a search operator and search values.

(C) Copyright IBM Corp. 1993, 2002. All Rights Reserved


Method Summary
 java.lang.String[] getFixedValues()
          Get the valid search values for this criteria.
 java.lang.String getName()
          Get the name of the criteria.
 int getOperand()
          Get the current search operand.
 java.lang.String[] getSearchValues()
          Get the current search values.
 char getType()
          Get the type of criteria.
 int[] getValidOperands()
          Get the valid operands.
 java.util.Vector getValidValues()
          Deprecated.  
 java.util.Vector getValues()
          Get the current search values.
 void setOperand(int op)
          Set the current search operand.
 void setSearchValue(java.lang.String v)
          Set this criteria's search value.
 void setSearchValues(java.lang.String v1, java.lang.String v2)
          Set this criteria's search values.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getName

public java.lang.String getName()
Get the name of the criteria.
Returns:
The criteria name.

getType

public char getType()
Get the type of criteria. All of the criteria types are represented in ODConstant.
Returns:
The criteria type.
See Also:
ODConstant.InputTypeNormal, ODConstant.InputTypeChoice, ODConstant.InputTypeSegment, ODConstant.InputTypeTextSearch, ODConstant.InputTypeNoteTextSearch, ODConstant.InputTypeNoteColor

getValidOperands

public int[] getValidOperands()
Get the valid operands. All of the operand types are represented in ODConstant.
Returns:
An integer array containing the valid operands for this criteria.
See Also:
ODConstant.OPEqual, ODConstant.OPNotEqual, ODConstant.OPLessThan, ODConstant.OPLessThanEqual, ODConstant.OPGreaterThan, ODConstant.OPGreaterThanEqual, ODConstant.OPIn, ODConstant.OPNotIn, ODConstant.OPLike, ODConstant.OPNotLike, ODConstant.OPBetween, ODConstant.OPNotBetween

getOperand

public int getOperand()
Get the current search operand. All of the operand types are represented in ODConstant.
Returns:
The current search operand.
See Also:
ODConstant.OPEqual, ODConstant.OPNotEqual, ODConstant.OPLessThan, ODConstant.OPLessThanEqual, ODConstant.OPGreaterThan, ODConstant.OPGreaterThanEqual, ODConstant.OPIn, ODConstant.OPNotIn, ODConstant.OPLike, ODConstant.OPNotLike, ODConstant.OPBetween, ODConstant.OPNotBetween

setOperand

public void setOperand(int op)
                throws ODException
Set the current search operand. All of the operand types are represented in ODConstant.
Parameters:
op - Operand to use for this criteria when performing a search.
Throws:
ODException -  
See Also:
ODConstant.OPEqual, ODConstant.OPNotEqual, ODConstant.OPLessThan, ODConstant.OPLessThanEqual, ODConstant.OPGreaterThan, ODConstant.OPGreaterThanEqual, ODConstant.OPIn, ODConstant.OPNotIn, ODConstant.OPLike, ODConstant.OPNotLike, ODConstant.OPBetween, ODConstant.OPNotBetween

getValues

public java.util.Vector getValues()
Get the current search values. Immediately after opening a folder this vector contains any default search values specified by the OnDemand administrator.
Returns:
Vector containing current set of search values. The vector will contain multiple values for the between and not between search operators.

getSearchValues

public java.lang.String[] getSearchValues()
Get the current search values. Immediately after opening a folder this vector contains any default search values specified by the OnDemand administrator.
Returns:
String[] containing current set of search values.

setSearchValue

public void setSearchValue(java.lang.String v)
                    throws ODException
Set this criteria's search value. This method should be used if the search operator requires one search value.
Parameters:
v - Search value.
Throws:
ODException -  

setSearchValues

public void setSearchValues(java.lang.String v1,
                            java.lang.String v2)
                     throws ODException
Set this criteria's search values. This method is used when the search operand requires more than one search value, i.e., the between operator.
Parameters:
v1 - Search value number one.
v2 - Search value number two.
Throws:
ODException -  

getValidValues

public java.util.Vector getValidValues()
Deprecated.  

Get the valid search values for this criteria. This method is only valid if this criteria has a fixed set of search values.
Returns:
Possible search values.
See Also:
getFixedValues()

getFixedValues

public java.lang.String[] getFixedValues()
Get the valid search values for this criteria. This method is only valid if this criteria has a fixed set of search values.
Returns:
String[] containing possible search values.