Objeto oSchema Serão feitos tratamentos internos neste objeto. Ele possui apenas dois métodos para uso externo, usados em conjunto com os métodos da nova classe, sendo eles: Método AliasToSchema() - Método do objeto oSchema que transforma o alias em um schema, caso seja utilizado apenas o primeiro parâmetro todos os campos serão enviados. | Informações |
|---|
| Ao utilizar o método aliasToSchema, o Id da propriedade é o nome do campo na tabela, ex. A1_NOME |
Parâmetros: | Nome | Tipo | Obrigatório | Default | Descrição |
|---|
| cAlias | Caracter | X |
| Alias/WorkArea que será utilizado | | xField | Variante |
| Nil | Contém os campos que serão utilizado no schema, podendo ser caracter ou array. |
Método AddProperty() - Método do objeto oSchema que adiciona uma propriedade ao schema. Parâmetros: | Nome | Tipo | Obrigatório | Default | Descrição |
|---|
| cId | Caractere | X |
| ID da propriedade (Não pode conter símbolos ou caracteres especiais, exceto _ (underline)) Obs.: pode ser preenchido com o nome do campo: ex: A2_COD | | cDescription | Caractere | X |
| Descrição da propriedade | | cType | Caractere | X |
| Tipo da propriedade (A partir da LIB Label 20230403 será aceito o tipo 'memo') Tipos aceitos: string, number, boolean, date e memo | | cDisplayName | Caractere | X |
| Nome de exibição da propriedade | | cRealName | Caractere | X |
| Nome da propriedade no Protheus (Nome real do campo da tabela), caso seja um campo 'manual' enviar o mesmo valor do cId | cComboValues (Disponível a partir da LIB Label 20220321) | Caractere |
| Ao ser utilizado o método self:setIsCBoxLookup() documentado abaixo, com o segundo parâmetro igual a .T., o cComboValues receberá o valor do combobox do campo a partir da SX3 (Utilizado em filtros/parâmetros criados a partir de um campo) | Valores do key-label (Formato igual ao combobox da SX3, ex.: "D MG 01=Filial BH" separado por ; caso tenha mais de uma opção) | lIsRequired (Disponível a partir da LIB Label 20220321) | Lógico |
| .F. | Indica que será obrigatório informar um valor para o campo | cRenameField (Disponível a partir da LIB Label 20220905) | Caractere |
|
| Indica um apelido para o campo (utilizado quando a query contém campos repetidos) | | lCanFilter (Disponível a partir da LIB Label 20230626) | Lógico |
| .T. | Indica se o campo pode ser filtrado |
Exemplos de uso estarão abaixo nos métodos criados para a classe IntegratedProvider. Obs: O nome real é necessário para que o filtro seja feito com base no nome real do campo, caso contrário, o mesmo levará em consideração a propriedade name.
Método AddParameter() - Método do objeto oSchema que adiciona um parâmetro ao objeto de negócio. | Informações |
|---|
Disponível a partir da LIB Label 20230515 |
Parâmetros: | Nome | Tipo | Obrigatório | Default | Descrição |
|---|
| cId | Caractere | X |
| ID da propriedade (Não pode conter símbolos ou caracteres especiais) | | cDisplayName | Caractere | X |
| Nome de exibição da propriedade | | cType | Caractere | X |
| Tipo da propriedade (Tipos aceitos: string, number, boolean e date) | | lIsMultiValue | Lógico |
| .F. | Indica se aceita múltiplos valores | | cUrl | Caractere |
|
| Indica o path da url personalizada que servirá para consulta | | lHasOptions | Lógico |
| .F. | Indica se tem options (combo) | | lHasLookUp | Lógico |
| .F. | Indica se tem a consulta (lookup) | | cIdConsult | Caractere |
|
| Id para identificação da consulta | | cParamId (Disponível a partir da LIB Label 20241125) | Caractere |
|
| Id do parâmetro | | cDescription (Disponível a partir da LIB Label 20241125) | Caractere |
|
| Descrição do parâmetro (help) | | lAllowNull (Disponível a partir da LIB Label 20241125) | Lógico |
| .T. | Indica se o valor pode ser nulo | | aDefaultValues (Disponível a partir da LIB Label 20241125) | Array |
|
| Valores default do parâmetro | | nMaxLength InputMaxLength (Disponível a partir da LIB Label 20241125) | Numérico |
| 150 | Valor máximo do parâmetro | | lVisible (Disponível a partir da LIB Label 20241125) | Lógico |
| .T. | Indica se é visível ou não |
Exemplos de uso:| Bloco de código |
|---|
self:addParameter("Xisto_LookUp_Url", "Xpto", "string", .T., "api/smartview/xisto",,.T.,"SA2") //Parâmetro com consulta lookup personalizada (api)
self:addParameter("Xisto_Combo", "Xpto", "string", .T., "", .T.,,"MTR110", "MV_PAR01") //Parâmetro com consulta combo usando a SX1 |
Para mais informações sobre consultas personalizadas, acessar a documentação completa: Smart View - Lookup e Combo nos parâmetros nativos | 