FindData (g9 Common 2.8.1 API)

java.lang.Object
- no.g9.support.FindData

All Implemented Interfaces:

Serializable
```
public class FindData
extends Object
implements Serializable
```
Instances of the class holds data for controlling Find/FindAll actions

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

FindData()

Constructors
Constructor and Description
`FindData()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCriterion(Object criterion)` Add a new criterion to the criterions list.
`void`	`addCriterionAlias(String associationPath, String alias)` Add a new criterion alias for the given association path.
`void`	`addCriterionAlias(String associationPath, String alias, Object joinType)` Add a new criterion alias and join type for the given association path.
`void`	`addCriterionAlias(String associationPath, String alias, Object joinType, Object withClause)` Add a new criterion alias and join type for the given association path.
`void`	`addOrder(FindOrder findOrder)` Add a new FindOrder object to the list used to generate "order by" from the database.
`void`	`addQueryParameter(Object parameter)` Add a new query parameter.
`Object`	`getCriteriaProjection()`
`Object`	`getCriterion()`
`Map<String,String>`	`getCriterionAliases()`
`Map<String,Object>`	`getCriterionJoinTypes()`
`List<Object>`	`getCriterions()` Return the criterions list.
`Map<String,Object>`	`getCriterionWithClauses()`
`Object`	`getCustomData()`
`boolean`	`getDeepFindAll()`
`static int`	`getDefaultMaxResults()`
`Class<?>`	`getDomainClass()`
`Object`	`getExample()`
`EFindMethod`	`getFindMethod()`
`int`	`getFirstResult()`
`Serializable`	`getKey()`
`int`	`getMaxResults()`
`List<FindOrder>`	`getOrder()`
`String`	`getQuery()`
`List<Object>`	`getQueryParameters()`
`boolean`	`getUseJpaPositionalParameters()` If false, "old" style HQL positional parameters are used.
`void`	`setCriteriaProjection(Object criteriaProjection)`
`void`	`setCriterion(Object criterion)` Clears the list and sets the first criterion data for the CRITERIA findMethod.
`void`	`setCriterions(List<Object> criterions)`
`void`	`setCustomData(Object customData)` Set the customData object.
`void`	`setDeepFindAll(boolean deepFindAll)` Set the deepFindAll flag.
`static void`	`setDefaultMaxResults(int defaultMaxResults)`
`void`	`setDomainClass(Class<?> domainClass)` Set the domain class for CRITERIA and DEFAULT findMethods.
`void`	`setExample(Object example)` Set the example object for the EXAMPLE findMethod.
`void`	`setFindMethod(EFindMethod findMethod)` Controls the method used by the persistence layer for finding instances in the database.
`void`	`setFirstResult(int firstResult)` First row to be returned by the FindAll action.
`void`	`setKey(Serializable key)` Set the key (database primary key) for the DEFAULT findMethod.
`void`	`setMaxResults(int maxResults)` Maximum number of rows returned by the FindAll action.
`void`	`setOrder(List<FindOrder> order)`
`void`	`setQuery(String query)` Set the query string for the QUERY findMethod.
`void`	`setQueryParameters(List<Object> queryParameters)`
`void`	`setUseJpaPositionalParameters(boolean useJpaPositionalParameters)` If false, "old" style HQL positional parameters are used.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FindData
```
public FindData()
```
- Method Detail
  - addQueryParameter
```
public void addQueryParameter(Object parameter)
```
    Add a new query parameter. The query parameters are used as "positional" parameters, i.e. the ordering must match the query string.
    
    Parameters:
    
    parameter - (missing javadoc)
  - addCriterionAlias
```
public void addCriterionAlias(String associationPath,
                              String alias)
```
    Add a new criterion alias for the given association path.
    
    Parameters:
    
    associationPath - the association path to add an alias for
    
    alias - the alias to use
  - addCriterionAlias
```
public void addCriterionAlias(String associationPath,
                              String alias,
                              Object joinType)
```
    Add a new criterion alias and join type for the given association path.
    
    Parameters:
    
    associationPath - the association path to add an alias for
    
    alias - the alias to use
    
    joinType - the join type to use
  - addCriterionAlias
```
public void addCriterionAlias(String associationPath,
                              String alias,
                              Object joinType,
                              Object withClause)
```
    Add a new criterion alias and join type for the given association path.
    
    Parameters:
    
    associationPath - the association path to add an alias for
    
    alias - the alias to use
    
    joinType - the join type to use
    
    withClause - the withClause to use
  - addOrder
```
public void addOrder(FindOrder findOrder)
```
    Add a new FindOrder object to the list used to generate "order by" from the database.
    
    Parameters:
    
    findOrder - (missing javadoc)
  - getQuery
```
public String getQuery()
```
    Returns:
    
    the current query.
  - setQuery
```
public void setQuery(String query)
```
    Set the query string for the QUERY findMethod. The syntax of the query string is persistence layer specific.
    
    Parameters:
    
    query - The query to set.
  - getCriterion
```
public Object getCriterion()
```
    Returns:
    
    the first criterion.
  - setCriterion
```
public void setCriterion(Object criterion)
```
    Clears the list and sets the first criterion data for the CRITERIA findMethod. This is a persistence layer specific tree of criterions.
    
    Parameters:
    
    criterion - The criterion to set.
  - getCriterions
```
public List<Object> getCriterions()
```
    Return the criterions list. A new list is created if it is null.
    
    Returns:
    
    the criterions list.
  - setCriterions
```
public void setCriterions(List<Object> criterions)
```
    Parameters:
    
    criterions - the criterions to set
  - addCriterion
```
public void addCriterion(Object criterion)
```
    Add a new criterion to the criterions list.
    
    Parameters:
    
    criterion - the criterion to add.
  - getFindMethod
```
public EFindMethod getFindMethod()
```
    Returns:
    
    the findMethod.
  - setFindMethod
```
public void setFindMethod(EFindMethod findMethod)
```
    Controls the method used by the persistence layer for finding instances in the database. Legal values are: DEFAULT - use key properties from the data object. QUERY - use a query string with optionally queryParameters EXAMPLE - use properties from the data object for "query by example" CRITERIA - use a tree of query criterions CUSTOM - the application programmer is responsible for the find Default value is DEFAULT.
    
    Parameters:
    
    findMethod - The findMethod to set.
  - getFirstResult
```
public int getFirstResult()
```
    Returns:
    
    the firstResult.
  - setFirstResult
```
public void setFirstResult(int firstResult)
```
    First row to be returned by the FindAll action. Use a value of zero (default) to start with the first row.
    
    Parameters:
    
    firstResult - The firstResult to set. Must be >= 0.
  - getMaxResults
```
public int getMaxResults()
```
    Returns:
    
    the maxResults.
  - setMaxResults
```
public void setMaxResults(int maxResults)
```
    Maximum number of rows returned by the FindAll action. Use a value of zero (default) to avoid limiting the number of rows.
    
    Parameters:
    
    maxResults - The maxResults to set. Must be >= 0.
  - getQueryParameters
```
public List<Object> getQueryParameters()
```
    Returns:
    
    the queryParameters.
  - setQueryParameters
```
public void setQueryParameters(List<Object> queryParameters)
```
    Parameters:
    
    queryParameters - The queryParameters to set.
  - getCustomData
```
public Object getCustomData()
```
    Returns:
    
    the customData
  - setCustomData
```
public void setCustomData(Object customData)
```
    Set the customData object. This can be used for data transfer for the CUSTOM find method.
    
    Parameters:
    
    customData - the customData to set
  - getOrder
```
public List<FindOrder> getOrder()
```
    Returns:
    
    the order.
  - setOrder
```
public void setOrder(List<FindOrder> order)
```
    Parameters:
    
    order - The order to set.
  - getDefaultMaxResults
