These methods allows you to tap into the Criteria Queries API so you can do fluent and functional queries with your ORM objects.

The Base ORM Service has a ton of methods to assist you with your ORM needs. We have compiled them under this section under several different categories:

• Criteria Queries

• Creation - Population

• Counters

• Deleting Entities

• Entity Convenience

• Finders

• Getters

• ORM Session

• Querying

• Saving

• Utility

Like always, you can find the latest in the link below:

Get our hibernate org.hibernate.criterion.Restrictions proxy object that will help you produce criterias.

Returns

• This function returns an instance of cborm.models.criterion.Restrictions

These methods allow you to create entities and populate them from external data like structures, json, xml, queries and much more.

These methods allow you to do counting on entities with or without filtering.

Finders are convenience methods that will help you find a single entity or a collection of entities by using criterias. If you want to use primary keys, then use the getters.

These methods are used for doing a-la-carte querying of entities with extra pizzaz!

Here is a collection of useful getter methods for entities by primary identifiers. Getters mostly deal with retrieving entities by primary keys instead of finders which rely on criteria operations. You can use the get() for a single entity, getOrFail() for throwing exceptions if an entity is not found and getAll() for multiple entities.

These methods allow you to delete one or more entities in cascade style or bulk styles.

Returns the persisted Property Names of the entity in array format

Returns

• This function returns array

Arguments

Examples

Evict entity object(s) from the hibernate session or first-level cache.

• An entity object

• An array of entity objects

Checks if the given entityName and id exists in the database, this method does not load the entity into session. A very useful approach to check for data existence.

Returns

• This function returns boolean

Returns the table name of the passed in entity

Returns

• This function returns string

Evict all queries in the default cache or the cache region that is passed in.

Returns

• This function returns void

Get the unique identifier value for the passed in entity, or null if the instance is not in session

Returns

• This function returns any

Verifies if the passed in entity has dirty values or not since loaded from the database.

Returns

• This function returns true if the entity values have been changed since loaded into the hibernate session, else false

Refresh the state of an entity or array of entities from the database

Returns

• This function returns back the BaseORMService (this)

Deletes entities by using name value pairs as arguments to this function. One mandatory argument is to pass the 'entityName'. The rest of the arguments are used in the where class using AND notation and parameterized. Ex: deleteWhere(entityName="User",age="4",isActive=true);

Returns

• This function returns numeric

Checks if the session contains dirty objects that are awaiting persistence

Returns

• This function returns boolean

Produce a null value that can be used anywhere you like!

Returns

• A null value

These collection of methods will give you information about the currently loaded entity or the entity class itself.

Deletes all the entity records found in the database in a transaction safe matter and returns the number of records removed

Returns

• This function returns numeric

Arguments

Examples

Evict all the collection or association data for a given entity name and collection name from the secondary cache ONLY, not the hibernate session.

Evict an entity name with or without an ID from the secondary cache ONLY, not the hibernate session

Returns

• This function returns void

Arguments

Examples

Get a brand new criteria builder object to do criteria queries with (See ORM:CriteriaBuilder)

Returns

• This function returns coldbox.system.orm.hibernate.CriteriaBuilder

Arguments

Examples

Delete an entity using safe transactions. The entity argument can be a single entity or an array of entities. You can optionally flush the session also after committing.

Returns

• This function returns void

Arguments

Examples

Returns the entity name from a given entity object via session lookup or if new object via metadata lookup

Returns

• This function returns string

Arguments

Examples

Clear the session removes all the entities that are loaded or created in the session. This clears the first level cache and removes the objects that are not yet saved to the database.

Returns

• This function returns the base service reference (this)

Arguments

Examples

Get an array of property names that that have been changed from the original loaded session state.

Returns

• An array of property names

Arguments

Examples

Saves an array of passed entities in specified order and transaction safe

Returns

• This function returns void

Arguments

Examples

Information about the first-level (session) cache for the current session

Returns

• This function returns struct

Arguments

Examples

Get an entity using a primary key, if the id is not found this method returns null. You can also pass an id = 0 and the service will return to you a new entity.

Returns

• This function returns any

Arguments

Examples

Find one entity (or null if not found) according to a criteria structure ex: findWhere(entityName="Category", {category="Training"}), findWhere(entityName="Users",{age=40,retired=false});

Returns

• This function returns any

Arguments

Examples

Returns the count by passing name value pairs as arguments to this function. One mandatory argument is to pass the 'entityName'. The rest of the arguments are used in the where class using AND notation and parameterized. Ex: countWhere(entityName="User",age="20");

Returns

• This function returns numeric

Arguments

Examples

This method will return to you the hibernate's metadata for a specific entity.

