EntityLoadByExample()

Loads and returns an array of objects that match the sample entity.

entityLoadByExample(sampleEntity,[unique])


	EntityLoadByExample( sampleEntity=object, unique=boolean );

Returns: any

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.

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

EntityLoadByExample(obj,true);

EntityLoadByExample()

Examples

See also