|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface FilterLeaf
A contact filter leaf used in SearchContactTemplate.
A contact filter leaf contains an expression such as: EMailAddress = myE-Mail@Address.com
or primary EMailAddress = myE-Mail@Address.com (the primaryOnly flag is set to true by calling the setPrimaryOnly(boolean) method).
The value of the filter leaf expression is a string composed of:
FilterLeaf.LeafWildcardSearchContactTemplate.normalizeSearchValue(String) method
that returns an escaped string.
The wildcards LeafWildcard#ANY or LeafWildcard#CHAR can be added
to the escaped string. Then this wildcarded expression is set to the
filter leaf instance setValue(String).
Note: If the SearchPrimaryValueOnly flag of the SearchContactTemplate is true,
the search does not take into account the PrimaryOnly flag of this FilterLeaf.
SearchContactTemplate| Nested Class Summary | |
|---|---|
static class |
FilterLeaf.LeafOperator
Constants for the possible operators in filter leaves. |
static class |
FilterLeaf.LeafWildcard
Constants for the possible wildcards in filter leaves. |
| Method Summary | |
|---|---|
ContactAttributeMetaData |
getContactAttribute()
Gets the contact attribute meta data of the filter leaf expression. |
FilterLeaf.LeafOperator |
getOperator()
Gets the operator of the filter leaf expression. |
boolean |
getPrimaryOnly()
Gets the primary status of the filter expression. |
java.lang.String |
getValue()
Gets the value of the filter leaf expression. |
void |
setContactAttribute(ContactAttributeMetaData aCAMD)
Sets a contact attribute meta data as a variable of the filter leaf expression. |
void |
setOperator(FilterLeaf.LeafOperator anOper)
Sets the operator of the filter leaf expression. |
void |
setPrimaryOnly(boolean primaryOnly)
Sets the primary status of the filter expression. |
void |
setValue(java.lang.String aValue)
Sets the value of the filter leaf expression. |
| Methods inherited from interface com.genesyslab.ail.FilterTreeElement |
|---|
getParent, isNode |
| Method Detail |
|---|
void setContactAttribute(ContactAttributeMetaData aCAMD)
aCAMD - as ContactAttributeMetaData.void setOperator(FilterLeaf.LeafOperator anOper)
anOper - as FilterLeaf.LeafOperator.void setValue(java.lang.String aValue)
FilterLeaf.LeafWildcard.
aValue - as String.void setPrimaryOnly(boolean primaryOnly)
ContactAttributeMetaData.
primaryOnly - as boolean.ContactAttributeMetaData getContactAttribute()
ContactAttributeMetaData.FilterLeaf.LeafOperator getOperator()
FilterLeaf.LeafOperator.java.lang.String getValue()
String.boolean getPrimaryOnly()
boolean.
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||