@ExperimentalApi
public interface EntityPropertyQuery<T extends EntityPropertyQuery<T>>
JsonEntityPropertyManager
.
Notes:
count
queries.Modifier and Type | Interface and Description |
---|---|
static interface |
EntityPropertyQuery.ExecutableQuery
An
EntityPropertyQuery for which sufficient contraints have been provided to make
the query valid. |
Modifier and Type | Method and Description |
---|---|
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.
|
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 blankEntityPropertyQuery.ExecutableQuery
, since specifying the entityName
is sufficient to form a valid queryIllegalArgumentException
- 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 keyEntityPropertyQuery.ExecutableQuery
, since specifying the key
is sufficient to form a valid queryIllegalArgumentException
- if key
is null
or blankIllegalStateException
- 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 IDIllegalArgumentException
- 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 prefixIllegalArgumentException
- if keyPrefix
is null
or blankIllegalStateException
- 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.Copyright © 2002-2019 Atlassian. All Rights Reserved.