Class: ReadOnlyChildCollectionSync

 * ReadOnlyRootModelSync
 * ReadOnlyChildModelSync
 * CommandObjectSync

Extends

• CollectionBase

Members

<readonly> $modelName :string

The name of the model.

Type:

• string

<readonly> count :number

The count of the child objects in the collection.

Type:

• number

Methods

at(index) → {ReadOnlyChildModelSync}

Gets a collection item at a specific position.

Parameters:

Name	Type	Description
index	number	The index of the required item in the collection.

Returns:

The required collection item.

Type

ReadOnlyChildModelSync

<protected> checkRules()

Executes validation on all items of the collection.

This method is called by the parent object.

every(callback) → {boolean}

Tests whether all items in the collection pass the test implemented by the provided function.

Parameters:

Name	Type	Description
callback	external.cbCollectionItem	Function to test for each collection item.

Returns:

True when callback returns truthy value for each item, otherwise false.

Type

boolean

<protected> fetch(data)

Initializes the items in the collection with data retrieved from the repository.

This method is called by the parent object.

Parameters:

Name	Type	Argument	Description
data	Array.<object>	<optional>	The data to load into the business object collection.

filter(callback) → {Array.<ReadOnlyChildModelSync>}

Creates a new array with all collection items that pass the test implemented by the provided function.

Parameters:

Name	Type	Description
callback	external.cbCollectionItem	Function to test for each collection item.

Returns:

The new array of collection items.

Type

Array.<ReadOnlyChildModelSync>

forEach(callback)

Executes a provided function once per collection item.

Parameters:

Name	Type	Description
callback	external.cbCollectionItem	Function that produces an item of the new collection.

<protected> getBrokenRules(namespace) → {Array.<bo.rules.BrokenRulesOutput>}

Gets the broken rules of all items of the collection.

This method is called by the parent object.

Parameters:

Name	Type	Argument	Description
namespace	string	<optional>	The namespace of the message keys when messages are localizable.

Returns:

The broken rules of the collection.

Type

Array.<bo.rules.BrokenRulesOutput>

<protected> isValid() → {boolean}

Indicates whether all items of the business collection are valid.

This method is called by the parent object.

Returns:

Type

boolean

map(callback) → {Array.<*>}

Creates a new array with the results of calling a provided function on every item in this collection.

Parameters:

Name	Type	Description
callback	external.cbCollectionItem	Function to test for each collection item.

Returns:

The new array of callback results.

Type

Array.<*>

some(callback) → {boolean}

Tests whether some item in the collection pass the test implemented by the provided function.

Parameters:

Name	Type	Description
callback	external.cbCollectionItem	Function to test for each collection item.

Returns:

True when callback returns truthy value for some item, otherwise false.

Type

boolean

sort(fnCompare) → {ReadOnlyChildCollectionSync}

Sorts the items of the collection in place and returns the collection.

Parameters:

Name	Type	Argument	Description
fnCompare	external.cbCompare	<optional>	Function that defines the sort order. If omitted, the collection is sorted according to each character's Unicode code point value, according to the string conversion of each item.

Returns:

The sorted collection.

Type

ReadOnlyChildCollectionSync

toCto() → {Array.<object>}

Transforms the business object collection to a plain object array to send to the client.
This method is usually called by the parent object.

Returns:

The client transfer object.

Type

Array.<object>