Métodos y eventos del esquema de recetas

Métodos y eventos del esquema de recetas, incluidos sus parámetros y resultados.

Métodos

Las siguientes tablas describen los métodos y los parámetros relacionados:
Método disponible desde el IDE y a través de la API de C#
Método
Argumentos de entrada
Argumentos de salida
CreateRecipe
Crea una nueva receta en el almacén.
  • RecipeId [RecipeId]
  • Result [CreateRecipeResultCode]
    • Correcto: la receta se ha creado correctamente
    • FaltaIDDeReceta: se ha llamado al método con un IDDeReceta vacío
    • LaRecetaYaExiste: ya existe una receta con el mismo nombre y versión
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • Error: se ha producido un error
DuplicateRecipe
Duplica una receta existente con un nuevo identificador.
  • RecipeId [RecipeId]
  • NewRecipeId [RecipeId]
  • Result [DuplicateRecipeResultCode]
    • Correcto: la receta se ha duplicado correctamente
    • ErrorGenérico: se ha producido un error general durante la duplicación de recetas
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NombreDeRecetaDeOrigenInesperadamenteVacío: el nombre de la receta de origen proporcionado está vacío o es nulo
    • NombreDeRecetaDeDestinoInesperadamenteVacío: el nombre de la receta de destino proporcionado está vacío o es nulo
    • LaRecetaDeOrigenNoExiste: no se ha encontrado la receta de origen en el almacén
    • LaRecetaDeDestinoYaExiste: ya existe una receta con el nombre de destino
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la duplicación de recetas
RenameRecipe
Cambia el nombre de una receta existente.
  • RecipeId [RecipeId]
  • NewName [String]
  • Result [RenameRecipeResultCode]
    • Correcto: la receta se ha renombrado correctamente
    • ErrorGenérico: se ha producido un error general al renombrar la receta
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • LaRecetaDeOrigenNoExiste: no se ha encontrado la receta de origen en el almacén
    • LaRecetaDeDestinoYaExiste: ya existe una receta con el nombre de destino
DeleteRecipe
Elimina una receta existente del almacén.
  • RecipeId [RecipeId]
  • Result [DeleteRecipeResultCode]
    • Correcto: la receta se ha eliminado correctamente
    • ErrorGenérico: se ha producido un error general al eliminar la receta
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • LaRecetaNoExiste: no se ha encontrado la receta especificada en el almacén
Refactorizar
Realiza una operación de refactorización de forma asíncrona.
  • Ninguno
Ninguno. Este es el único método asíncrono. Cuando se complete la operación, se distribuirá un evento (RefactorizaciónCompletada).
GetDataItems
Recupera elementos de datos asociados a una receta.
  • RecipeId [RecipeId]
  • Result [GetDataItemsResultCode]
    • Correcto: los elementos de datos se han recuperado correctamente
    • RecetaNoEncontrada: la receta especificada no se ha encontrado en el almacén
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • ErrorGenérico: se ha producido un error general al recuperar los elementos de datos
SetRecipeDataItemValue
Establece el valor de un elemento de datos específico en una receta.
  • RecipeId [RecipeId]
  • ItemRelativeBrowsePath [String]
  • DataItemRelativeBrowsePath [String]
  • ElementAccess [ElementAccess]
  • Value [BaseDataType]
  • Result [SetRecipeDataItemValueResultCode]
    • Correcto: el valor del elemento de datos de receta se ha establecido correctamente
    • ErrorGenérico: se ha producido un error general al establecer el valor del elemento de datos
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • ElementoDeDatosNoEncontrado: no se ha encontrado el elemento de datos especificado en la receta
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • RecetaNoEncontrada: la receta especificada no se ha encontrado en el almacén
SetRecipeMetadataValue
Establece el valor de un campo de metadatos específico en una receta.
  • RecipeId [RecipeId]
  • MetadataName [String]
  • Value [BaseDataType]
  • Result [SetRecipeMetadataValueResultCode]
    • Correcto: el valor de metadatos de la receta se ha establecido correctamente
    • ErrorGenérico: se ha producido un error general al establecer el valor de los metadatos
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • RecetaNoEncontrada: la receta especificada no se ha encontrado en el almacén
    • MetadatosNoEncontrados: no se ha encontrado el campo de metadatos especificado en la receta
