EntityLoadByExample

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

Returns: any

Usage

EntityLoadByExample( sampleEntity [, unique ] )

Arguments

Argument Description
sampleEntity
(object, required)

Name of the sample entity that is used to match and filter similar entities to load.

unique
(boolean, optional)

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.

Examples

There are currently no examples for this function.