Returns

• The Hibernate Java ClassMetadata Object (https://docs.jboss.org/hibernate/orm/3.5/javadocs/org/hibernate/metadata/ClassMetadata.html)

Arguments

Examples

This method allows you to cast the identifier value to the appropriate type in Java. The entity argument can be the entity name or an entity object. Please note that this is ONLY used for identifier casting not for any property!

Returns

• This function returns the value casted to the right Java type

Arguments

Examples

Checks if the current hibernate session contains the passed in entity.

Returns

• This function returns boolean

Arguments

Examples

Find all/single entities by example

Returns

• This function returns array

Arguments

Examples

Save an entity using hibernate transactions or not. You can optionally flush the session also.

Returns

• This function returns void

Arguments

Examples

Finds and returns the first result for the given query or null if no entity was found. You can either use the query and params combination or send in an example entity to find.

Returns

• This function returns any

Delete using an entity name and an incoming id, you can also flush the session if needed. The ID can be a single ID or an array of ID's to batch delete using hibernate DLM style deletes. The function also returns the number of records deleted.

This method gives you the ability to fluently create chains of executions by evaluating the incoming target as a boolean. If true it will execute the success closure, else the failure closure if passed.

Returns

This method allows you to cast any value to the appropriate type in Java for the property passed in. The entity argument can be the entity name or an entity object.

Returns

• This function returns the value casted to the right Java type

Merge an entity or array of entities back into the session

Returns

• Same entity if one passed, array if an array of entities passed.

Get an entity using a primary key, if the id is not found this method throws an EntityNotFound Exception

Returns the key (id field) of a given entity, either simple or composite keys.

• If the key is a simple pk then it will return a string, if it is a composite key then it returns an array.

• If the key cannot be identified then a blank string is returned.

Finds and returns the first result for the given query or throws an exception if not found, this method delegates to the findIt() method

Returns

• This function returns any

• This function could throw an EntityNotFound exception

Arguments

Examples

Return the count of instances in the DB for the given entity name. You can also pass an optional where statement that can filter the count. Ex: count('User','age > 40 AND name="joe"'). You can even use named or positional parameters with this method: Ex: count('User','age > ? AND name = ?',[40,"joe"])

Returns

• This function returns numeric

Arguments

Examples

Populate an entity with a query object. Make sure the names of the columns match the keys in the object.

Returns

• This function returns the populated object

Retrieve all the instances from the passed in entity name using the id argument if specified. The id can be a list of IDs or an array of IDs or none to retrieve all. If the id is not found or returns null the array position will have an empty string in it in the specified order

You can use the readOnly argument to give you the entities as read only entities.

You can use the properties argument so this method can return to you array of structs instead of array of objects. The property list must include the as alias if not you will get positional keys.

Example Positional: properties="catID,category Example Aliases: properties="catID as id, category as category, role as role"

You can use the

Populate an entity with an XML packet. Make sure the names of the elements match the keys in the structure.

Returns

• This function returns the populated object

Find all the entities for the specified query, named or positional arguments or by an example entity

Returns

• This function returns array

Populate an entity with a JSON structure packet. Make sure the names of the properties match the keys in the structure.

Returns

• This function returns the populated object

Get a new entity object by entity name. You can also pass in a structure called properties that will be used to populate the new entity with or you can use optional named parameters to call setters within the new entity to have shorthand population.

Returns

• This function returns the newly created entity

Create a virtual service for a specific entity. Basically a new service layer that inherits from the BaseORMService object but no need to pass in entity names, they are bound to the entity name passed here.

Returns

• This function returns VirtualEntityService

Delete by using an HQL query and iterating via the results. It is not performing a delete query but is a select query that should retrieve objects to remove

Returns

• This function returns void

Find all entities according to criteria structure. Ex: findAllWhere(entityName="Category", {category="Training"}), findAllWhere(entityName="Users", {age=40,retired=true});

Returns

• This function returns array

Populate an entity with a structure of name-value pairs. Make sure the names of the properties match the keys in the structure.

Returns

• This function returns the populated object

Allows the execution of Custom HQL queries with binding, pagination, and many options. Underlying mechanism is ORMExecuteQuery. The params filtering can be using named or positional.

Returns

This function returns multiple formats:

• array of objects

• array of structs

• query

• cbStream

Arguments

Examples

List all of the instances of the passed in entity class name with or without any filtering of properties, no HQL needed.

You can pass in several optional arguments like a struct of filtering criteria, a sortOrder string, offset, max, ignorecase, and timeout. Caching for the list is based on the useQueryCaching class property and the cachename property is based on the queryCacheRegion class property.