Métodos e eventos no esquema de receita

Métodos e eventos no esquema de receita, incluindo seus parâmetros e resultados.

Métodos

As tabelas a seguir descrevem métodos e parâmetros relacionados:

Método disponível no IDE e por meio da API C#
Método	Argumentos de entrada	Argumentos de saída
CreateRecipe Cria uma nova receita no repositório.	RecipeId [RecipeId]	Result [CreateRecipeResultCode] Sucesso: a receita foi criada com sucesso IDDaReceitaAusente: o método foi chamado com um IDDaReceita vazio AReceitaJáExiste: uma receita com o mesmo nome e versão já existe ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento Erro: ocorreu um erro
DuplicateRecipe Duplica uma receita existente com um novo identificador.	RecipeId [RecipeId] NewRecipeId [RecipeId]	Result [DuplicateRecipeResultCode] Sucesso: a receita foi duplicada com sucesso ErroGenérico: ocorreu um erro geral durante a duplicação de receitas ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NomeDeReceitaDeOrigemVazioInesperado: o nome de receita de origem fornecido está vazio ou nulo NomeDeReceitaDeDestinoVazioInesperado: o nome de receita de destino fornecido está vazio ou nulo ReceitaDeOrigemNãoExiste: a receita de origem não foi encontrada no armazenamento ReceitaDeDestinoJáExiste: já existe uma receita com o nome de destino DestinoNãoEncontrado: o nó de destino para duplicação de receita não foi encontrado
RenameRecipe Renomeia uma receita existente.	RecipeId [RecipeId] NewName [String]	Result [RenameRecipeResultCode] Sucesso: a receita foi renomeada com sucesso ErroGenérico: ocorreu um erro geral durante a renomeação da receita ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo ReceitaDeOrigemNãoExiste: a receita de origem não foi encontrada no armazenamento ReceitaDeDestinoJáExiste: já existe uma receita com o nome de destino
DeleteRecipe Exclui uma receita existente do repositório.	RecipeId [RecipeId]	Result [DeleteRecipeResultCode] Sucesso: a receita foi excluída com sucesso ErroGenérico: ocorreu um erro geral durante a exclusão da receita ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo ReceitaNãoExiste: a receita especificada não foi encontrada no armazenamento
Refatorar Executa uma operação de refatoração de forma assíncrona.	Nenhum	Nenhum. Este é o único método assíncrono. Quando a operação é concluída, um evento (RefatoraçãoConcluída) é despachado.
GetDataItems Recupera itens de dados associados a uma receita.	RecipeId [RecipeId]	Result [GetDataItemsResultCode] Sucesso: os itens de dados foram recuperados com sucesso ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) ErroGenérico: ocorreu um erro geral ao recuperar os itens de dados
SetRecipeDataItemValue Define o valor de um item de dados específico em uma receita.	RecipeId [RecipeId] ItemRelativeBrowsePath [String] DataItemRelativeBrowsePath [String] ElementAccess [ElementAccess] Value [BaseDataType]	Result [SetRecipeDataItemValueResultCode] Sucesso: o valor do item de dados da receita foi definido com sucesso ErroGenérico: ocorreu um erro geral ao definir o valor do item de dados ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) ItemDeDadosNãoEncontrado: o item de dados especificado não foi encontrado na receita NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
SetRecipeMetadataValue Define o valor de um campo de metadados específico em uma receita.	RecipeId [RecipeId] MetadataName [String] Value [BaseDataType]	Result [SetRecipeMetadataValueResultCode] Sucesso: o valor dos metadados da receita foi definido com sucesso ErroGenérico: ocorreu um erro geral ao definir o valor de metadados ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento MetadadosNãoEncontrados: o campo de metadados especificado não foi encontrado na receita
TransferFromEditModelToStore Transfere uma receita do modelo de edição para o repositório.	RequesterNodeId [NodeId] RecipeId [RecipeId]	Result [TransferFromEditModelToStoreResultCode] SucessoReceitaCriada: a receita foi criada com sucesso e transferida do modelo de edição para o armazenamento SucessoReceitaAtualizada: a receita foi atualizada com sucesso e transferida do modelo de edição para o armazenamento ErroGenérico: ocorreu um erro geral durante a transferência do modelo de edição para o armazenamento ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado NóDoModeloDeEdiçãoNãoEncontrado: o nó do modelo de edição não foi encontrado
TransferFromEditModelToTarget Transfere uma receita do modelo de edição para um nó de destino.	RequesterNodeId [NodeId] TargetNodeId [NodeId] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromEditModelToTargetResultCode] Sucesso: a receita foi transferida do modelo de edição para o destino com sucesso ErroGenérico: ocorreu um erro geral durante a transferência do modelo de edição para o destino ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado NóDoModeloDeEdiçãoNãoEncontrado: o nó do modelo de edição não foi encontrado IncompatibilidadeDeDados: há uma incompatibilidade entre os dados do modelo de edição e a estrutura de destino
TransferFromStoreToEditModel Transfere uma receita do repositório para o modelo de edição.	RequesterNodeId [NodeId] RecipeId [RecipeId]	Result [TransferFromEditModelToTargetResultCode] Sucesso: a receita foi transferida do modelo de edição para o destino com sucesso ErroGenérico: ocorreu um erro geral durante a transferência do modelo de edição para o destino ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado NóDoModeloDeEdiçãoNãoEncontrado: o nó do modelo de edição não foi encontrado IncompatibilidadeDeDados: há uma incompatibilidade entre os dados do modelo de edição e a estrutura de destino
TransferFromStoreToTarget Transfere uma receita do repositório para um nó de destino.	RecipeId [RecipeId] TargetNodeId [NodeId] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromStoreToTargetResultCode] Sucesso: a receita foi transferida do armazenamento para o destino com sucesso ErroGenérico: ocorreu um erro geral durante a transferência do armazenamento para o destino ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado IncompatibilidadeDeDados: há uma incompatibilidade entre os dados da receita e a estrutura de destino
TransferFromTargetToEditModel Transfere uma receita de um nó de destino para o modelo de edição.	RequesterNodeId [NodeId] TargetNodeId [NodeId] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromTargetToEditModelResultCode] Sucesso: a receita foi transferida do destino para o modelo de edição com sucesso ErroGenérico: ocorreu um erro geral durante a transferência do destino para o modelo de edição ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado NóDoModeloDeEdiçãoNãoEncontrado: o nó do modelo de edição não foi encontrado IncompatibilidadeDeDados: há uma incompatibilidade entre os dados de destino e a estrutura do modelo de edição
TransferFromTargetToStore Transfere uma receita de um nó de destino para o repositório.	RecipeId [RecipeId] TargetNodeId [NodeId] Overwrite [Bool] ErrorPolicy [ErrorPolicyDataType]	Result [TransferFromTargetToStoreResultCode] SucessoReceitaCriada: a receita foi criada e transferida com sucesso do destino para o armazenamento SucessoReceitaAtualizada: a receita foi atualizada com sucesso e transferida do destino para o armazenamento ErroGenérico: ocorreu um erro geral durante a transferência do destino para o armazenamento ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento (por exemplo, erro de banco de dados) NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo AReceitaJáExiste: uma receita com o mesmo nome já existe no armazenamento DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado IncompatibilidadeDeDados: há uma incompatibilidade entre os dados de destino e a estrutura do armazenamento

