Méthodes et événements du schéma de recette

Méthodes et événements du schéma de recette, y compris leurs paramètres et leurs résultats.

Méthodes

Les tableaux suivants décrivent les méthodes et les paramètres associés :
Méthode disponible depuis l’IDE et via l’API C#
Méthode
Arguments d’entrée
Arguments de sortie
CreateRecipe
Crée une nouvelle recette dans le stockage.
  • RecipeId [RecipeId]
  • Result [CreateRecipeResultCode]
    • Réussite : la recette a bien été créée
    • IDDeRecetteManquant : la méthode a été appelée avec un IDDeRecette vide
    • LaRecetteExisteDéjà : une recette avec le même nom et la même version existe déjà
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • Erreur : une erreur s'est produite
DuplicateRecipe
Duplique une recette existante avec un nouvel identifiant.
  • RecipeId [RecipeId]
  • NewRecipeId [RecipeId]
  • Result [DuplicateRecipeResultCode]
    • Réussite : la recette a bien été dupliquée
    • ErreurGénérique : une erreur générale s’est produite lors de la duplication de la recette
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NomDeRecetteSourceVideInattendu : le nom de la recette source fournie est vide ou nul
    • NomDeRecetteCibleVideInattendu : le nom de la recette cible fournie est vide ou nul
    • LaRecetteSourceNExistePas : la recette source est introuvable dans le stockage
    • LaRecetteCibleExisteDéjà : une recette portant le nom cible existe déjà
    • CibleIntrouvable : le nœud cible pour la duplication de la recette est introuvable
RenameRecipe
Renomme une recette existante.
  • RecipeId [RecipeId]
  • NewName [String]
  • Result [RenameRecipeResultCode]
    • Réussite : la recette a bien été renommée
    • ErreurGénérique : une erreur générale s’est produite lors du renommage de la recette
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • LaRecetteSourceNExistePas : la recette source est introuvable dans le stockage
    • LaRecetteCibleExisteDéjà : une recette portant le nom cible existe déjà
DeleteRecipe
Supprime une recette existante du stockage.
  • RecipeId [RecipeId]
  • Result [DeleteRecipeResultCode]
    • Réussite : la recette a bien été supprimée
    • ErreurGénérique : une erreur générale s’est produite lors de la suppression d’une recette
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • LaRecetteNExistePas : la recette spécifiée est introuvable dans le stockage
Refactoriser
Effectue une opération de refactorisation de manière asynchrone.
  • Aucun
Aucun. Il s’agit de la seule méthode asynchrone. Lorsque l’opération est terminée, un événement (RefactorisationTerminée) est déclenché.
GetDataItems
Récupère les éléments de données associés à une recette.
  • RecipeId [RecipeId]
  • Result [GetDataItemsResultCode]
    • Réussite : les éléments de données ont été récupérés avec succès
    • RecetteIntrouvable : la recette spécifiée est introuvable dans le stockage
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • ErreurGénérique : une erreur générale s’est produite lors de la récupération des éléments de données
SetRecipeDataItemValue
Définit la valeur d’un élément de données spécifique dans une recette.
  • RecipeId [RecipeId]
  • ItemRelativeBrowsePath [String]
  • DataItemRelativeBrowsePath [String]
  • ElementAccess [ElementAccess]
  • Value [BaseDataType]
  • Result [SetRecipeDataItemValueResultCode]
    • Réussite : la valeur de l’élément de données de recette a bien été définie
    • ErreurGénérique : une erreur générale s’est produite lors de la définition de la valeur de l’élément de données
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • ÉlémentDeDonnéesIntrouvable : l’élément de données spécifié est introuvable dans la recette
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • RecetteIntrouvable : la recette spécifiée est introuvable dans le stockage
SetRecipeMetadataValue
Définit la valeur d’un champ de métadonnées spécifique dans une recette.
  • RecipeId [RecipeId]
  • MetadataName [String]
  • Value [BaseDataType]
  • Result [SetRecipeMetadataValueResultCode]
    • Réussite : la valeur des métadonnées de recette a été définie avec succès
    • ErreurGénérique : une erreur générale s’est produite lors de la définition de la valeur des métadonnées
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • RecetteIntrouvable : la recette spécifiée est introuvable dans le stockage
    • MétadonnéesIntrouvables : le champ de métadonnées spécifié est introuvable dans la recette
