import.css=/download/attachments/327912/newLayout.css
Classe: FWFormFieldsModel
Compatível Países: Todos
Sistemas Operacionais: Todos
Compatível às Bases de Dados: Todos
Nível de Acesso: Nível 1 (Acesso Clientes)
Idiomas: Português, Inglês, Espanhol
Versão P10 R1.4
Descrição
Fornece um objeto de submodelo de edição por campo.
Um submodelo do tipo Field permite manipular somente um
registro por vez. Ele tem um relacionamento do tipo 1xN ou 1x1 com outros
SubModelos ou então não tem nenhum relacionamento.


ClassName

Sintaxe
FWFORMFIELDSMODEL():ClassName()-> cName

Descrição
Fornece o nome da classe


Retorno
cName Nome da classe

SetStruct

Sintaxe
FWFORMFIELDSMODEL():SetStruct(<oFormModelStruct >)-> NIL

Descrição
Configura o objeto com a estrutura de dados


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
oFormModelStruct Objeto Objeto com a estrutura de dados.
X
 

SetValue

Sintaxe
FWFORMFIELDSMODEL():SetValue(<cId >, [ xValue ])-> lAtribuido

Descrição
Atribui um valor a folha de dados


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
cId Caracteres Codigo/Nome do atributo da folha de dados X
xValue Qualquer Valor a ser atribuido
::ADATAMODEL[MODEL_FIELD_DATA][NIDFIELD][MODEL_DATA_VALUE]
 

Retorno
lAtribuido Indica se o valor foi atribuido

LoadValue

Sintaxe
FWFORMFIELDSMODEL():LoadValue(<cId >, [ xValue ])-> lAtribuido

Descrição
Carrega um valor a folha de dados do objeto. Este metodo somente pode ser utilizado quando há SetValue na pilha de chamadas
de função ( CallStack ). Diferentemente do metodo SetValue, este método não executa a validação do campo, mas fornece
todas as indicações de que ele foi atualizado. Ele é muito utíl quando dentro de uma validação de campo, necessitamos
alterar valores de outros campos, sem que isto implique em valida-los.


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
cId Caracteres Codigo/Nome do atributo da folha de dados X
xValue Qualquer Valor a ser atribuido
 

Retorno
lAtribuido Indica que o valor foi atribuido

GetValue

Sintaxe
FWFORMFIELDSMODEL():GetValue(<cId >)-> NIL

Descrição
Fornece o valor da folha de dados de um campo do objeto


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
cId Caracteres Codigo/Nome do atributo da folha de dados
X
 

VldData

Sintaxe
FWFORMFIELDSMODEL():VldData()-> lRetorno

Descrição
Valida a folha de dados do objeto


Retorno
lRetorno Folha de dados valida

CanSetValue

Sintaxe
FWFORMFIELDSMODEL():CanSetValue(<cId >)-> lRetorno

Descrição
Verificar se pode-se atribuir um valor a folha de dados do objeto


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
cId Caracteres Codigo/Nome do atributo da folha de dados
X
 

Retorno
lRetorno Indica se o valor pode ser atribuido

GetWhenFields

Sintaxe
FWFORMFIELDSMODEL():GetWhenFields()-> aFields

Descrição
Retorna os campos que precisam ser avaliados no when.


Retorno
aFields Array unidimensional com o ID dos campos

ClearField

Sintaxe
FWFORMFIELDSMODEL():ClearField(<cId >)-> lAtribuido

Descrição
Limpa o conteudo de um campo


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
cId Caracteres Codigo/Nome do atributo da folha de dados
X
 

Retorno
lAtribuido Indica se o campo foi limpo

IsFieldUpdated

Sintaxe
FWFORMFIELDSMODEL():IsFieldUpdated(<cId >)-> lAtribuido

Descrição
Retorna se um Campo foi atualizado


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
cId Caracteres Codigo/Nome do Field X
 

Retorno
lAtribuido Indica que o valor foi atribuido

SetOptional

Sintaxe
FWFORMFIELDSMODEL():SetOptional([ lOp ])-> NIL

Descrição
Define que um submodelo é opcional. Quando um modelo é opcional ele tem seu preenchimento
não obrigatório, podendo realizar a gravação dos dados sem preenche-lo


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
lOp Lógico Se verdadeiro o submodelo passa a ser não obrigatório
.F.
 

SetOnlyView

Sintaxe
FWFORMFIELDSMODEL():SetOnlyView()-> NIL

Descrição
Define que o submodelo não irá permitir a edição de dados.
Se a operação for inclusão o when dos campos passará a ser falso
e se for qualquer outra operação os campos não permitirão edição.


GetDataID

Sintaxe
FWFORMFIELDSMODEL():GetDataID()-> NIL

Descrição
Fornece o recno do registro.


IsModified

Sintaxe
FWFORMFIELDSMODEL():IsModified()-> lRet

Descrição
Retorna se o formfield foi alterado


Retorno
lRet Se verdadeiro o formfield foi modificado

InitValue

Sintaxe
FWFORMFIELDSMODEL():InitValue(<cIdField >)-> xValue

Descrição
Fornece o valor do inicializador padrao da folha de dados de um campo


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
cIdField Caracteres Codigo/Nome do campo
X
 

Retorno
xValue Valor inicial

Compare

Sintaxe
FWFORMFIELDSMODEL():Compare(<aCompare >, <oFormFieldModel >)-> NIL

Descrição
Faz a comparação entre os dados de um objeto do tipo FWFormFieldModel passado por referência
com o próprio objeto. Os dois objetos devem possuir a mesma estrutura, pois esse
método compara apenas os dados, supondo que a estrutura seja a mesma.


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
aCompare Array - Array que deve ser passado por referencia,para que o metodo salve as informações de diferencas
no formato:
[n] Array
[n][1] - ExpC: Id do Formular
[n][2] - ExpC: Tipo (F)
[n][3] - SubArray com os campos alterados
[n][3][1] - ExpC: ID do campo
[n][3][2] - ExpX: Valor do Modelo(self)
[n][3][3] - ExpX: Valor do modelo passado no segundo parametro
[n][4] - ExpN: Operação do modelo
X X
oFormFieldModel Objeto - Outro FwformfieldsModel para ser feita a comparação, ele deve possuir exatamente a mesma estrutura.
X
 

GetValueByPos

Sintaxe
FWFORMFIELDSMODEL():GetValueByPos(<nIdPos >)-> NIL

Descrição
Fornece o valor da folha de dados de um campo, baseado na posição dele
na estrutura, utilize ele somente quando a rotina possui um grande volume
processamento. Para saber a posicao do campo use o metodo GetArrayPos
do objeto de estrutura de dados (FWFormModelStruct).
Atenção!! Esse metodo nao verifica se o campo existe.


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
nIdPos Numérico Posicao do campo na estrutura de dados
X
 

Veja também

GetArrayPos -> FWFormModelStruct
LdValueByPos

SetFldNoCopy

Sintaxe
FWFORMFIELDSMODEL():SetFldNoCopy(<aFldNoCopy >)-> NIL

Descrição
Define quais campos do submodelo não serão copiados no processo de cópia
do submodelo.


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
aFldNoCopy Array Array unidimensional com o IDs do campos que não serão copiados
X
 

Exemplo

oModel:GetModel "ZA1MASTER"):SetFldNoCopy( { 'ZA1_OK', 'ZA1_SALDO' } )

GetFldNoCopy

Sintaxe
FWFORMFIELDSMODEL():GetFldNoCopy()-> aFldNoCopy

Descrição
Retorna quais campos do submodelo não serão copiados no processo de cópia


Retorno
aFldNoCopy Array unidimensional com os identificadores dos campos

LdValueByPos

Sintaxe
FWFORMFIELDSMODEL():LdValueByPos(<cId >, [ xValue ])-> lAtribuido

Descrição
Carrega um valor para a folha de dados através de acesso direto a posicao
do campo na estrutura. Use esse método somente quando possuir um
grande volume de processsamento na rotina.
Para determinar a posicao do campo utilize o metodo GetArrayPos da
estrutura de dados do submodelo (FWFormModelStruct).


Parâmetros
Nome Tipo Descrição Default Obrigatório Referência
cId Caracteres Codigo/Nome do atributo da folha de dados X
xValue Qualquer Valor a ser atribuido
 

Retorno
lAtribuido Indica que o valor foi atribuido

Exemplo

aPosFields := oStruZA2:GetArrayPos("ZA2_MUSICA", "ZA2_ITEM")

oModel:GetModel("ZA2DETAIL"):LdValueByPos(aPosFields[1], "00001")
oModel:GetModel("ZA2DETAIL"):LdValueByPos(aPosFields[2], "1")

Veja também

GetValueByPos
GetArrayPos -> FWFormModelStruct

isEnable

Sintaxe
FWFORMFIELDSMODEL():isEnable()-> lRet

Descrição
Execulta o bloco de bPre do modelo, retornando se ele está disponivel para edição o unão


Retorno
lRet - Indica se o modelo está disponivel

addShareSubModel

Sintaxe
FWFORMFIELDSMODEL():addShareSubModel()-> NIL

Descrição
Adiciona nesse submodelo, um id de outro submodelo do tipo Fields.
Esse submodelo sera tratado como uma extensao deste submodelo.


getShared

Sintaxe
FWFORMFIELDSMODEL():getShared()-> aShares

Descrição
Retorna um array com os submodelos que são compartildos com esse
submodelo

Retorno
aShares Arrays de ID de submodelos