Lucee Function Reference

Function ENTITYLOADBYEXAMPLE

Loads and returns an array of objects that match the sample entity.
entityLoadByExample(sampleEntity,[unique])

Example

entityloadbyexample(object sampleEntity,[boolean unique]):any

Arguments

The arguments for this function are set. You can not use other arguments except the following ones.
Name Type Required Description
sampleEntity object  Yes Name of the sample entity that is used to match and filter similar entities to load.  
unique boolean  No If unique is set to true, then the entity is returned.
If you are sure that only one record exists that matches this filtercriteria, then you can specify unique=true, so that a single entity is returned instead of an array.
If you set unique=true and multiple records are returned, then an exception occurs.