TransferFromEditModelToStore
Transfère une recette du modèle d’édition vers le stockage.
  • RequesterNodeId [NodeId]
  • RecipeId [RecipeId]
  • Result [TransferFromEditModelToStoreResultCode]
    • RéussiteRecetteCréée : la recette a été créée et transférée du modèle d’édition vers le stockage avec succès
    • RéussiteRecetteMiseÀJour : la recette a été mise à jour et transférée du modèle d’édition vers le stockage avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert du modèle d’édition vers le stockage
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NœudDuDemandeurIntrouvable : le nœud du demandeur est introuvable
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • CibleIntrouvable : le nœud cible pour le transfert est introuvable
    • NœudDuModèleDÉditionIntrouvable : le nœud du modèle d’édition est introuvable
TransferFromEditModelToTarget
Transfère une recette du modèle d’édition vers un nœud cible.
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromEditModelToTargetResultCode]
    • Réussite : la recette a été transférée du modèle d’édition vers la cible avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert du modèle d’édition vers la cible
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NœudDuDemandeurIntrouvable : le nœud du demandeur est introuvable
    • CibleIntrouvable : le nœud cible pour le transfert est introuvable
    • NœudDuModèleDÉditionIntrouvable : le nœud du modèle d’édition est introuvable
    • DiscordanceDeDonnées : il existe une discordance entre les données du modèle d’édition et la structure cible
TransferFromStoreToEditModel
Transfère une recette du stockage vers le modèle d’édition.
  • RequesterNodeId [NodeId]
  • RecipeId [RecipeId]
  • Result [TransferFromEditModelToTargetResultCode]
    • Réussite : la recette a été transférée du modèle d’édition vers la cible avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert du modèle d’édition vers la cible
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NœudDuDemandeurIntrouvable : le nœud du demandeur est introuvable
    • CibleIntrouvable : le nœud cible pour le transfert est introuvable
    • NœudDuModèleDÉditionIntrouvable : le nœud du modèle d’édition est introuvable
    • DiscordanceDeDonnées : il existe une discordance entre les données du modèle d’édition et la structure cible
TransferFromStoreToTarget
Transfère une recette du stockage vers un nœud cible.
  • RecipeId [RecipeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromStoreToTargetResultCode]
    • Réussite : la recette a été transférée du stockage vers la cible avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert du stockage vers la cible
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • RecetteIntrouvable : la recette spécifiée est introuvable dans le stockage
    • CibleIntrouvable : le nœud cible pour le transfert est introuvable
    • DiscordanceDeDonnées : il existe une discordance entre les données de la recette et la structure cible
TransferFromTargetToEditModel
Transfère une recette d'un nœud cible vers le modèle d’édition.
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromTargetToEditModelResultCode]
    • Réussite : la recette a été transférée de la cible vers le modèle d’édition avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert de la cible vers le modèle d’édition
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NœudDuDemandeurIntrouvable : le nœud du demandeur est introuvable
    • CibleIntrouvable : le nœud cible pour le transfert est introuvable
    • NœudDuModèleDÉditionIntrouvable : le nœud du modèle d’édition est introuvable
    • DiscordanceDeDonnées : il existe une discordance entre les données cibles et la structure du modèle d’édition
TransferFromTargetToStore
Transfère une recette d'un nœud cible vers le stockage.
  • RecipeId [RecipeId]
  • TargetNodeId [NodeId]
  • Overwrite [Bool]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromTargetToStoreResultCode]
    • RéussiteRecetteCréée : la recette a été créée et transférée de la cible vers le stockage avec succès
    • RéussiteRecetteMiseÀJour : la recette a été mise à jour et transférée de la cible vers le stockage avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert de la cible vers le stockage
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage (par ex., erreur de base de données)
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • LaRecetteExisteDéjà : une recette du même nom existe déjà dans le stockage
    • CibleIntrouvable : le nœud cible pour le transfert est introuvable
    • DiscordanceDeDonnées : il existe une discordance entre les données cibles et la structure du stockage
Méthodes disponibles uniquement via l’API C#
Méthode
Arguments d’entrée
Arguments de sortie
GetRecipes
Récupère la liste de toutes les recettes du stockage.
Aucun argument d’entrée
  • Result [GetRecipesResult] (Array)
    • Réussite : les recettes ont été récupérées avec succès
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • ErreurGénérique : une erreur générale s’est produite lors de la récupération des recettes
GetRecipeMetadataValue
Récupère la valeur d’un champ de métadonnées spécifique dans une recette.
  • RecipeId [RecipeId]
  • MetadataName [String]
  • Result [GetRecipeMetadataValueResult]
    • Réussite : la valeur des métadonnées de la recette a été récupérée avec succès
    • ErreurGénérique : une erreur générale s’est produite lors de la récupération de la valeur des métadonnées
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • RecetteIntrouvable : la recette spécifiée est introuvable dans le stockage
    • MétadonnéesIntrouvables : le champ de métadonnées spécifié est introuvable dans la recette
GetRecipeMetadataValues
Récupère toutes les valeurs de métadonnées associées à une recette.
RecipeId [RecipeId]
  • Result [GetRecipeMetadataValuesResult]
    • Réussite : les valeurs des métadonnées de la recette ont été récupérées avec succès
    • ErreurGénérique : une erreur générale s’est produite lors de la récupération des valeurs des métadonnées
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • RecetteIntrouvable : la recette spécifiée est introuvable dans le stockage
GetRecipeDataItemValue
Récupère la valeur d’un élément de données spécifique dans une recette.
  • RecipeId [RecipeId]
  • ItemRelativeBrowsePath [String] (Array)
  • DataItemRelativeBrowsePath [String] (Array)
  • ElementAccess [ElementAccess]
  • Result [GetRecipeDataItemValueResult]
    • Réussite : la valeur de l’élément de données de recette a été récupérée avec succès
    • ErreurGénérique : une erreur générale s’est produite lors de la récupération de la valeur de l’élément de données
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • ÉlémentDeDonnéesIntrouvable : l’élément de données spécifié est introuvable dans la recette
    • NomDeRecetteVideInattendu : le nom de la recette fourni est vide ou nul
    • RecetteIntrouvable : la recette spécifiée est introuvable dans le stockage
CreateEditModel
Crée un modèle d’édition pour une recette.
  • ParentNodeId [NodeId]
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • RecipeId [RecipeId]
  • Result [CreateEditModelResultCode]
    • Réussite : le modèle d’édition a bien été créé
    • ErreurGénérique : une erreur générale s’est produite lors de la création du modèle d’édition
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • NœudParentIntrouvable : le nœud parent du modèle d’édition est introuvable
    • NœudDuDemandeurIntrouvable : le nœud du demandeur est introuvable
TransferFromStores
Transfère une recette du stockage vers un nœud cible.
RecipeId [RecipeId]
  • Result [TransferFromStoreResultCode]
    • Réussite : la recette a été transférée du stockage avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert depuis le stockage
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • RecetteIntrouvable : la recette spécifiée est introuvable dans le stockage
    • CibleIntrouvable : le nœud cible pour le transfert est introuvable
TransferToStore
Transfère une recette vers le stockage.
  • RecipeId [RecipeId]
  • Result [TransferToStoreResultCode]
    • Réussite : la recette a été transférée vers le stockage avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert vers le stockage
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
TransférerVersLaCible
Transfère une recette vers un nœud cible.
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • Result [TransferToTargetResultCode]
    • Réussite : la recette a été transférée vers la cible avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert vers la cible
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • CibleIntrouvable : le nœud cible pour le transfert est introuvable
    • DiscordanceDeDonnées : il existe une discordance entre les données de la recette et la structure cible
TransferFromTarget
Transfère une recette d'un nœud cible vers le stockage.
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • Result [TransferFromTargetResultCode]
    • Réussite : la recette a été transférée depuis la cible avec succès
    • ErreurGénérique : une erreur générale s’est produite lors du transfert depuis la cible
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • CibleIntrouvable : le nœud cible pour le transfert est introuvable
    • DiscordanceDeDonnées : il existe une discordance entre les données cibles et la structure de la recette
SetDataItemValue
Définit la valeur d’un élément de données spécifique.
  • ItemId [NodeId]
  • DataItemRelativeBrowsePath [String] (Array)
  • ElementAccess [ElementAccess]
  • DataTypeId [NodeId]
  • Value [BaseDataType]
  • Result [SetDataItemValueResultCode]
    • Réussite : la valeur de l’élément de données a bien été définie
    • ErreurGénérique : une erreur générale s’est produite lors de la définition de la valeur de l’élément de données
    • ErreurDeStockage : une erreur s’est produite lors de l’accès au stockage
    • ÉlémentDeDonnéesIntrouvable : l’élément de données spécifié est introuvable

Événements

Le schéma de recette comprend les événements suivants :
Refactorisation terminée
Déclenché lorsque la méthode Refactoriser est terminée.
Événement d’application de recette
Déclenché lorsque TransferFromStoreToTarget ou TransferEditModelToTarget sont terminés.
Fournir une réponse
Vous avez des questions ou des commentaires sur cette documentation ? Veuillez envoyer vos commentaires ici.
Normal