@sankhyalabs/core-docs 0.0.0-hotfix-ga-KB-4098.0

package/classes/DataUnit.md

@@ -0,0 +1,2427 @@
+[@sankhyalabs/core](../README.md) / [Exports](../modules.md) / DataUnit
+
+# Class: DataUnit
+
+`DataUnit`: Atua como uma camada de abstração entre o back-end e a interface do usuário.
+
+## Table of contents
+
+### Constructors
+
+- [constructor](DataUnit.md#constructor)
+
+### Properties
+
+- [\_childByName](DataUnit.md#_childbyname)
+- [\_filterProviders](DataUnit.md#_filterproviders)
+- [\_interceptors](DataUnit.md#_interceptors)
+- [\_loadingLockers](DataUnit.md#_loadinglockers)
+- [\_name](DataUnit.md#_name)
+- [\_observers](DataUnit.md#_observers)
+- [\_pageSize](DataUnit.md#_pagesize)
+- [\_parentDataUnit](DataUnit.md#_parentdataunit)
+- [\_sortingProvider](DataUnit.md#_sortingprovider)
+- [\_stateManager](DataUnit.md#_statemanager)
+- [\_uuid](DataUnit.md#_uuid)
+- [dataLoader](DataUnit.md#dataloader)
+- [metadataLoader](DataUnit.md#metadataloader)
+- [recordLoader](DataUnit.md#recordloader)
+- [removeLoader](DataUnit.md#removeloader)
+- [saveLoader](DataUnit.md#saveloader)
+
+### Accessors
+
+- [dataUnitId](DataUnit.md#dataunitid)
+- [metadata](DataUnit.md#metadata)
+- [name](DataUnit.md#name)
+- [pageSize](DataUnit.md#pagesize)
+- [records](DataUnit.md#records)
+- [sortingProvider](DataUnit.md#sortingprovider)
+
+### Methods
+
+- [addFilterProvider](DataUnit.md#addfilterprovider)
+- [addInterceptor](DataUnit.md#addinterceptor)
+- [addLoadingLocker](DataUnit.md#addloadinglocker)
+- [addRecord](DataUnit.md#addrecord)
+- [buildChangesToSave](DataUnit.md#buildchangestosave)
+- [buildChangesToSaveFromChild](DataUnit.md#buildchangestosavefromchild)
+- [canRedo](DataUnit.md#canredo)
+- [canUndo](DataUnit.md#canundo)
+- [cancelEdition](DataUnit.md#canceledition)
+- [cancelWaitingChange](DataUnit.md#cancelwaitingchange)
+- [childrenIsDirty](DataUnit.md#childrenisdirty)
+- [clearDataUnit](DataUnit.md#cleardataunit)
+- [clearInvalid](DataUnit.md#clearinvalid)
+- [clearSelection](DataUnit.md#clearselection)
+- [copySelected](DataUnit.md#copyselected)
+- [disableField](DataUnit.md#disablefield)
+- [dispatchAction](DataUnit.md#dispatchaction)
+- [doDispatchAction](DataUnit.md#dodispatchaction)
+- [enableField](DataUnit.md#enablefield)
+- [executeLoadData](DataUnit.md#executeloaddata)
+- [getAddedRecords](DataUnit.md#getaddedrecords)
+- [getAllChangesToSave](DataUnit.md#getallchangestosave)
+- [getAppliedFilters](DataUnit.md#getappliedfilters)
+- [getChildDataunit](DataUnit.md#getchilddataunit)
+- [getChildInfo](DataUnit.md#getchildinfo)
+- [getField](DataUnit.md#getfield)
+- [getFieldValue](DataUnit.md#getfieldvalue)
+- [getFielterProviderKey](DataUnit.md#getfielterproviderkey)
+- [getFilters](DataUnit.md#getfilters)
+- [getFormattedValue](DataUnit.md#getformattedvalue)
+- [getInvalidMessage](DataUnit.md#getinvalidmessage)
+- [getLastLoadRequest](DataUnit.md#getlastloadrequest)
+- [getLoadDataRequest](DataUnit.md#getloaddatarequest)
+- [getModifiedRecords](DataUnit.md#getmodifiedrecords)
+- [getPaginationInfo](DataUnit.md#getpaginationinfo)
+- [getParentRecordId](DataUnit.md#getparentrecordid)
+- [getRecordsByDataUnit](DataUnit.md#getrecordsbydataunit)
+- [getSelectedRecord](DataUnit.md#getselectedrecord)
+- [getSelectedRecords](DataUnit.md#getselectedrecords)
+- [getSelection](DataUnit.md#getselection)
+- [getSelectionInfo](DataUnit.md#getselectioninfo)
+- [getSort](DataUnit.md#getsort)
+- [gotoPage](DataUnit.md#gotopage)
+- [hasCopiedRecord](DataUnit.md#hascopiedrecord)
+- [hasDirtyRecords](DataUnit.md#hasdirtyrecords)
+- [hasNewRecord](DataUnit.md#hasnewrecord)
+- [hasNext](DataUnit.md#hasnext)
+- [hasPrevious](DataUnit.md#hasprevious)
+- [hasWaitingChanges](DataUnit.md#haswaitingchanges)
+- [hideField](DataUnit.md#hidefield)
+- [intercept](DataUnit.md#intercept)
+- [isDirty](DataUnit.md#isdirty)
+- [isNewRecord](DataUnit.md#isnewrecord)
+- [isSameRequest](DataUnit.md#issamerequest)
+- [loadData](DataUnit.md#loaddata)
+- [loadMetadata](DataUnit.md#loadmetadata)
+- [nextPage](DataUnit.md#nextpage)
+- [nextRecord](DataUnit.md#nextrecord)
+- [notifySavingData](DataUnit.md#notifysavingdata)
+- [onDataUnitParentEvent](DataUnit.md#ondataunitparentevent)
+- [previousPage](DataUnit.md#previouspage)
+- [previousRecord](DataUnit.md#previousrecord)
+- [processLoadingLockers](DataUnit.md#processloadinglockers)
+- [redo](DataUnit.md#redo)
+- [release](DataUnit.md#release)
+- [reloadCurrentRecord](DataUnit.md#reloadcurrentrecord)
+- [removeChildDataunit](DataUnit.md#removechilddataunit)
+- [removeInterceptor](DataUnit.md#removeinterceptor)
+- [removeRecords](DataUnit.md#removerecords)
+- [removeSelectedRecords](DataUnit.md#removeselectedrecords)
+- [saveData](DataUnit.md#savedata)
+- [selectFirst](DataUnit.md#selectfirst)
+- [selectLast](DataUnit.md#selectlast)
+- [setFieldValue](DataUnit.md#setfieldvalue)
+- [setInvalidField](DataUnit.md#setinvalidfield)
+- [setSelection](DataUnit.md#setselection)
+- [setSelectionByIndex](DataUnit.md#setselectionbyindex)
+- [showField](DataUnit.md#showfield)
+- [startChange](DataUnit.md#startchange)
+- [subscribe](DataUnit.md#subscribe)
+- [toString](DataUnit.md#tostring)
+- [undo](DataUnit.md#undo)
+- [unsubscribe](DataUnit.md#unsubscribe)
+- [updatePageSelection](DataUnit.md#updatepageselection)
+- [validateAndTypeValue](DataUnit.md#validateandtypevalue)
+- [valueFromString](DataUnit.md#valuefromstring)
+- [valueToString](DataUnit.md#valuetostring)
+- [waitingForChange](DataUnit.md#waitingforchange)
+
+## Constructors
+
+### constructor
+
+• **new DataUnit**(`name?`, `parentDataUnit?`)
+
+#### Parameters
+
+| Name | Type | Default value |
+| :------ | :------ | :------ |
+| `name` | `string` | `DEFAULT_DATAUNIT_NAME` |
+| `parentDataUnit?` | [`DataUnit`](DataUnit.md) | `undefined` |
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:53
+
+## Properties
+
+### \_childByName
+
+• `Private` **\_childByName**: `Map`<`string`, [`DataUnit`](DataUnit.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:43
+
+___
+
+### \_filterProviders
+
+• `Private` **\_filterProviders**: `Map`<`string`, `FilterProvider`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:39
+
+___
+
+### \_interceptors
+
+• `Private` **\_interceptors**: [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:41
+
+___
+
+### \_loadingLockers
+
+• `Private` **\_loadingLockers**: `Promise`<`void`\>[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:45
+
+___
+
+### \_name
+
+• `Private` **\_name**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:36
+
+___
+
+### \_observers
+
+• `Private` **\_observers**: (`action`: [`DataUnitAction`](DataUnitAction.md)) => `void`[]
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:37
+
+___
+
+### \_pageSize
+
+• `Private` **\_pageSize**: `number`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:42
+
+___
+
+### \_parentDataUnit
+
+• `Private` **\_parentDataUnit**: `undefined` \| [`DataUnit`](DataUnit.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:44
+
+___
+
+### \_sortingProvider
+
+• `Private` `Optional` **\_sortingProvider**: [`SortingProvider`](../interfaces/SortingProvider.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:38
+
+___
+
+### \_stateManager
+
+• `Private` **\_stateManager**: `default`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:40
+
+___
+
+### \_uuid
+
+• `Private` **\_uuid**: `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:35
+
+___
+
+### dataLoader
+
+• `Optional` **dataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `request`: [`LoadDataRequest`](../interfaces/LoadDataRequest.md)) => `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Type declaration
+
+▸ (`dataUnit`, `request`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+| `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
+
+##### Returns
+
+`Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:48
+
+___
+
+### metadataLoader
+
+• `Optional` **metadataLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md)) => `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Type declaration
+
+▸ (`dataUnit`): `Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+
+##### Returns
+
+`Promise`<[`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:47
+
+___
+
+### recordLoader
+
+• `Optional` **recordLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+#### Type declaration
+
+▸ (`dataUnit`, `recordIds`): `Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+| `recordIds` | `string`[] |
+
+##### Returns
+
+`Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:51
+
+___
+
+### removeLoader
+
+• `Optional` **removeLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `recordIds`: `string`[]) => `Promise`<`string`[]\>
+
+#### Type declaration
+
+▸ (`dataUnit`, `recordIds`): `Promise`<`string`[]\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+| `recordIds` | `string`[] |
+
+##### Returns
+
+`Promise`<`string`[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:50
+
+___
+
+### saveLoader
+
+• `Optional` **saveLoader**: (`dataUnit`: [`DataUnit`](DataUnit.md), `changes`: [`Change`](Change.md)[]) => `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+#### Type declaration
+
+▸ (`dataUnit`, `changes`): `Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+| `changes` | [`Change`](Change.md)[] |
+
+##### Returns
+
+`Promise`<[`SavedRecord`](../interfaces/SavedRecord.md)[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:49
+
+## Accessors
+
+### dataUnitId
+
+• `get` **dataUnitId**(): `string`
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:93
+
+___
+
+### metadata
+
+• `get` **metadata**(): [`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+Obtém os metadados do DataUnit.
+
+#### Returns
+
+[`UnitMetadata`](../interfaces/UnitMetadata.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:647
+
+• `set` **metadata**(`md`): `void`
+
+Define a propriedade metadata da instância da classe com um novo valor e chama o método dispatchAction para notificar os observers da aplicação sobre a mudança.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `md` | [`UnitMetadata`](../interfaces/UnitMetadata.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:638
+
+___
+
+### name
+
+• `get` **name**(): `string`
+
+Obtém o nome de identificação do DataUnit (geralmente em formato de URI - Uniform Resource Identifier).
+
+#### Returns
+
+`string`
+
+- Nome de identificação do DataUnit.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:104
+
+___
+
+### pageSize
+
+• `get` **pageSize**(): `number`
+
+Obtém a quantidade de registros que está sendo exibido por página.
+
+#### Returns
+
+`number`
+
+- Quantidade de registros exibidos por página.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:708
+
+• `set` **pageSize**(`size`): `void`
+
+Define a quantidade de registros que será exibido por página.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `size` | `number` | Quantidade de registros que será exibido por página. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:697
+
+___
+
+### records
+
+• `get` **records**(): [`Record`](../interfaces/Record.md)[]
+
+Obtém todos os registros atuais.
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+- Todos os registros atuais.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:685
+
+• `set` **records**(`records`): `void`
+
+Define a propriedade records da instância da classe com um novo valor e chama o método dispatchAction para notificar os observers da aplicação sobre a mudança.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `records` | [`Record`](../interfaces/Record.md)[] |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:674
+
+___
+
+### sortingProvider
+
+• `set` **sortingProvider**(`provider`): `void`
+
+Define a lógica de ordenação dos registros.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `provider` | [`SortingProvider`](../interfaces/SortingProvider.md) | Objeto usado para definir a propriedade sortingProvider da instância da classe. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:629
+
+## Methods
+
+### addFilterProvider
+
+▸ **addFilterProvider**(`provider`): `void`
+
+Adiciona um FilterProvider.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `provider` | `FilterProvider` | FilterProvider que será adicionado. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:608
+
+___
+
+### addInterceptor
+
+▸ **addInterceptor**(`interceptor`): `void`
+
+Adiciona um interceptor correspondente a uma ação do DataUnit para fazer um processamento customizado.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) | Interceptor a ser adicionado. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:586
+
+___
+
+### addLoadingLocker
+
+▸ **addLoadingLocker**(): `Function`
+
+Adiciona um locker para impedir o carregamento dos registros do dataUnit.
+
+#### Returns
+
+`Function`
+
+Retorna uma função responsável por liberar o lock adicionado.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1610
+
+___
+
+### addRecord
+
+▸ **addRecord**(`executionCtx?`): `Promise`<`boolean`\>
+
+Adiciona um novo registro.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da inserção do dado no DataUnit. |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:754
+
+___
+
+### buildChangesToSave
+
+▸ **buildChangesToSave**(): [`Change`](Change.md)[]
+
+Retorna as alterações a serem salvas no DataUnit atual.
+
+#### Returns
+
+[`Change`](Change.md)[]
+
+- Mudanças realizadas no DataUnit atual
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:416
+
+___
+
+### buildChangesToSaveFromChild
+
+▸ **buildChangesToSaveFromChild**(`allChanges`, `dataUnit`): `void`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `allChanges` | [`Change`](Change.md)[] |
+| `dataUnit` | [`DataUnit`](DataUnit.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:420
+
+___
+
+### canRedo
+
+▸ **canRedo**(): `boolean`
+
+Retorna se a informação do estado futuro está salva, permitindo refazer a ação.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se for possível refazer a ação.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1263
+
+___
+
+### canUndo
+
+▸ **canUndo**(): `boolean`
+
+Retorna se a informação do estado anterior está salva, permitindo desfazer a ação.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se for possível desfazer a ação.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1252
+
+___
+
+### cancelEdition
+
+▸ **cancelEdition**(`executionCtx?`, `fromParent?`, `silent?`): `Promise`<`boolean`\>
+
+Cancela edição do registro atual.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | `undefined` | Contexto de execução do cancelamento da seleção dos registros. |
+| `fromParent?` | `boolean` | `undefined` | - |
+| `silent` | `boolean` | `false` | - |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1119
+
+___
+
+### cancelWaitingChange
+
+▸ **cancelWaitingChange**(`fieldName`): `void`
+
+Cancela o início de uma alteração no campo.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Identificador do campo. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:908
+
+___
+
+### childrenIsDirty
+
+▸ `Private` **childrenIsDirty**(): `boolean`
+
+Retorna se existe algum DataUnit detail com alterações pendentes.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se existir alterações pendentes em algum DataUnit detail.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1148
+
+___
+
+### clearDataUnit
+
+▸ **clearDataUnit**(): `void`
+
+Limpa todos os registros do DataUnit
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1052
+
+___
+
+### clearInvalid
+
+▸ **clearInvalid**(`recordId`, `fieldName?`): `void`
+
+Limpa campos inválidos.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `recordId` | `string` | Indica em qual registro o campo não está mais inválido. |
+| `fieldName?` | `string` | Nome do campo. Caso omitido, todos os campos serão limpos. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:873
+
+___
+
+### clearSelection
+
+▸ **clearSelection**(`executionCtx?`): `void`
+
+Limpa a seleção.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção dos registros do DataUnit. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:983
+
+___
+
+### copySelected
+
+▸ **copySelected**(`executionCtx?`): `void`
+
+Efetua a cópia do registro selecionado.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da cópia do dado do DataUnit. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:765
+
+___
+
+### disableField
+
+▸ **disableField**(`fieldName`): `void`
+
+Desabilita um campo do DataUnit
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | nome do campo para ficar desabilitado. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1521
+
+___
+
+### dispatchAction
+
+▸ `Private` **dispatchAction**(`actionType`, `payload?`, `executionCtx?`): `Promise`<`boolean`\>
+
+Lança ação do DataUnit para que sejam processadas.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `actionType` | [`Action`](../enums/Action.md) | Tipo de ação que será executada. |
+| `payload?` | `any` | Dados que serão processados na ação. |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução de lançar a ação que será executada. |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+- Verdadeiro se ação iniciada.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1313
+
+___
+
+### doDispatchAction
+
+▸ `Private` **doDispatchAction**(`action`): `void`
+
+Processa as ações no DataUnit e notifica os observers.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `action` | [`DataUnitAction`](DataUnitAction.md) | Ações em execução no DataUnit. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1361
+
+___
+
+### enableField
+
+▸ **enableField**(`fieldName`): `void`
+
+Habilita um campo do DataUnit
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | nome do campo para ser habilitado. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1506
+
+___
+
+### executeLoadData
+
+▸ `Private` **executeLoadData**(`request`, `executionCtx?`, `checkLastFilter?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+Executa o carregamento dos registros.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) | Dados da requisição para carregamento dos registros. |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
+| `checkLastFilter?` | `boolean` | Habilita a verificação da última requisição, evitando carga desnecessária. |
+
+#### Returns
+
+`Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+- Registros do DataUnit.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:171
+
+___
+
+### getAddedRecords
+
+▸ **getAddedRecords**(): [`Record`](../interfaces/Record.md)[]
+
+Obtém os registros adicionados no DataUnit.
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+- Lista dos registros adicionados.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:731
+
+___
+
+### getAllChangesToSave
+
+▸ **getAllChangesToSave**(): [`Change`](Change.md)[]
+
+Retorna todas as alterações do DataUnit a serem salvas, incluindo no nível Master e Detail.
+
+#### Returns
+
+[`Change`](Change.md)[]
+
+- Todas as mudanças realizadas no DataUnit, tanto Master quanto Detail;
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:438
+
+___
+
+### getAppliedFilters
+
+▸ **getAppliedFilters**(): `undefined` \| [`Filter`](../interfaces/Filter.md)[]
+
+Obtém os filtros aplicados.
+
+#### Returns
+
+`undefined` \| [`Filter`](../interfaces/Filter.md)[]
+
+- Lista de filtros.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1495
+
+___
+
+### getChildDataunit
+
+▸ **getChildDataunit**(`name`): [`DataUnit`](DataUnit.md)
+
+Cria um dataunit filho.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `name` | `string` | Nome do dataunit filho. |
+
+#### Returns
+
+[`DataUnit`](DataUnit.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1384
+
+___
+
+### getChildInfo
+
+▸ **getChildInfo**(`name`): `undefined` \| [`ChildDescriptor`](../interfaces/ChildDescriptor.md)
+
+Obtém informações da ligação para um DataUnit filho.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `name` | `string` | Nome do DataUnit que se deseja. |
+
+#### Returns
+
+`undefined` \| [`ChildDescriptor`](../interfaces/ChildDescriptor.md)
+
+- As informações sobre a ligação solicitada. Pode retornar undefined.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:660
+
+___
+
+### getField
+
+▸ **getField**(`fieldName`): `undefined` \| [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
+
+Obtém metadados de um campo específico.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Identificador do campo. |
+
+#### Returns
+
+`undefined` \| [`FieldDescriptor`](../interfaces/FieldDescriptor.md)
+
+- Metadados do campo informado.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:743
+
+___
+
+### getFieldValue
+
+▸ **getFieldValue**(`fieldName`): `any`
+
+Obtém valor do campo desejado.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Identificador do campo a ser buscado. |
+
+#### Returns
+
+`any`
+
+- Valor do campo.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:824
+
+___
+
+### getFielterProviderKey
+
+▸ `Private` **getFielterProviderKey**(`provider`): `string`
+
+Obtém chave única para identificação do FilterProvider.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `provider` | `FilterProvider` | Interface FilterProvider na qual será retornada uma chave correspondente. |
+
+#### Returns
+
+`string`
+
+- A chave do provider.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:153
+
+___
+
+### getFilters
+
+▸ **getFilters**(): `undefined` \| [`Filter`](../interfaces/Filter.md)[]
+
+Obtém todos os filtros de dados.
+
+#### Returns
+
+`undefined` \| [`Filter`](../interfaces/Filter.md)[]
+
+- Lista de filtros.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1466
+
+___
+
+### getFormattedValue
+
+▸ **getFormattedValue**(`fieldName`, `value?`): `string`
+
+Formata o valor do campo considerando as informações do descriptor.
+Diferente do método "valueToString" que retorna o dado em valor textual,
+getFormattedValue retorna uma informação amigável ao usuário, geralmente
+usada na interface.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Nome do campo utilizado do qual se quer obter valor. |
+| `value?` | `any` | (opcional) - O valor a ser convertido. Caso omitido pega do registro selecionado. |
+
+#### Returns
+
+`string`
+
+- Valor formatado.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:563
+
+___
+
+### getInvalidMessage
+
+▸ **getInvalidMessage**(`recordId`, `fieldName`): `undefined` \| `string`
+
+Obtém a mensagem de campo inválido para determinado registro.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `recordId` | `string` | Identificador do registro. |
+| `fieldName` | `string` | Nome do campo. |
+
+#### Returns
+
+`undefined` \| `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:885
+
+___
+
+### getLastLoadRequest
+
+▸ **getLastLoadRequest**(): `undefined` \| [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
+
+Obtém as informações da última carga de dados.
+
+#### Returns
+
+`undefined` \| [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
+
+- As informações de filtro e paginação.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1484
+
+___
+
+### getLoadDataRequest
+
+▸ `Private` **getLoadDataRequest**(`quickFilter?`): [`LoadDataRequest`](../interfaces/LoadDataRequest.md)
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `quickFilter?` | [`QuickFilter`](../interfaces/QuickFilter.md) |
+
+#### Returns
+
+[`LoadDataRequest`](../interfaces/LoadDataRequest.md)
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:319
+
+___
+
+### getModifiedRecords
+
+▸ **getModifiedRecords**(): [`Record`](../interfaces/Record.md)[]
+
+Obtém os registros modificados e ainda não salvos no DataUnit.
+
+#### Returns
+
+[`Record`](../interfaces/Record.md)[]
+
+- Lista dos registros em edição.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:719
+
+___
+
+### getPaginationInfo
+
+▸ **getPaginationInfo**(): `void` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
+
+Obtém informações de paginação dos registros.
+
+#### Returns
+
+`void` \| [`PaginationInfo`](../interfaces/PaginationInfo.md)
+
+- Informações da paginação de registros.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:618
+
+___
+
+### getParentRecordId
+
+▸ `Private` **getParentRecordId**(): `undefined` \| `string`
+
+#### Returns
+
+`undefined` \| `string`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:797
+
+___
+
+### getRecordsByDataUnit
+
+▸ `Private` **getRecordsByDataUnit**(`records`): `Map`<`string`, [`Record`](../interfaces/Record.md)[]\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `records` | [`Record`](../interfaces/Record.md)[] |
+
+#### Returns
+
+`Map`<`string`, [`Record`](../interfaces/Record.md)[]\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:775
+
+___
+
+### getSelectedRecord
+
+▸ **getSelectedRecord**(): `undefined` \| [`Record`](../interfaces/Record.md)
+
+Retorna apenas um registro selecionado no Dataunit
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)
+
+- Registro selecionado.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1040
+
+___
+
+### getSelectedRecords
+
+▸ **getSelectedRecords**(): `undefined` \| [`Record`](../interfaces/Record.md)[]
+
+Obtém todos os registros selecionados.
+
+**`Deprecated`**
+
+- Utilize o método `getSelectionInfo()` para obter os registros selecionados.
+Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
+método foi descontinuado e pode retornar erros no caso da seleção virtual.
+
+#### Returns
+
+`undefined` \| [`Record`](../interfaces/Record.md)[]
+
+- Lista de registros selecionados.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1571
+
+___
+
+### getSelection
+
+▸ **getSelection**(): `string`[]
+
+Obtém ids dos registros selecionados.
+
+**`Deprecated`**
+
+- Utilize o método `getSelectionInfo()` para obter os registros selecionados.
+Devido a seleção virtual baseada em critérios e ordenação (ALL_RECORDS), esse
+método foi descontinuado e pode retornar erros no caso da seleção virtual.
+
+#### Returns
+
+`string`[]
+
+- Lista com id de todos os registros selecionados.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1595
+
+___
+
+### getSelectionInfo
+
+▸ **getSelectionInfo**(): `undefined` \| [`SelectionInfo`](SelectionInfo.md)
+
+Obtém informações sobre a seleção atual.
+
+#### Returns
+
+`undefined` \| [`SelectionInfo`](SelectionInfo.md)
+
+- Objeto com informações como registros selecionados e seleção por critério.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1029
+
+___
+
+### getSort
+
+▸ **getSort**(): `undefined` \| [`Sort`](../interfaces/Sort.md)[]
+
+Obtém a estrutura de ordenação das colunas dos dados.
+
+#### Returns
+
+`undefined` \| [`Sort`](../interfaces/Sort.md)[]
+
+- Lista dos ordenáveis por prioridade.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1455
+
+___
+
+### gotoPage
+
+▸ **gotoPage**(`page`, `executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+Alterna entre os registros por número de página.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `page` | `number` | Número da página desejada. |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
+
+#### Returns
+
+`Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+- Registros da página desejada.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:272
+
+___
+
+### hasCopiedRecord
+
+▸ **hasCopiedRecord**(): `boolean`
+
+Retorna se existe pelo menos um registro novo.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se algum registro foi adicionado.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1232
+
+___
+
+### hasDirtyRecords
+
+▸ **hasDirtyRecords**(): `boolean`
+
+Retorna se existe algum registro em modo de edição.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se existir alterações de registros pendentes.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1162
+
+___
+
+### hasNewRecord
+
+▸ **hasNewRecord**(): `boolean`
+
+Retorna se existe pelo menos um registro novo.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se algum registro foi adicionado.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1220
+
+___
+
+### hasNext
+
+▸ **hasNext**(): `boolean`
+
+Retorna se existir uma pagina seguinte a atual na paginação.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se existir uma próxima página.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1173
+
+___
+
+### hasPrevious
+
+▸ **hasPrevious**(): `boolean`
+
+Retorna se existe uma página anterior a atual na paginação.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se existir uma página anterior.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1188
+
+___
+
+### hasWaitingChanges
+
+▸ **hasWaitingChanges**(): `boolean`
+
+Retorna se existe alterações pendentes.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se existir pendências de modificações.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:916
+
+___
+
+### hideField
+
+▸ **hideField**(`fieldName`): `void`
+
+Deixa um campo do DataUnit invisível
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | nome do campo para ficar invisível. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1536
+
+___
+
+### intercept
+
+▸ `Private` **intercept**(`action`, `interceptors`): `Promise`<[`DataUnitAction`](DataUnitAction.md)\>
+
+Notifica os interceptors de que uma ação foi executada, para que cada interceptor possa fazer sua respectiva tratativa dos dados.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `action` | [`DataUnitAction`](DataUnitAction.md) | Ação que foi executada. |
+| `interceptors` | `IterableIterator`<[`DUActionInterceptor`](../interfaces/DUActionInterceptor.md)\> | Interceptors que serão notificados. |
+
+#### Returns
+
+`Promise`<[`DataUnitAction`](DataUnitAction.md)\>
+
+- Ação executada no DataUnit.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1344
+
+___
+
+### isDirty
+
+▸ **isDirty**(): `boolean`
+
+Retorna se existe algum tipo de alteração pendente.
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se existir alterações pendentes.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1137
+
+___
+
+### isNewRecord
+
+▸ **isNewRecord**(`recordId`): `boolean`
+
+Verifica se um registro é proveniente de inclusão.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `recordId` | `string` | O id do registro a ser verificado. |
+
+#### Returns
+
+`boolean`
+
+Verdadeiro se o id solicitado é de um registro novo.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1204
+
+___
+
+### isSameRequest
+
+▸ `Private` **isSameRequest**(`request`): `boolean`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `request` | [`LoadDataRequest`](../interfaces/LoadDataRequest.md) |
+
+#### Returns
+
+`boolean`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:201
+
+___
+
+### loadData
+
+▸ **loadData**(`quickFilter?`, `executionCtx?`, `checkLastFilter?`): `Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+Carrega os registros do DataUnit.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `quickFilter?` | [`QuickFilter`](../interfaces/QuickFilter.md) | Filtros a serem aplicados. |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros. |
+| `checkLastFilter?` | `boolean` | Habilita a verificação da última requisição, evitando carga desnecessária. |
+
+#### Returns
+
+`Promise`<[`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+- Registros requisitados.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:245
+
+___
+
+### loadMetadata
+
+▸ **loadMetadata**(`executionCtx?`): `Promise`<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+Carrega os metadados do DataUnit.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos metadados do DataUnit. |
+
+#### Returns
+
+`Promise`<`void` \| [`UnitMetadata`](../interfaces/UnitMetadata.md)\>
+
+- Metadados carregados.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:216
+
+___
+
+### nextPage
+
+▸ **nextPage**(`executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+Vai para os registros da página seguinte.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
+
+#### Returns
+
+`Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+- Registros da página seguinte.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:302
+
+___
+
+### nextRecord
+
+▸ **nextRecord**(`executionCtx?`): `void`
+
+Seleciona o próximo registro.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1064
+
+___
+
+### notifySavingData
+
+▸ `Private` **notifySavingData**(`executionCtx?`): `Promise`<`boolean`\>
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:338
+
+___
+
+### onDataUnitParentEvent
+
+▸ `Private` **onDataUnitParentEvent**(`action`): `void`
+
+Trata as Actions do DataUnit Parent
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `action` | [`DataUnitAction`](DataUnitAction.md) |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:129
+
+___
+
+### previousPage
+
+▸ **previousPage**(`executionCtx?`): `Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+Vai para os registros da página anterior.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução do carregamento dos registros do DataUnit. |
+
+#### Returns
+
+`Promise`<`void` \| [`LoadDataResponse`](../interfaces/LoadDataResponse.md)\>
+
+- Registros da página anterior.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:315
+
+___
+
+### previousRecord
+
+▸ **previousRecord**(`executionCtx?`): `void`
+
+Seleciona o registro anterior.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1091
+
+___
+
+### processLoadingLockers
+
+▸ `Private` **processLoadingLockers**(): `Promise`<`void`\>
+
+#### Returns
+
+`Promise`<`void`\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1620
+
+___
+
+### redo
+
+▸ **redo**(`executionCtx?`): `void`
+
+Refaz a última ação.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução de refazer a última ação. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1286
+
+___
+
+### release
+
+▸ **release**(): `void`
+
+Desfaz vinculos do DataUnit. Chamado quando o DU não é mais necessário.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:85
+
+___
+
+### reloadCurrentRecord
+
+▸ **reloadCurrentRecord**(): `Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+Recarrega registro selecionado com dados atualizados do servidor.
+
+#### Returns
+
+`Promise`<[`Record`](../interfaces/Record.md)[]\>
+
+- Dados atualizados do registro selecionado.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1431
+
+___
+
+### removeChildDataunit
+
+▸ **removeChildDataunit**(`name`): `void`
+
+Remove um dataunit filho.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `name` | `string` | Nome do dataunit filho. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1397
+
+___
+
+### removeInterceptor
+
+▸ **removeInterceptor**(`interceptor`): `void`
+
+Remove um interceptor da lista de interceptors.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `interceptor` | [`DUActionInterceptor`](../interfaces/DUActionInterceptor.md) | Interceptor a ser removido. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:597
+
+___
+
+### removeRecords
+
+▸ **removeRecords**(`recordIds`, `cachedRecords`, `buffered?`, `executionCtx?`, `silent?`): `Promise`<`string`[]\>
+
+Efetua requisição para remoção dos registros.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `recordIds` | `string`[] | `undefined` | Lista de IDs dos registros que serão removidos. |
+| `cachedRecords` | [`Record`](../interfaces/Record.md)[] | `undefined` | Dados dos registros que serão removidos. |
+| `buffered` | `boolean` | `false` | Se será utilizado buffer na solicitação. |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | `undefined` | Contexto de execução da remoção do registro do DataUnit. |
+| `silent` | `boolean` | `false` | Define se haverá mensagem de confirmação da remoção |
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+- ID's dos registros removidos.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:481
+
+___
+
+### removeSelectedRecords
+
+▸ **removeSelectedRecords**(`buffered?`, `silent?`): `Promise`<`string`[]\>
+
+Remove o registro selecionado.
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `buffered` | `boolean` | `false` | Se será utilizado buffer na solicitação. |
+| `silent` | `boolean` | `false` | Define se haverá mensagem de confirmação da remoção |
+
+#### Returns
+
+`Promise`<`string`[]\>
+
+- ID's dos registros removidos.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:455
+
+___
+
+### saveData
+
+▸ **saveData**(`executionCtx?`): `Promise`<`void`\>
+
+Salva o estado do registro do DataUnit.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da persistencia do registro do DataUnit. |
+
+#### Returns
+
+`Promise`<`void`\>
+
+- Resposta da solicitação.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:362
+
+___
+
+### selectFirst
+
+▸ **selectFirst**(`executionCtx?`): `void`
+
+Seleciona o primeiro registro.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:929
+
+___
+
+### selectLast
+
+▸ **selectLast**(`executionCtx?`): `void`
+
+Seleciona o último registro.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:942
+
+___
+
+### setFieldValue
+
+▸ **setFieldValue**(`fieldName`, `newValue`, `records?`): `Promise`<`boolean`\>
+
+Insere valor no campo desejado.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Identificador do campo a ser modificado. |
+| `newValue` | `any` | Valor a ser inserido no campo. |
+| `records?` | `string`[] | Indica quais registros foram afetados pela alteração no valor do campo. |
+
+#### Returns
+
+`Promise`<`boolean`\>
+
+- Promise que será resolvida quando o novo valor for persistido no state.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:838
+
+___
+
+### setInvalidField
+
+▸ **setInvalidField**(`fieldName`, `message`, `recordId`): `void`
+
+Marca campos como inválidos.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Nome do campo inválido. |
+| `message` | `string` | Mensagem descrevendo o motivo da invalidade. |
+| `recordId` | `string` | Indica qual registro está com o campo inválido. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:861
+
+___
+
+### setSelection
+
+▸ **setSelection**(`selection`, `executionCtx?`): `Promise`<[`SelectionInfo`](SelectionInfo.md)\>
+
+Seleciona múltiplos registros por ID ou todos os registros (multipágina) .
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `selection` | `string`[] \| [`ALL_RECORDS`](../enums/SelectionMode.md#all_records) | IDs para selecionar ou o modo de seleção completo. |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção dos registros do DataUnit. |
+
+#### Returns
+
+`Promise`<[`SelectionInfo`](SelectionInfo.md)\>
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:969
+
+___
+
+### setSelectionByIndex
+
+▸ **setSelectionByIndex**(`selection`, `executionCtx?`): `void`
+
+Seleciona múltiplos registros por índice.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `selection` | `number`[] | Índices desejados para a seleção. |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção do registro do DataUnit. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:956
+
+___
+
+### showField
+
+▸ **showField**(`fieldName`): `void`
+
+Deixa um campo do DataUnit visível
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | nome do campo para ficar visível. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1551
+
+___
+
+### startChange
+
+▸ **startChange**(`fieldName`, `waitingChange`): `void`
+
+Inicia alteração no campo.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Identificador do campo a ser modificado. |
+| `waitingChange` | [`WaitingChange`](../interfaces/WaitingChange.md) | Informa que uma mudança irá iniciar. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:897
+
+___
+
+### subscribe
+
+▸ **subscribe**(`observer`): `void`
+
+Adiciona um novo observer no DataUnit.
+Ela vai ser chamada sempre que uma ação for despachada (dispatchAction()).
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `observer` | (`action`: [`DataUnitAction`](DataUnitAction.md)) => `void` | Função que recebe como parâmetro as ações que serão monitoradas. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1409
+
+___
+
+### toString
+
+▸ **toString**(): `string`
+
+Obtém a representação textual do DataUnit, nesse caso, o nome do DataUnit.
+
+#### Returns
+
+`string`
+
+- Valor contido na propriedade name.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1297
+
+___
+
+### undo
+
+▸ **undo**(`executionCtx?`): `void`
+
+Desfaz a última ação.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução de desfazer a última ação. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1275
+
+___
+
+### unsubscribe
+
+▸ **unsubscribe**(`observer`): `void`
+
+Remove um observer existente.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `observer` | `Function` | Observer que se deseja remover. |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:1420
+
+___
+
+### updatePageSelection
+
+▸ **updatePageSelection**(`selection`, `executionCtx?`): `Promise`<`undefined` \| [`SelectionInfo`](SelectionInfo.md)\>
+
+Atualiza a seleção dos registros atuais.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `selection` | `string`[] | IDs dos registros selecionados no snapshot atual |
+| `executionCtx?` | [`ExecutionContext`](../interfaces/ExecutionContext.md) | Contexto de execução da seleção dos registros do DataUnit. |
+
+#### Returns
+
+`Promise`<`undefined` \| [`SelectionInfo`](SelectionInfo.md)\>
+
+- Informações sobre a seleção.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:996
+
+___
+
+### validateAndTypeValue
+
+▸ `Private` **validateAndTypeValue**(`fieldName`, `newValue`): `any`
+
+Obtém o valor convertido de acordo com o tipo do campo.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Identificador do campo. |
+| `newValue` | `any` | Novo valor que será atribuído ao campo pós validação. |
+
+#### Returns
+
+`any`
+
+- Novo valor convertido em um tipo valido.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:118
+
+___
+
+### valueFromString
+
+▸ **valueFromString**(`fieldName`, `value`): `any`
+
+Obtém o valor do campo em seu formato/tipo correto a partir de uma string.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Nome do campo que terá o tipo identificado para conversão. |
+| `value` | `string` | Texto que será convertido de acordo com o tipo identificado no campo. |
+
+#### Returns
+
+`any`
+
+- Valor convertido ou ele mesmo.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:530
+
+___
+
+### valueToString
+
+▸ **valueToString**(`fieldName`, `value`): `string`
+
+Converte o valor informado para texto de acordo com o tipo do campo informado.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Nome do campo utilizado para buscar o tipo de dado com o padrão de conversão para string. |
+| `value` | `any` | Valor a ser convertido. |
+
+#### Returns
+
+`string`
+
+- Valor informado convertido.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:545
+
+___
+
+### waitingForChange
+
+▸ **waitingForChange**(`fieldName`): `boolean`
+
+Retorna se a alteração no campo já foi concluída ou se ainda está incompleta.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `fieldName` | `string` | Identificador do campo a ser verificado. |
+
+#### Returns
+
+`boolean`
+
+- Verdadeiro se ainda está pendente.
+
+#### Defined in
+
+src/dataunit/DataUnit.ts:811