| 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
Classe responsável por representar uma estrutura de dados para um
submodelo do Model.
A classe tem estrutura para representar:
- Uma Tabela
- Diversos Campos
- Diversos Indexes
- Diversos Gatilhos
New
Sintaxe
FWFORMMODELSTRUCT():New()-> NIL
Descrição
Método construtor da classe
ClassName
Sintaxe
FWFORMMODELSTRUCT():ClassName()-> cClassName
Descrição
Retorna o nome da classe (FWFORMMODELSTRUCT)
Retorno
cClassName Nome da classe
AddTable
Sintaxe
FWFORMMODELSTRUCT():AddTable(<cAlias >, [ aPK ], <cDescription >, <bRealName >)-> NIL
Descrição
Adiciona uma estrutura que represente uma tabela, essa tabela
pode ser do dicionário de dados ou qualquer outra tabela.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| cAlias | Caracteres | Alias da tabela | | X | |
| aPK | Array | Array unidimensional com os campos que correspondem a primary key | | | |
| cDescription | Caracteres | Descrição da tabela | | X | |
| bRealName | Bloco de Código | Bloco de codigo para determinar o nome da tabela no FileSystem ou no banco,o bloco
recebera o objeto da estrutura como parametro, e deve retornar o nome fisico | | X | |
GetTable
Sintaxe
FWFORMMODELSTRUCT():GetTable()-> aRetorno
Descrição
Fornece os dados da tabela da estrutura
Retorno
aRetorno Array com os seguintes dados
[01] ExpC: Alias da tabela
[02] ExpA: Array unidimensional com os campos que correspondem a primary key
[03] ExpC: ]Descrição da tabela
AddIndex
Sintaxe
FWFORMMODELSTRUCT():AddIndex(<nOrdem >, <cOrdem >, <cKey >, <cDescription >, <cLookUp >, <cNickName >, <lShow >)-> NIL
Descrição
Adiciona um indice a estrutura.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| nOrdem | Numérico | Ordem do indice | | X | |
| cOrdem | Caracteres | ID | | X | |
| cKey | Caracteres | Chave do indice | | X | |
| cDescription | Caracteres | Descrição do indice | | X | |
| cLookUp | Caracteres | Expressão de lookUp dos campos de indice | | X | |
| cNickName | Caracteres | Nickname do indice | | X | |
| lShow | Lógico | Indica se o indice pode ser utilizado pela interface
| | X | |
GetIndex
Sintaxe
FWFORMMODELSTRUCT():GetIndex()-> aRetorno
Descrição
Fornece os dados de todos os indices da estrutura
Retorno
aRetorno Array com a definição dos indices
[01] ExpN: Ordem numérica
[02] ExpC: Ordem no metadado
[03] ExpC: Chave do indice
[04] ExpC: Descrição do indice
[05] ExpC: LookUp
[06] ExpC: NickName
[07] ExpL: Show?
AddField
Sintaxe
FWFORMMODELSTRUCT():AddField(<cTitulo >, <cTooltip >, <cIdField >, <cTipo >, <nTamanho >, [ nDecimal ], [ bValid ], [ bWhen ], [ aValues ], [ lObrigat ], [ bInit ], <lKey >, [ lNoUpd ], [ lVirtual ], [ cValid ])-> NIL
Descrição
Adiciona um campo a estrutura.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| cTitulo | Caracteres | Titulo do campo | | X | |
| cTooltip | Caracteres | Tooltip do campo | | X | |
| cIdField | Caracteres | Id do Field | | X | |
| cTipo | Caracteres | Tipo do campo | | X | |
| nTamanho | Numérico | Tamanho do campo | | X | |
| nDecimal | Numérico | Decimal do campo | 0 | | |
| bValid | Bloco de Código | Bloco de código de validação do campo | {|| .T.} | | |
| bWhen | Bloco de Código | Bloco de código de validação when do campo | | | |
| aValues | Array | Lista de valores permitido do campo | {} | | |
| lObrigat | Lógico | Indica se o campo tem preenchimento obrigatório | .F. | | |
| bInit | Bloco de Código | Bloco de código de inicializacao do campo | | | |
| lKey | Lógico | Indica se trata-se de um campo chave | | X | |
| lNoUpd | Lógico | Indica se o campo não pode receber valor em uma operação de update | .F. | | |
| lVirtual | Lógico | Indica se o campo é virtual | .F. | | |
| cValid | Caracteres | Valid do usuario em formato texto e sem alteracao, usado para se criar o aheader de compatibilidade
| "" | | |
RemoveField
Sintaxe
FWFORMMODELSTRUCT():RemoveField(<cIdField >)-> NIL
Descrição
Remove um campo da estrutura.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| cIdField | Caracteres | Id do Field
| | X | |
GetFields
Sintaxe
FWFORMMODELSTRUCT():GetFields()-> aRetorno
Descrição
Retorna a coleção de campos da estrutura
Retorno
aRetorno Array com a estrutura de metadado dos campos da classe
[n] Array com os campos
[n][01] ExpC: Titulo
[n][02] ExpC: Tooltip
[n][03] ExpC: IdField
[n][04] ExpC: Tipo
[n][05] ExpN: Tamanho
[n][06] ExpN: Decimal
[n][07] ExpB: Valid
[n][08] ExpB: When
[n][09] ExpA: Lista de valores ( Combo )
[n][10] ExpL: Obrigatório
[n][11] ExpB: Inicializador padrão
[n][12] ExpL: Campo chave
[n][13] ExpL: Campo atualizavel
[n][14] ExpL: Campo virtual
[n][15] ExpC: Valid do usuario em formato texto e sem alteracao, usado para se criar o aheader de compatibilidade
AddTrigger
Sintaxe
FWFORMMODELSTRUCT():AddTrigger(<cIdField >, <cTargetIdField >, [ bPre ], <bSetValue >)-> NIL
Descrição
Adiciona um trigger a estrutura
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| cIdField | Caracteres | Id do campo de origem | | X | |
| cTargetIdField | Caracteres | Id do campo de destino | | X | |
| bPre | Bloco de Código | Bloco de codigo de validação da execução do gatilho | {|| .T.} | | |
| bSetValue | Bloco de Código | Bloco de codigo de execução do gatilho
| | X | |
GetTriggers
Sintaxe
FWFORMMODELSTRUCT():GetTriggers()-> aRetorno
Descrição
Retorna a coleção de triggers da estrutura
Retorno
aRetorno Array com a estrutura de metadado dos triggers da classe
[n]Array com os triggers
[n][01] ExpC: IdField Origem
[n][02] ExpC: IdField Alvo
[n][03] ExpB: When
[n][04] ExpB: Execução
SetProperty
Sintaxe
FWFORMMODELSTRUCT():SetProperty(<cIdField >, <nProperty >, <xValue >)-> NIL
Descrição
Troca a propriedade de um Field ou de Todos
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| cIdField | Caracteres | ID do Field( se passado * troca de todos os campos)
| | X | |
| nProperty | Numérico | Nome da Propriedade, ela pode ser(lembre-se de incluir o FWMVCDEF.CH no fonte):
MODEL_FIELD_TITULO C Titulo
MODEL_FIELD_TOOLTIP C Descrição completa do campo
MODEL_FIELD_IDFIELD C Nome (ID)
MODEL_FIELD_TIPO C Tipo
MODEL_FIELD_TAMANHO N Tamanho
MODEL_FIELD_DECIMAL N Decimais
MODEL_FIELD_VALID B Validação
MODEL_FIELD_WHEN B Modo de edição
MODEL_FIELD_VALUES A Lista de valores permitido do campo (combo)
MODEL_FIELD_OBRIGAT L Indica se o campo tem preenchimento obrigatório
MODEL_FIELD_INIT B Inicializador padrão
MODEL_FIELD_KEY L Indica se o campo é chave
MODEL_FIELD_NOUPD L Indica se o campo pode receber valor em uma operação de update.
MODEL_FIELD_VIRTUAL L Indica se o campo é virtual
| | X | |
| xValue | Qualquer | - Valor a ser atribuido
| | X | |
GetProperty
Sintaxe
FWFORMMODELSTRUCT():GetProperty(<cIdField >, <nProperty >)-> xValue
Descrição
Recupera a propriedade de um Field
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| cIdField | Caracteres | ID do Field
| | X | |
| nProperty | Numérico | Nome da Propriedade, ela pode ser(lembre-se de incluir no fonte o FWMVCDEF.CH):
MODEL_FIELD_TITULO C Titulo
MODEL_FIELD_TOOLTIP C Descrição completa do campo
MODEL_FIELD_IDFIELD C Nome (ID)
MODEL_FIELD_TIPO C Tipo
MODEL_FIELD_TAMANHO N Tamanho
MODEL_FIELD_DECIMAL N Decimais
MODEL_FIELD_VALID B Validação
MODEL_FIELD_WHEN B Modo de edição
MODEL_FIELD_VALUES A Lista de valores permitido do campo (combo)
MODEL_FIELD_OBRIGAT L Indica se o campo tem preenchimento obrigatório
MODEL_FIELD_INIT B Inicializador padrão
MODEL_FIELD_KEY L Indica se o campo é chave
MODEL_FIELD_NOUPD L Indica se o campo pode receber valor em uma operação de update.
MODEL_FIELD_VIRTUAL L Indica se o campo é virtual
| | X | |
Retorno
IsEmpty
Sintaxe
FWFORMMODELSTRUCT():IsEmpty()-> lEmpty
Descrição
Retorna se o objeto está vazio.
Retorno
lEmpty Se verdadeiro a estrutura está vazia
HasField
Sintaxe
FWFORMMODELSTRUCT():HasField(<cIdField >)-> NIL
Descrição
Informa de um determinado campo existe na estrutura
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| cIdField | Caracteres | Id do campo
| | X | |
GetArrayPos
Sintaxe
FWFORMMODELSTRUCT():GetArrayPos(<aFieldsId >)-> aPosFields
Descrição
Recebe um array com os campos que devem ser procurados e retorna
um array com a posição de cada campo na estrutura. O array de retorno
tem o mesmo tamanho que o array recebido por parametro.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| aFieldsId | Array | Array unidimensional com os IDs dos campos
| | X | |
Retorno
aPosFields Retorna um array unidimensional com a posição de cada campo na estrutura.
Exemplo
aPosFields := oStruZA2:GetArrayPos("ZA2_MUSICA", "ZA2_ITEM")
Observações
Metodo abortara o sistema caso algum campo não seja encontrado.
GetAllFieldProp
Sintaxe
FWFORMMODELSTRUCT():GetAllFieldProp(<cIdField >)-> aRet
Descrição
Retorna todas propriedades de uma campo especifco.É necessario que
que chamar este metodo limpe o retorno do mesmo com aSize, pois
esse metodo faz aclone do mesmo.
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| cIdField | Caracteres | ID do Campo | | X | |
Retorno
aRet Copia de todas as propriedades do campo
FieldsLength
Sintaxe
FWFORMMODELSTRUCT():FieldsLength()->
Descrição
Retorna a quantidade de campos na estrutura.
Retorno
getLogicTableName
Sintaxe
FWFORMMODELSTRUCT():getLogicTableName()-> NIL
Descrição
Retorna o nome fisico da tabela
GetFieldPos
Sintaxe
FWFORMMODELSTRUCT():GetFieldPos(<cIdField >)->
Descrição
Retorna a posição na estrutura de um Campo
Parâmetros
| Nome | Tipo | Descrição | Default | Obrigatório | Referência |
|
| cIdField | Caracteres | Id do campo | | X | |
Retorno
