|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@ExperimentalApi public interface EntityPropertyQuery<T extends EntityPropertyQuery<T>>
A query builder for requests to the JsonEntityPropertyManager
.
count
queries.
Nested Class Summary | |
---|---|
static interface |
EntityPropertyQuery.ExecutableQuery
An EntityPropertyQuery for which sufficient contraints have been provided to make
the query valid. |
Method Summary | |
---|---|
T |
entityId(Long entityId)
Restricts the search by the entity ID. |
EntityPropertyQuery.ExecutableQuery |
entityName(String entityName)
Restricts the search by the entity name, which can neither be null nor blank. |
EntityPropertyQuery.ExecutableQuery |
key(String key)
Restricts the search to the given property key, which can neither be null nor blank. |
T |
keyPrefix(String keyPrefix)
Restricts the search to the given property key prefix, which can neither be null nor blank. |
T |
maxResults(int maxResults)
The maximum number of results to return. |
T |
offset(int offset)
The offset into the result list at which to begin. |
Method Detail |
---|
EntityPropertyQuery.ExecutableQuery entityName(@Nonnull String entityName)
null
nor blank.
If this is not specified, then the key
is required.
entityName
- the entity name; must not be null
or blank
EntityPropertyQuery.ExecutableQuery
, since specifying the entityName
is sufficient to form a valid query
IllegalArgumentException
- if entityName
is null
or blankEntityPropertyQuery.ExecutableQuery key(@Nonnull String key)
null
nor blank.
If this is not specified, then the entity name
is required.
This restriction is not compatible with a key prefix
restriction.
key
- the property key
EntityPropertyQuery.ExecutableQuery
, since specifying the key
is sufficient to form a valid query
IllegalArgumentException
- if key
is null
or blank
IllegalStateException
- if keyPrefix(String)
has already been specifiedT entityId(@Nonnull Long entityId)
key
has been provided), but doing
so probably does not make any sense.
entityId
- the entity ID
IllegalArgumentException
- if entityId
is null
T keyPrefix(@Nonnull String keyPrefix)
null
nor blank.
The entity name
is required to use this restriction, which is
not compatible with a key
restriction.
keyPrefix
- the property key prefix
IllegalArgumentException
- if keyPrefix
is null
or blank
IllegalStateException
- if key(String)
has already been specifiedT offset(int offset)
max results
to use this feature.
offset
- the (0-based) index offset into the complete results. Nonsensical values
like -42
are silently ignored.
T maxResults(int maxResults)
offset
.
maxResults
- the maximum results to return. Nonsensical values like -42
are
silently ignored.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |