|
Content Manager OnDemand V7 WEK APIs |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.edms.od.ODCriteria
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, 2003. All Rights Reserved
Constructor Summary | |
protected |
ODCriteria(java.lang.String name)
|
Method Summary | |
boolean |
getAscending()
Get the search type of the current criteria. |
java.lang.String[] |
getDBFields(java.lang.String agName)
Get the database field name(s) for this folder criteria. |
java.lang.String |
getDefaultFmt()
Get the default format for this criteria. |
char |
getDefaultFmtQual()
Get the default format qualifier for this criteria. |
java.lang.String |
getDisplayFmt()
Get the display format for this criteria. |
char |
getDisplayFmtQual()
Get the display format qualifier for this criteria. |
char |
getFieldQualifier()
Get the criteria qualifier. |
java.lang.String[] |
getFixedValues()
Get the valid search values for this criteria. |
int |
getMaxDisplayChars()
Get the maximum display characters. |
int |
getMaxEntryChars()
Get the maximum entry characters. |
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. |
int |
getSortOrder()
Get the search sort value for the current criteria. |
char |
getSubType()
Get the subtype of the criteria. |
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. |
boolean |
isDefaultValueAvailable()
Determine whether a default value is available for this criteria. |
boolean |
isDefaultValueFixed()
Determine whether the default value for this criteria is fixed (cannot be changed). |
boolean |
isRequired()
Determine whether a value is required for this criteria when searching the folder. |
void |
setAscending(boolean value)
Set the search type for the current criteria. |
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. |
void |
setSortOrder(int value)
Set the search sort value for the current criteria. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
protected ODCriteria(java.lang.String name) throws java.lang.Exception
Method Detail |
public void setSortOrder(int value)
public int getSortOrder()
public void setAscending(boolean value)
public boolean getAscending()
public java.lang.String getName()
public char getType()
ODConstant
.
ODConstant.InputTypeNormal
,
ODConstant.InputTypeChoice
,
ODConstant.InputTypeSegment
,
ODConstant.InputTypeTextSearch
,
ODConstant.InputTypeNoteTextSearch
,
ODConstant.InputTypeNoteColor
public char getSubType()
ODConstant
.
ODConstant.OD_FLD_ANN_TEXT_SEARCH
,
ODConstant.OD_FLD_BIGINT
,
ODConstant.OD_FLD_ANN_COLOR_SEARCH
,
ODConstant.OD_FLD_DECIMAL
,
ODConstant.OD_FLD_APPLGRP
,
ODConstant.OD_FLD_INTEGER
,
ODConstant.OD_FLD_SMALLINT
,
ODConstant.OD_FLD_SEGMENT
,
ODConstant.OD_FLD_STRING
,
ODConstant.OD_FLD_TEXT_SEARCH
,
ODConstant.OD_FLD_VOID
public char getFieldQualifier()
ODConstant
.
ODConstant.OD_FLDQ_BASE
,
ODConstant.OD_FLDQ_DATETIME
,
ODConstant.OD_FLDQ_DATE
,
ODConstant.OD_FLDQ_TIME
,
ODConstant.OD_FLDQ_TZ_DATETIME
public int[] getValidOperands()
ODConstant
.
ODConstant.OPEqual
,
ODConstant.OPNotEqual
,
ODConstant.OPLessThan
,
ODConstant.OPLessThanEqual
,
ODConstant.OPGreaterThan
,
ODConstant.OPGreaterThanEqual
,
ODConstant.OPIn
,
ODConstant.OPNotIn
,
ODConstant.OPLike
,
ODConstant.OPNotLike
,
ODConstant.OPBetween
,
ODConstant.OPNotBetween
public int getOperand()
ODConstant
.
ODConstant.OPEqual
,
ODConstant.OPNotEqual
,
ODConstant.OPLessThan
,
ODConstant.OPLessThanEqual
,
ODConstant.OPGreaterThan
,
ODConstant.OPGreaterThanEqual
,
ODConstant.OPIn
,
ODConstant.OPNotIn
,
ODConstant.OPLike
,
ODConstant.OPNotLike
,
ODConstant.OPBetween
,
ODConstant.OPNotBetween
public void setOperand(int op) throws ODException
ODConstant
.
op
- Operand to use for this criteria when performing a search.
ODException
ODConstant.OPEqual
,
ODConstant.OPNotEqual
,
ODConstant.OPLessThan
,
ODConstant.OPLessThanEqual
,
ODConstant.OPGreaterThan
,
ODConstant.OPGreaterThanEqual
,
ODConstant.OPIn
,
ODConstant.OPNotIn
,
ODConstant.OPLike
,
ODConstant.OPNotLike
,
ODConstant.OPBetween
,
ODConstant.OPNotBetween
public java.util.Vector getValues()
public java.lang.String[] getSearchValues()
public void setSearchValue(java.lang.String v) throws ODException
v
- Search value.
ODException
public void setSearchValues(java.lang.String v1, java.lang.String v2) throws ODException
v1
- Search value number one.v2
- Search value number two.
ODException
public java.util.Vector getValidValues()
getFixedValues()
public java.lang.String[] getFixedValues()
public java.lang.String getDisplayFmt()
public char getDisplayFmtQual()
public java.lang.String getDefaultFmt()
public char getDefaultFmtQual()
public boolean isRequired()
public boolean isDefaultValueAvailable()
public boolean isDefaultValueFixed()
public int getMaxEntryChars()
public int getMaxDisplayChars()
public java.lang.String[] getDBFields(java.lang.String agName)
agName
- The application group for which the db fields are required.
|
CM OnDemand V7 WEK Java APIs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |