DataDefinition (Qcadoo Framework :: Javadoc 1.5-SNAPSHOT API)

```
public interface DataDefinition
```
Object defines database structure. The getPluginIdentifier() and getName() are used to calculate table name.

Since:

0.4.0

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<Entity>`	`activate(Long... ids)` Activate given entities.
`boolean`	`callValidators(Entity targetEntity)` Validate specified entity.
`List<Entity>`	`copy(Long... id)` Return the copied entity related with this data definition.
`long`	`count()` Counts all model entities.
`long`	`count(SearchCriterion criterion)` Counts entities found by given criteria.
`Entity`	`create()` Create entity.
`Entity`	`create(Long id)` Create entity with given id.
`List<Entity>`	`deactivate(Long... ids)` Deactivate given entities.
`EntityOpResult`	`delete(Long... id)` Delete the entity related with this data definition, by its id.
`Entity`	`fastSave(Entity entity)` Save the entity related with this data definition without invoke hooks.
`SearchCriteriaBuilder`	`find()` Create search criteria builder for this data definition.
`SearchQueryBuilder`	`find(String queryString)` Create search query builder for given HQL query string.
`SearchCriteriaBuilder`	`findWithAlias(String alias)` Create search criteria builder for this data definition.
`Entity`	`get(Long id)` Return the entity related with this data definition, by its id.
`FieldDefinition`	`getField(String fieldName)` Return field definition by its name.
`Map<String,FieldDefinition>`	`getFields()` Return all defined fields' definitions.
`Entity`	`getMasterModelEntity(Long id)` Return the entity related with master model data definition, by its id.
`String`	`getName()` Return name of this data definition.
`String`	`getPluginIdentifier()` Return plugin's identifier for this data definition.
`FieldDefinition`	`getPriorityField()` Return priority field's definition.
`boolean`	`isActivable()` Return true if entity is activable.
`boolean`	`isAuditable()` Return true if entity is auditable.
`boolean`	`isPrioritizable()` Return true if entity is prioritizable.
`boolean`	`isVersionable()` Return true if entity is versionable
`void`	`move(Long id, int offset)` Move the prioritizable entity by offset.
`void`	`moveTo(Long id, int position)` Move the prioritizable entity to the target position.
`Entity`	`save(Entity entity)` Save the entity related with this data definition.
`Entity`	`tryGetMasterModelEntity(Long id)` Return the entity related with master model data definition, by its id.
`Entity`	`validate(Entity entity)` Validate the entity related with this data definition.

- Method Detail
  - activate
```
List<Entity> activate(Long... ids)
```
    Activate given entities.
    
    Parameters:
    
    ids - ids
    
    Returns:
    
    activated entities
    
    Since:
    
    0.4.2
  - callValidators
```
boolean callValidators(Entity targetEntity)
```
    Validate specified entity.
    
    Parameters:
    
    targetEntity - entity which be validated.
    
    Returns:
    
    true if given entity is valid.
  - copy
```
List<Entity> copy(Long... id)
```
    Return the copied entity related with this data definition.
    
    Parameters:
    
    id - id
    
    Returns:
    
    entity
  - count
```
long count()
```
    Counts all model entities.
    
    Returns:
    
    entities count
    
    Since:
    
    1.4
  - count
```
long count(SearchCriterion criterion)
```
    Counts entities found by given criteria.
    
    Parameters:
    
    criterion - criterion to restrict entities
    
    Returns:
    
    entities count
    
    Since:
    
    1.4
  - create
```
Entity create()
```
    Create entity.
    
    Returns:
    
    entity
  - create
```
Entity create(Long id)
```
    Create entity with given id.
    
    Parameters:
    
    id - id
    
    Returns:
    
    entity
  - deactivate
```
List<Entity> deactivate(Long... ids)
```
    Deactivate given entities.
    
    Parameters:
    
    ids - ids
    
    Returns:
    
    deactivated entities
    
    Since:
    
    0.4.2
  - delete
```
EntityOpResult delete(Long... id)
```
    Delete the entity related with this data definition, by its id.
    
    Parameters:
    
    id - id
    
    Returns:
    
    EntityOpResult, an object containing operation's results
  - fastSave
```
Entity fastSave(Entity entity)
```
    Save the entity related with this data definition without invoke hooks.
    
    Parameters:
    
    entity - entity to save
    
    Returns:
    
    saved entity
  - find
```
SearchCriteriaBuilder find()
```
    Create search criteria builder for this data definition.
    
    Returns:
    
    new search criteria builder
    
    See Also:
    
    findWithAlias(String)
  - find
```
SearchQueryBuilder find(String queryString)
```
    Create search query builder for given HQL query string.
    
    Parameters:
    
    queryString - query string
    
    Returns:
    
    new search query builder
    
    Since:
    
    0.4.1
    
    See Also:
    
    SearchQueryBuilder
  - findWithAlias
```
SearchCriteriaBuilder findWithAlias(String alias)
```
    Create search criteria builder for this data definition. Root data definition will use given alias. This is usable for subqueries.
    
    Parameters:
    
    alias - alias
    
    Returns:
    
    new search criteria builder
  - get
```
Entity get(Long id)
```
    Return the entity related with this data definition, by its id.
    
    Parameters:
    
    id - id
    
    Returns:
    
    entity
  - getField
```
FieldDefinition getField(String fieldName)
```
    Return field definition by its name.
    
    Parameters:
    
    fieldName - field's name
    
    Returns:
    
    field's definition
  - getFields
```
Map<String,FieldDefinition> getFields()
```
    Return all defined fields' definitions.
    
    Returns:
    
    fields' definitions
  - getMasterModelEntity
```
Entity getMasterModelEntity(Long id)
```
    Return the entity related with master model data definition, by its id.
    
    Parameters:
    
    id - id
    
    Returns:
    
    entity
  - getName
```
String getName()
```
    Return name of this data definition.
    
    Returns:
    
    name
  - getPluginIdentifier
```
String getPluginIdentifier()
```
    Return plugin's identifier for this data definition.
    
    Returns:
    
    plugin's identifier
  - getPriorityField
```
FieldDefinition getPriorityField()
```
    Return priority field's definition.
    
    Returns:
    
    priority field's definion, null if entity is not prioritizable
  - isActivable
```
boolean isActivable()
```
    Return true if entity is activable.
    
    Returns:
    
    true if entity is activable
    
    Since:
    
    0.4.2
  - isAuditable
```
boolean isAuditable()
```
    Return true if entity is auditable.
    
    Returns:
    
    true if entity is auditable
  - isPrioritizable
```
boolean isPrioritizable()
```
    Return true if entity is prioritizable.
    
    Returns:
    
    true if entity is prioritizable
  - isVersionable
```
boolean isVersionable()
```
    Return true if entity is versionable
    
    Returns:
    
    true if entity is versionable
  - move
```
void move(Long id,
          int offset)
```
    Move the prioritizable entity by offset.
    
    Parameters:
    
    id - id
    
    offset - offset
  - moveTo
```
void moveTo(Long id,
            int position)
```
    Move the prioritizable entity to the target position.
    
    Parameters:
    
    id - id
    
    position - position
  - save
```
Entity save(Entity entity)
```
    Save the entity related with this data definition.
    
    Parameters:
    
    entity - entity to save
    
    Returns:
    
    saved entity
  - tryGetMasterModelEntity
```
Entity tryGetMasterModelEntity(Long id)
```
    Return the entity related with master model data definition, by its id.
    
    Parameters:
    
    id - id
    
    Returns:
    
    entity
  - validate
```
Entity validate(Entity entity)
```
    Validate the entity related with this data definition.
    
    Parameters:
    
    entity - entity to validate
    
    Returns:
    
    validate entity

Interface DataDefinition

Method Summary

Method Detail

activate

callValidators

copy

count

count

create

create

deactivate

delete

fastSave

find

find

findWithAlias

get

getField

getFields

getMasterModelEntity

getName

getPluginIdentifier

getPriorityField

isActivable

isAuditable

isPrioritizable

isVersionable

move

moveTo

save

tryGetMasterModelEntity

validate