```
public static int getDefaultMaxResults()
```
    Returns:
    
    the defaultMaxResults.
  - setDefaultMaxResults
```
public static void setDefaultMaxResults(int defaultMaxResults)
```
    Parameters:
    
    defaultMaxResults - The defaultMaxResults to set.
  - getDomainClass
```
public Class<?> getDomainClass()
```
    Returns:
    
    the domainClass.
  - setDomainClass
```
public void setDomainClass(Class<?> domainClass)
```
    Set the domain class for CRITERIA and DEFAULT findMethods. This is the domain class used in Find/FindAll
    
    Parameters:
    
    domainClass - The domainClass to set.
  - getExample
```
public Object getExample()
```
    Returns:
    
    the example.
  - setExample
```
public void setExample(Object example)
```
    Set the example object for the EXAMPLE findMethod. The example object is used for "query by example".
    
    Parameters:
    
    example - The example to set.
  - getKey
```
public Serializable getKey()
```
    Returns:
    
    the key.
  - setKey
```
public void setKey(Serializable key)
```
    Set the key (database primary key) for the DEFAULT findMethod.
    
    Parameters:
    
    key - The key to set.
  - getCriterionAliases
```
public Map<String,String> getCriterionAliases()
```
    Returns:
    
    the criterion aliases map.
  - getCriterionJoinTypes
```
public Map<String,Object> getCriterionJoinTypes()
```
    Returns:
    
    the criterion join types map.
  - getCriterionWithClauses
```
public Map<String,Object> getCriterionWithClauses()
```
    Returns:
    
    the criterion with clauses map.
  - getDeepFindAll
```
public boolean getDeepFindAll()
```
    Returns:
    
    the deepFindAll flag.
  - setDeepFindAll
```
public void setDeepFindAll(boolean deepFindAll)
```
    Set the deepFindAll flag.
    
    Parameters:
    
    deepFindAll - (missing javadoc)
  - getCriteriaProjection
```
public Object getCriteriaProjection()
```
    Returns:
    
    the criteriaProjection
  - setCriteriaProjection
```
public void setCriteriaProjection(Object criteriaProjection)
```
    Parameters:
    
    criteriaProjection - the criteriaProjection to set
  - getUseJpaPositionalParameters
```
public boolean getUseJpaPositionalParameters()
```
    If false, "old" style HQL positional parameters are used. HQL positional parameters are marked with "?" in the query. HQL positional parameters are deprecated from Hibernate 4. JPA positional parameters are marked with "?n" in the query, where n is a number starting from 1.
    
    Returns:
    
    true if JPS style positional parameters should be used in HQL queries
  - setUseJpaPositionalParameters
```
public void setUseJpaPositionalParameters(boolean useJpaPositionalParameters)
```
    If false, "old" style HQL positional parameters are used. HQL positional parameters are marked with "?" in the query. HQL positional parameters are deprecated from Hibernate 4. JPA positional parameters are marked with "?n" in the query, where n is a number starting from 1. The default is to use JPA style positional parameters.
    
    Parameters:
    
    useJpaPositionalParameters - true if JPA style positional parameters should be used in HQL queries

Class FindData

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FindData

Method Detail

addQueryParameter

addCriterionAlias

addCriterionAlias

addCriterionAlias

addOrder

getQuery

setQuery

getCriterion

setCriterion

getCriterions

setCriterions

addCriterion

getFindMethod

setFindMethod

getFirstResult

setFirstResult

getMaxResults

setMaxResults

getQueryParameters

setQueryParameters

getCustomData

setCustomData

getOrder

setOrder

getDefaultMaxResults

setDefaultMaxResults

getDomainClass

setDomainClass

getExample

setExample

getKey

setKey

getCriterionAliases

getCriterionJoinTypes

getCriterionWithClauses

getDeepFindAll

setDeepFindAll

getCriteriaProjection

setCriteriaProjection

getUseJpaPositionalParameters

setUseJpaPositionalParameters