TransferFromEditModelToStore
Transfiere una receta del modelo de edición al almacén.
  • RequesterNodeId [NodeId]
  • RecipeId [RecipeId]
  • Result [TransferFromEditModelToStoreResultCode]
    • CorrectoRecetaCreada: la receta se ha creado y transferido correctamente del modelo de edición al almacén
    • CorrectoRecetaActualizada: la receta se ha actualizado correctamente y transferido del modelo de edición al almacén
    • ErrorGenérico: se ha producido un error general durante la transferencia del modelo de edición al almacén
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NodoSolicitanteNoEncontrado: no se ha encontrado el nodo solicitante
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la transferencia
    • NodoDelModeloDeEdiciónNoEncontrado: no se ha encontrado el nodo del modelo de edición
TransferFromEditModelToTarget
Transfiere una receta del modelo de edición a un nodo de destino.
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromEditModelToTargetResultCode]
    • Correcto: la receta se ha transferido correctamente del modelo de edición al destino
    • ErrorGenérico: se ha producido un error general durante la transferencia del modelo de edición al destino
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NodoSolicitanteNoEncontrado: no se ha encontrado el nodo solicitante
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la transferencia
    • NodoDelModeloDeEdiciónNoEncontrado: no se ha encontrado el nodo del modelo de edición
    • FaltaDeCoincidenciaEnLosDatos: hay una desigualdad entre los datos del modelo de edición y la estructura de destino
TransferFromStoreToEditModel
Transfiere una receta del almacén al modelo de edición.
  • RequesterNodeId [NodeId]
  • RecipeId [RecipeId]
  • Result [TransferFromEditModelToTargetResultCode]
    • Correcto: la receta se ha transferido correctamente del modelo de edición al destino
    • ErrorGenérico: se ha producido un error general durante la transferencia del modelo de edición al destino
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NodoSolicitanteNoEncontrado: no se ha encontrado el nodo solicitante
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la transferencia
    • NodoDelModeloDeEdiciónNoEncontrado: no se ha encontrado el nodo del modelo de edición
    • FaltaDeCoincidenciaEnLosDatos: hay una desigualdad entre los datos del modelo de edición y la estructura de destino
TransferFromStoreToTarget
Transfiere una receta del almacén a un nodo de destino.
  • RecipeId [RecipeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromStoreToTargetResultCode]
    • Correcto: la receta se ha transferido correctamente del almacén al destino
    • ErrorGenérico: se ha producido un error general durante la transferencia del almacén al destino
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • RecetaNoEncontrada: la receta especificada no se ha encontrado en el almacén
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la transferencia
    • FaltaDeCoincidenciaEnLosDatos: los datos de la receta y la estructura de destino no coinciden
TransferFromTargetToEditModel
Transfiere una receta desde un nodo de destino al modelo de edición.
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromTargetToEditModelResultCode]
    • Correcto: la receta se ha transferido correctamente del destino al modelo de edición
    • ErrorGenérico: se ha producido un error general durante la transferencia del destino al modelo de edición
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NodoSolicitanteNoEncontrado: no se ha encontrado el nodo solicitante
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la transferencia
    • NodoDelModeloDeEdiciónNoEncontrado: no se ha encontrado el nodo del modelo de edición
    • FaltaDeCoincidenciaEnLosDatos: hay una desigualdad entre los datos de destino y la estructura del modelo de edición
TransferFromTargetToStore
Transfiere una receta desde un nodo de destino al almacén.
  • RecipeId [RecipeId]
  • TargetNodeId [NodeId]
  • Overwrite [Bool]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromTargetToStoreResultCode]
    • CorrectoRecetaCreada: la receta se ha creado y transferido correctamente del destino al almacén
    • CorrectoRecetaActualizada: la receta se ha actualizado correctamente y se ha transferido del destino al almacén
    • ErrorGenérico: se ha producido un error general durante la transferencia del destino al almacén
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén (por ejemplo, error de base de datos)
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • LaRecetaYaExiste: ya existe una receta con el mismo nombre en el almacén
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la transferencia
    • FaltaDeCoincidenciaEnLosDatos: hay una desigualdad entre los datos de destino y la estructura del almacén
Métodos disponibles solo a través de la API de C#
Método
Argumentos de entrada
Argumentos de salida
GetRecipes
Recupera una lista de todas las recetas del almacén.
Sin argumentos de entrada
  • Result [GetRecipesResult] (Array)
    • Correcto: las recetas se han recuperado con éxito
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • ErrorGenérico: se ha producido un error general al recuperar las recetas
GetRecipeMetadataValue
Recupera el valor de un campo de metadatos específico en una receta.
  • RecipeId [RecipeId]
  • MetadataName [String]
  • Result [GetRecipeMetadataValueResult]
    • Correcto: el valor de metadatos de la receta se ha recuperado correctamente
    • ErrorGenérico: se ha producido un error general al recuperar el valor de los metadatos
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • RecetaNoEncontrada: la receta especificada no se ha encontrado en el almacén
    • MetadatosNoEncontrados: no se ha encontrado el campo de metadatos especificado en la receta