Métodos disponíveis apenas por meio da API C#
Método	Argumentos de entrada	Argumentos de saída
GetRecipes Recupera uma lista de todas as receitas no repositório.	Nenhum argumento de entrada	Result [GetRecipesResult] (Array) Sucesso: as receitas foram recuperadas com sucesso ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento ErroGenérico: ocorreu um erro geral ao recuperar as receitas
GetRecipeMetadataValue Recupera o valor de um campo de metadados específico em uma receita.	RecipeId [RecipeId] MetadataName [String]	Result [GetRecipeMetadataValueResult] Sucesso: o valor dos metadados da receita foi recuperado com sucesso ErroGenérico: ocorreu um erro geral ao recuperar o valor de metadados ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento MetadadosNãoEncontrados: o campo de metadados especificado não foi encontrado na receita
GetRecipeMetadataValues Recupera todos os valores de metadados associados a uma receita.	RecipeId [RecipeId]	Result [GetRecipeMetadataValuesResult] Sucesso: os valores dos metadados da receita foram recuperados com sucesso ErroGenérico: ocorreu um erro geral ao recuperar os valores de metadados ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
GetRecipeDataItemValue Recupera o valor de um item de dados específico em uma receita.	RecipeId [RecipeId] ItemRelativeBrowsePath [String] (Array) DataItemRelativeBrowsePath [String] (Array) ElementAccess [ElementAccess]	Result [GetRecipeDataItemValueResult] Sucesso: o valor do item de dados da receita foi recuperado com sucesso ErroGenérico: ocorreu um erro geral ao recuperar o valor do item de dados ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento ItemDeDadosNãoEncontrado: o item de dados especificado não foi encontrado na receita NomeDeReceitaVazioInesperado: o nome da receita fornecido está vazio ou nulo ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento
CreateEditModel Cria um modelo de edição para uma receita.	ParentNodeId [NodeId] RequesterNodeId [NodeId] TargetNodeId [NodeId] RecipeId [RecipeId]	Result [CreateEditModelResultCode] Sucesso: o modelo de edição foi criado com sucesso ErroGenérico: ocorreu um erro geral ao criar o modelo de edição ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento NóPaiNãoEncontrado: o nó pai do modelo de edição não foi encontrado NóDoSolicitanteNãoEncontrado: o nó do solicitante não foi encontrado
TransferFromStores Transfere uma receita do repositório para um nó de destino.	RecipeId [RecipeId]	Result [TransferFromStoreResultCode] Sucesso: a receita foi transferida do armazenamento com sucesso ErroGenérico: um erro geral ocorreu durante a transferência do armazenamento ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento ReceitaNãoEncontrada: a receita especificada não foi encontrada no armazenamento DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado
TransferToStore Transfere uma receita para o repositório.	RecipeId [RecipeId]	Result [TransferToStoreResultCode] Sucesso: a receita foi transferida para o armazenamento com sucesso ErroGenérico: um erro geral ocorreu durante a transferência para o armazenamento ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento
TransferirParaODestino Transfere uma receita para um nó de destino.	TargetNodeId [NodeId] ErrorPolicy [ErrorPolicy]	Result [TransferToTargetResultCode] Sucesso: a receita foi transferida para o destino com sucesso ErroGenérico: um erro geral ocorreu durante a transferência para o destino ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado IncompatibilidadeDeDados: há uma incompatibilidade entre os dados da receita e a estrutura de destino
TransferFromTarget Transfere uma receita de um nó de destino para o repositório.	TargetNodeId [NodeId] ErrorPolicy [ErrorPolicy]	Result [TransferFromTargetResultCode] Sucesso: a receita foi transferida do destino com sucesso ErroGenérico: ocorreu um erro geral durante a transferência do destino ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento DestinoNãoEncontrado: o nó de destino da transferência não foi encontrado IncompatibilidadeDeDados: há uma incompatibilidade entre os dados de destino e a estrutura da receita
SetDataItemValue Define o valor de um item de dados específico.	ItemId [NodeId] DataItemRelativeBrowsePath [String] (Array) ElementAccess [ElementAccess] DataTypeId [NodeId] Value [BaseDataType]	Result [SetDataItemValueResultCode] Sucesso: o valor do item de dados foi definido com sucesso ErroGenérico: ocorreu um erro geral ao definir o valor do item de dados ErroDeArmazenamento: ocorreu um erro ao acessar o armazenamento ItemDeDadosNãoEncontrado: o item de dados especificado não foi encontrado

Eventos

O esquema de receita inclui os seguintes eventos:

Refatoração concluída: Acionado quando o método Refatoração é concluído.
Evento de aplicação de receita: Acionado quando TransferFromStoreToTarget ou TransferEditModelToTarget são concluídos.

Esquemas de receita

Dê sua opinião

Tem dúvidas ou comentários sobre esta documentação? Por favor, envie seu comentário aqui.