new EntityError(error [, opt_solution] [, opt_details] [, opt_code] [, opt_fields])
Classe de erro com mais detalhes que a nativa Error. Ela permite indicar para o usuário uma possível solução para o erro e separa os detalhes técnicos da mensagem a ser exibida para o usuário.
Parameters:
| Name | Type | Argument | Description |
|---|---|---|---|
error |
string |
Mensagem de erro a ser exibida para o usuário. |
|
opt_solution |
string |
<optional> |
Procedimento que o usuário deverá realizar para que o erro não seja produzido novamente. |
opt_details |
string |
<optional> |
Detalhes técnicos do erro. Detalhes que sejam de interesse exclusivo de desenvolvedores devem ser preferencialmente informados por este parâmetro em vez da mensagem de erro. |
opt_code |
number |
<optional> |
Código numérico do erro, permitindo que ele possa ser testado e tratado por códigos JavaScript. |
opt_fields |
Array.<string>| string |
<optional> |
Devem ser informados os campos que não satisfazem a validação indicada por opt_code, quando o erro tem relação com validações de campos. |
Extends
Members
-
code :string|number
-
Código que identifica o erro, permitindo que ele possa ser testado e tratado sem a inspeção da mensagem de erro.
É recomendado que os códigos de erro sejam textuais e possuam algum prefixo que identifique a origem do erro, evitando que classes ou módulos distintos utilizem o mesmo código para erros de natureza distinta.
Type:
- string| number
Example
if (err.code == 'ERR_CRYPTO_INVALID_IV') { } -
details :string
-
Detalhes técnicos do erro. Detalhes que sejam de interesse exclusivo de desenvolvedores devem ser preferencialmente informados nesta propriedade em vez da #error.
Type:
- string
-
error :string
-
Mensagem de erro a ser exibida para o usuário.
Type:
- string
-
errorCode :string|number
-
Código que identifica o erro. Propriedade mantida apenas para fins de compatibilidade. Em seu lugar, utilize a propriedade
code.Type:
- string| number
- Inherited From:
- Deprecated:
-
- Utilize a propriedade `error`.
- See:
-
fields :Array.<string>
-
Campos que não satisfazem a validação indicada por #code, quando o erro tem relação com validações de campos.
Type:
- Array.<string>
-
solution :string
-
Procedimento que o usuário deverá realizar para que o erro não seja produzido novamente.
Type:
- string
-
sourceLocation :string
-
Local onde o erro foi gerado, relevante apenas para indicar a localização interna dos erros lançados pelo Engine.
Esta propriedade não deve ser utilizada em códigos JavaScript, pois a pilha do erro já indica a localização de forma mais confiável. Ela antes poderia ser informada no quarto parâmetro do construtor, mas foi substituída pelo código do erro no construtor atual desta classe.
Type:
- string
-
<static> Codes :number
-
Códigos dos erros utilizados por EntityError na propriedade #code.
Type:
- number
Properties:
Name Type Default Description NOT_FOUNDnumber 1PERMISSION_DENIEDnumber 2FIELD_NOT_FOUNDnumber 3FIELD_TYPE_NOT_SUPPORTEDnumber 4READ_ONLY_FIELDnumber 5MISSING_FIELDnumber 6INVALID_CLASS_KEYnumber 7POSITION_CHANGEDnumber 8EMPTY_DATASETnumber 9CLASS_IS_JUST_TO_GROUPnumber 10HAS_DETAIL_ENTITIESnumber 11INVALID_KEYnumber 12