GetRecipeMetadataValues
Recupera todos los valores de metadatos asociados a una receta.
RecipeId [RecipeId]
  • Result [GetRecipeMetadataValuesResult]
    • Correcto: los valores de metadatos de la receta se han recuperado correctamente
    • ErrorGenérico: se ha producido un error general al recuperar los valores de los metadatos
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • RecetaNoEncontrada: la receta especificada no se ha encontrado en el almacén
GetRecipeDataItemValue
Recupera el valor de un elemento de datos específico en una receta.
  • RecipeId [RecipeId]
  • ItemRelativeBrowsePath [String] (Array)
  • DataItemRelativeBrowsePath [String] (Array)
  • ElementAccess [ElementAccess]
  • Result [GetRecipeDataItemValueResult]
    • Correcto: el valor del elemento de datos de la receta se ha recuperado correctamente
    • ErrorGenérico: se ha producido un error general al recuperar el valor del elemento de datos
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • ElementoDeDatosNoEncontrado: no se ha encontrado el elemento de datos especificado en la receta
    • NombreDeRecetaInesperadamenteVacío: el nombre de la receta proporcionado está vacío o es nulo
    • RecetaNoEncontrada: la receta especificada no se ha encontrado en el almacén
CreateEditModel
Crea un modelo de edición para una receta.
  • ParentNodeId [NodeId]
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • RecipeId [RecipeId]
  • Result [CreateEditModelResultCode]
    • Correcto: el modelo de edición se ha creado correctamente
    • ErrorGenérico: se ha producido un error general al crear el modelo de edición
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • NodoPrimarioNoEncontrado: no se ha encontrado el nodo primario para el modelo de edición
    • NodoSolicitanteNoEncontrado: no se ha encontrado el nodo solicitante
TransferFromStores
Transfiere una receta del almacén a un nodo de destino.
RecipeId [RecipeId]
  • Result [TransferFromStoreResultCode]
    • Correcto: la receta se ha transferido correctamente desde el almacén
    • ErrorGenérico: se ha producido un error general durante la transferencia desde el almacén
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • RecetaNoEncontrada: la receta especificada no se ha encontrado en el almacén
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la transferencia
TransferToStore
Transfiere una receta al almacén.
  • RecipeId [RecipeId]
  • Result [TransferToStoreResultCode]
    • Correcto: la receta se ha transferido correctamente al almacén
    • ErrorGenérico: se ha producido un error general durante la transferencia al almacén
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
TransferirAlDestino
Transfiere una receta a un nodo de destino.
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • Result [TransferToTargetResultCode]
    • Correcto: la receta se ha transferido correctamente al destino
    • ErrorGenérico: se ha producido un error general durante la transferencia al destino
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la transferencia
    • FaltaDeCoincidenciaEnLosDatos: los datos de la receta y la estructura de destino no coinciden
TransferFromTarget
Transfiere una receta desde un nodo de destino al almacén.
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • Result [TransferFromTargetResultCode]
    • Correcto: la receta se ha transferido desde el destino correctamente
    • ErrorGenérico: se ha producido un error general durante la transferencia desde el destino
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • DestinoNoEncontrado: no se ha encontrado el nodo de destino para la transferencia
    • FaltaDeCoincidenciaEnLosDatos: existe una discrepancia entre los datos de destino y la estructura de la receta
SetDataItemValue
Establece el valor de un elemento de datos específico.
  • ItemId [NodeId]
  • DataItemRelativeBrowsePath [String] (Array)
  • ElementAccess [ElementAccess]
  • DataTypeId [NodeId]
  • Value [BaseDataType]
  • Result [SetDataItemValueResultCode]
    • Correcto: el valor del elemento de datos se ha establecido correctamente
    • ErrorGenérico: se ha producido un error general al establecer el valor del elemento de datos
    • ErrorDeAlmacenamiento: se ha producido un error al acceder al almacén
    • ElementoDeDatosNoEncontrado: no se ha encontrado el elemento de datos especificado

Eventos

El esquema de receta incluye los siguientes eventos:
Refactorización completada
Se activa cuando se completa el método Refactorización.
Evento de aplicación de receta
Se activa cuando se completan TransferFromStoreToTarget o TransferEditModelToTarget.
Entregue su opinión
¿Tiene dudas o comentarios acerca de esta documentación? Por favor deje su opinión aquí.
Normal