Purpose:
This class is used to specify a search criteria in a template query. A template query may have more than one search criteria.
Class summary:
class DKSearchCriteria { public: DKSearchCriteria(); DKSearchCriteria(const char* entityName, const char* attrName); virtual ~DKSearchCriteria(); DKString getName(); void setName(const char* newName); DKString getDisplayName(); void setDisplayName(const char* dispName); short getId(); void setId(short id); DKString getEntityName(); void setEntityName(const char* newName); DKString getAttrName(); void setAttrName(const char* newName); short getDefaultOperator(); void setDefaultOperator(short defOperator); short* getValidOperators(long& arraySize); void setValidOperators(short* validOps, long arraySize); DKString* getDefaultValues(long& arraySize); void setDefaultValues(const DKString* values, long arraySize); dkCollection* getPredefinedValues(); void addPredefinedValues(DKPredefinedValuesFed* pdefValues); short getOperator(); void setOperator(short newOp); DKString getValue(); void setValue(const char* newVal); short getDisplayPosition(); void setDisplayPosition(short order); short getDisplayWidth(); void setDisplayWidth(short width); short getCriteriaPosition(); void setCriteriaPosition(short order); void setDisplayable(boolean displayable); boolean isDisplayable(); void setQueryable(boolean queryable); boolean isQueryable(); short getType(); void setType(short aType); }
Members:
DKSearchCriteria(); DKSearchCriteria(const char* entityName, const char* attrName); virtual ~DKSearchCriteria();
DKSearchCriteria has two constructors: one creates a new instance with default values, the other creates a new instance of search criteria with associated federated entity and attribute names.
DKString getName();
Parameters
newName -- The name of this search criteria.
void setName(const char* newName);
DKString getDisplayName();
Parameters
dispName -- The search criteria display name.
void setDisplayName(const char* dispName);
short getId();
void setId(short id);
void setEntityName(const char* newName);
DKString getEntityName();
DKString getAttrName();
void setAttrName(const char* newName);
short getDefaultOperator();
void setDefaultOperator(short defOperator);
short* getValidOperators(long& arraySize);
void setValidOperators(short* validOps, long arraySize);
DKString* getDefaultValues(long& arraySize);
void setDefaultValues(const DKString* values, long arraySize);
dkCollection* getPredefinedValues();
void addPredefinedValues(DKPredefinedValuesFed* pdefValues);
short getOperator();
void setOperator(short newOp);
DKString* getValues(long& arraySize);
void setValues(const DKString* values, long arraySize);
DKString getValue();
void setValue(const char* value);
short getDisplayPosition();
void setDisplayPosition(short order);
short getDisplayWidth();
void setDisplayWidth(short width);
short getCriteriaPosition();
void setCriteriaPosition(short order);
void setDisplayable(DKBoolean displayable);
DKBoolean isDisplayable();
void setQueryable(DKBoolean queryable);
DKBoolean isQueryable();
short getType();
void setType(short aType);
(c) Copyright International Business Machines Corporation 1996, 2003. IBM Corp. All rights reserved.