public static interface CqUserDb.SearchFilter
Modifier and Type | Method and Description |
---|---|
<U> List<U> |
add(CqUserDb.SearchKey<List<U>> key,
U targetItem)
Extends the target value list associated with a SearchKey by a single
item.
|
void |
clear()
Removes all SearchKey entries from this SearchFilter
|
<U> U |
get(CqUserDb.SearchKey<U> key)
Returns the target value currently associated with a given SearchKey
|
List<Map.Entry<CqUserDb.SearchKey<Object>,Object>> |
getAll() |
List<Map.Entry<CqUserDb.DateLimit,Date>> |
getDateFilters() |
<U> List<Map.Entry<CqUserDb.SearchKey<U>,U>> |
getEntries(Class<U> type)
Retrieves SearchKey/target-value pairs of a given target-value type
|
<V extends CqUserDb.SearchKey<U>,U> |
getEntriesByKey(Class<V> keyType)
Retrieves SearchKey/target-value pairs by SearchKey type
|
List<Map.Entry<CqFieldDefinition,List<String>>> |
getFieldFilters() |
List<Map.Entry<CqRecordType,Boolean>> |
getRecordTypeFilters() |
Map.Entry<CqUserDb.SearchLevel,String> |
getStringFilter() |
List<Map.Entry<CqUserDb.WordMode,List<String>>> |
getWordFilters() |
<U> U |
put(CqUserDb.SearchKey<U> key,
U targetValue)
Adds a SearchKey and its target value to the full text search filter.
|
<U> List<U> add(CqUserDb.SearchKey<List<U>> key, U targetItem)
U
- The type of item in a target value list; currently must be
String.key
- The SearchKey whose target value list is to be extended.
The SeachKey does not need to already be in the
SearchFilter. Currently the SearchKey must be a WordMode
enumerator or a CqFieldDefinition proxy.targetItem
- The new item to be added to the target value listvoid clear()
<U> U get(CqUserDb.SearchKey<U> key)
U
- The data type used to specify the value against which the
key attribute will be compared. This type must match the
type parameter of the key used and so currently this must
be String, List<String>, Date, or Boolean.key
- A SearchKey object representing the attribute of each
candidate record that the search should filter on.
Currently this may be a SearchLevel enumerator, a
DateLimit enumerator, a WordMode enumerator, a
CqRecordType proxy, or a CqFieldDefinition proxy.List<Map.Entry<CqUserDb.SearchKey<Object>,Object>> getAll()
List<Map.Entry<CqUserDb.DateLimit,Date>> getDateFilters()
<U> List<Map.Entry<CqUserDb.SearchKey<U>,U>> getEntries(Class<U> type)
U
- The data type used to specify the value against which the
key attribute will be compared. This type must match the
type parameter of a defined SearchKey and so currently
this must be String, List<String>, Date, or Boolean.type
- The Class object for the desired target-value data type.<V extends CqUserDb.SearchKey<U>,U> List<Map.Entry<V,U>> getEntriesByKey(Class<V> keyType)
U
- The data type used to specify the value against which the
key attribute will be compared. This type must match the
type parameter of a defined SearchKey and so currently
this must be String, List<String>, Date, or Boolean.V
- A subclass of SearchKeykeyType
- The type of keys to retrieve from this search
specificationList<Map.Entry<CqFieldDefinition,List<String>>> getFieldFilters()
List<Map.Entry<CqRecordType,Boolean>> getRecordTypeFilters()
Map.Entry<CqUserDb.SearchLevel,String> getStringFilter()
List<Map.Entry<CqUserDb.WordMode,List<String>>> getWordFilters()
<U> U put(CqUserDb.SearchKey<U> key, U targetValue)
U
- The data type used to specify the target value. This type
must match the type parameter of the key used and so
currently this must be String, List<String>, Date, or
Boolean.key
- A SearchKey<U> object representing the attribute of
each candidate object that the search should filter on.
Currently this may be a SearchLevel enumerator, a
DateLimit enumerator, a WordMode enumerator, a
CqRecordType proxy, or a CqFieldDefinition proxy.targetValue
- An instance of class U that specifies which values
of the key attribute will select or reject a record in the
search. If this value is null (or Boolean.FALSE)
the corresponding SearchKey will be removed from the
search specification.Copyright © IBM 2017. All rights reserved.