|
Project: stp | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
T
- The type of object used to specify the value or values that
will select or reject an object based on the value it has for
the key attribute.public static interface CqUserDb.SearchKey<T>
The interface for an API object that may be used to define a filter for a full-text search of the database. The search key specifies an attribute of the database object whose value will be used to select the object for inclusion in the result set of the full-text search. In the SearchFilter, each SearchKey is associated with a target value that specifies what attribute values will cause the object to be selected.
The currently defined SearchKey types are
CqUserDb.SearchLevel
: (SearchKey<String>) selects an object
having any field matching the specification in the target String. The
SearchMode enumerator specifies the type of specification to be found in
the target string. Currently there is only one SearchMode, SIMPLE, which
represents a full-text search using a simple specification.
CqUserDb.WordMode
: (SearchKey<List<String>>) selects an object
having any field matching the words in the target list. The WordMode
enumerator specifies how the target words must match a field to select
the object.
CqUserDb.DateLimit
: (SearchKey<Date>) selects an object based on
the relationship between the object's creation or modification date and
the target date. The DateLimit enumerator specifies which date attribute
to compare against and the relationship with the target date that will
select the object.
CqRecordType
: (SearchKey<Boolean>) selects a record
based on its record type. If the target value is Boolean.TRUE, a record
whose record type is the same as the record type denoted by the
CqRecordType object will be selected. If several CqRecordType keys (with
TRUE target values) are present in a SearchFilter, a record having anyone
of those record types is selected.
CqFieldDefinition
: (SearchKey<List<String>>) selects
a record having a specific field whose value matches all of the target
strings. The CqFieldDefinition specifies the record type and the field of
that record type that must match the target strings. Each target string
is a simple search specification.
|
Generated Fri 5-Nov-2010 03:50 AM | |||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |