public interface EntitySelectCondition extends EntityCondition
Modifier and Type | Method and Description |
---|---|
int |
getFetchCount() |
java.lang.Integer |
getForeignKeyFetchDepthLimit(java.lang.String foreignKeyPropertyId)
Returns the number of levels of foreign key values to fetch, with 0 meaning no referenced entities
should be fetched, -1 no limit and null unspecified (use default).
|
int |
getLimit() |
int |
getOffset() |
Entity.OrderBy |
getOrderBy() |
java.util.List<java.lang.String> |
getSelectPropertyIds() |
boolean |
isForUpdate() |
EntitySelectCondition |
setFetchCount(int fetchCount) |
EntitySelectCondition |
setForeignKeyFetchDepthLimit(int fetchDepthLimit)
Limit the levels of foreign keys to fetch
|
EntitySelectCondition |
setForeignKeyFetchDepthLimit(java.lang.String foreignKeyPropertyId,
int fetchDepthLimit)
Limit the levels of foreign keys to fetch via the given foreign key property
|
EntitySelectCondition |
setForUpdate(boolean forUpdate)
Marks this condition as a select for update query, this means the resulting records
will be locked by the given connection until unlocked by running another (non - select for update)
query on the same connection or performing an update
|
EntitySelectCondition |
setLimit(int limit) |
EntitySelectCondition |
setOffset(int offset) |
EntitySelectCondition |
setOrderBy(Entity.OrderBy orderBy)
Sets the OrderBy for this condition
|
EntitySelectCondition |
setSelectPropertyIds(java.lang.String... propertyIds)
Sets the properties to include in the resulting Entities,
including the column properties involved in a foreign key
causes the foreign key values to be populated.
|
getCondition, getEntityId, getWhereClause
Entity.OrderBy getOrderBy()
EntitySelectCondition setOrderBy(Entity.OrderBy orderBy)
orderBy
- the OrderBy to use when applying this conditionint getLimit()
EntitySelectCondition setLimit(int limit)
limit
- the limit to use for this conditionint getOffset()
EntitySelectCondition setOffset(int offset)
offset
- the offset to use for this conditionboolean isForUpdate()
EntitySelectCondition setForUpdate(boolean forUpdate)
forUpdate
- if true then the results should be locked for updateint getFetchCount()
EntitySelectCondition setFetchCount(int fetchCount)
fetchCount
- the maximum number of records to fetch from the resultjava.lang.Integer getForeignKeyFetchDepthLimit(java.lang.String foreignKeyPropertyId)
foreignKeyPropertyId
- the foreign key property IDEntitySelectCondition setForeignKeyFetchDepthLimit(java.lang.String foreignKeyPropertyId, int fetchDepthLimit)
foreignKeyPropertyId
- the property idfetchDepthLimit
- the foreign key fetch depth limitEntitySelectCondition setForeignKeyFetchDepthLimit(int fetchDepthLimit)
fetchDepthLimit
- the foreign key fetch depth limitEntitySelectCondition setSelectPropertyIds(java.lang.String... propertyIds)
propertyIds
- the ids of the column properties to includejava.util.List<java.lang.String> getSelectPropertyIds()