Studio 1.7.0

Runtime 2.8.0

REDY Pilot 1.0.0

Sommaire

Fournisseur d’instruction

Cet acteur permet de créer une source de curseur instructions pour le pilote REDY. Il consomme un curseur d’instruction, demande son exécution au pilote REDY suivant des éventuels paramètres, et fournit les résultats dans son champ de données data.

🔧 propriété · ℹ️ information · ⚙️ méthode · ⚡ évènement · 🔒 lecture seule

Propriétés

Auto rafraîchissement

this.properties.autoRefresh · boolean · défaut false

Auto rafraîchissement activé?

Si activé, l’instruction est automatiquement relancée à intervalle régulier.

Délai rafraîchissement

this.properties.autoRefreshDelay · number · défaut 30

Délai en seconde de rafraîchissement.

Le délai en secondes entre chaque rafraîchissement automatique de l’instruction.

Instruction SQL

this.properties.label · string ou null · défaut null

Le curseur d’instruction SQL à exécuter par le pilote REDY.

Mode

this.properties.mode · 'auto' | 'manual' · défaut 'manual'

Mode de requête de la donnée.

  • auto : Récupération de la donnée à l’initialisation et possibilité de rafraîchir automatiquement,
  • manual: Les requêtes doivent être commandées par script avec la méthode request() ou requestDebounce().

Le mode d’exécution de l’instruction.

  • Automatique : l’instruction est exécutée automatiquement à chaque modification des paramètres.
  • Manuel : l’instruction n’est exécutée que lorsque la fonction refresh ou request est déclenchée.

Paramètres de l’instruction

Si le curseur d’instruction SQL utilise des paramètres, Studio propose de créer des additionnels pour les fournir.

Informations

Accessibles par script, via this dans un script de l’acteur ou context.getActor('clé') depuis un autre acteur.

autoRefreshing

this.autoRefreshing · 🔒 lecture seule · Boolean

Indique si le rafraîchissement automatique est actif.

cursor

this.cursor · 🔒 lecture seule · Object ou null

Curseur défini dans le REDY (null avant la première requête).

data

this.data · any

Obtient ou définit la donnée exposée.

error

this.error · 🔒 lecture seule · String ou null

Erreur de requête.

hasError

this.hasError · 🔒 lecture seule · Boolean

Indique s’il y a eu une erreur de requête.

isFirstRequestDone

this.isFirstRequestDone · 🔒 lecture seule · boolean

Indique si la première requête a été faite.

isRequesting

this.isRequesting · 🔒 lecture seule · Boolean

Indique si la requête est en cours.

isValorized

this.isValorized · 🔒 lecture seule · boolean

Indique si la donnée a été valorisée.

lastRequestDate

this.lastRequestDate · 🔒 lecture seule · String ou null

Date de la dernière requête (ISO 8601), null avant la première.

totalRows

this.totalRows · 🔒 lecture seule · number

Nombre total de lignes du résultat (data.totalRows), 0 sans donnée.

Méthodes

getParameters()

this.getParameters() · renvoie Object

Paramètres envoyés au curseur : les additionnelles de l’acteur qui portent le nom d’un paramètre du curseur, converties en texte ('1' ou '0' pour un booléen).

refresh()

this.refresh()

Effectue un rafraîchissement de la donnée.

request()

this.request() · renvoie Promise<Any>

Effectue une requête.

requestDebounce()

this.requestDebounce() · renvoie Promise<any>

Effectue une requête retardée. Si une requête est déjà en cours, elle part à sa fin.

Événements

Les évènements communs à tous les acteurs sont décrits avec l’acteur de base.

onDidGetCursor

Se produit lorsque le curseur a été récupéré du REDY, avant son exécution.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
cursor Object ou null Le curseur
parameters Object Les paramètres envoyés au curseur

onRequestDone

Se produit lorsque la requête s’est terminée.

context : contexte d’évènement, avec en plus :

Membre de context Type Description
error String ou Object ou null Une erreur éventuelle
data any La donnée

Événement déclenché lorsque l’instruction est terminée et que les résultats sont disponibles.

Dans data, vous trouverez un objet avec les propriétés suivantes :

Propriété Type Description
totalRows Nombre Le nombre total de lignes impactées

En cas d’erreur, un champ error est présent dans l’objet de contexte avec les informations de l’erreur.

Hérite de

Outre ce qui est décrit ici, l’acteur a tout ce que décrit l’acteur de base : propriétés communes (taille, disposition, aspect, texte, bordures, effets…), évènements communs (cycle de vie, souris, clavier…) et membres accessibles par script.

Il hérite aussi de :

  • DataSource : Classe de base pour fournisseur de donnée. Permet de paramétrer les requêtes et d’exposer une donnée pour des liaisons ou accessible par script.
  • Requesterable (comportement) : Attribut la possibilité à un acteur de réaliser des requêtes.