Chamadas Comuns de API

Este tópico lista os blocos de construção a partir dos quais você pode criar ganchos.

Cada chamada de API é mostrada primeiro em VBScript e, em seguida, em Perl. A sintaxe utiliza um formato <objeto.><método>.

No Perl, os objetos Entity e Session atuais estão predefinidos como entity e session (minúsculas). Para VBScript, assume-se o objeto Entity atual e você não precisa identificá-lo explicitamente ao chamar seus métodos.

Para obter informações adicionais, consulte o IBM Rational ClearQuest API Reference.

Chamada de API (VBScript/Perl)
Função
[entity.]GetSession $entity->GetSession
Obtém a sessão, que é necessária para chamar várias outras APIs.
session.OutputDebugString $session->OutputDebugString
Emite saída para as informações de fluxo de depuração que você pode utilizar para depurar o código de gancho ou o aplicativo externo.
session.GetEntity $session->GetEntity
Recupera um registro do banco de dados.
session.EditEntity $session->EditEntity
Edita um registro recuperado do banco de dados.
[entity.]SetFieldValue $entity->SetFieldValue
Designa um valor a um campo.
[entity.]Validate $entity->Validate
Assegura que os dados em um registro sejam aceitáveis antes que o registro seja salvo no banco de dados.
[entity.]Commit $entity->Commit
Confirma o registro, inclusive quaisquer edições, para o banco de dados.
[entity.]Revert $entity->Revert
Cancela as alterações. Um bom método para utilização se a validação falhar e o registro não for consolidado.
[entity.]GetFieldValue $entity->GetFieldValue
Recupera o objeto de informações de campo para o campo especificado.
FieldInfo.GetValue $FieldInfo->GetValue
Recupera os valores de um campo.
session.BuildQuery $session->BuildQuery
Constrói uma consulta.
QueryDef.BuildField $QueryDef->BuildField
Inclui um campo em um conjunto de resultados de consulta.
QueryDef.BuildFilterOperator QueryFilterNode.BuildFilterOperator $QueryDef->BuildFilterOperator $QueryFilterNode->BuildFilter Operator
Constrói um operador de filtro para uma consulta como, por exemplo, "igual a" ou "maior que".
QueryFilterNode.BuildFilter $QueryFilterNode->BuildFilter
Cria suporte para uma consulta complexa.
session.BuildResultSet $session->BuildResultSet
Cria o objeto ResultSet necessário para executar uma consulta.
ResultSet.Execute $ResultSet->Execute
Executa a consulta com o objeto ResultSet atual.
ResultSet.MoveNext $ResultSet->MoveNext
Move o cursor para o próximo registro no conjunto de dados.
ResultSet.GetColumnValue $ResultSet->GetColumnValue
Recupera o valor na coluna especificada da linha atual.
session.GetUserLoginName $session->GetUserLoginName
Obtém o ID de login do usuário.
entity.Revert $entity->Revert
Descarta quaisquer alterações feitas no objeto Entity. Não utilize a API Revert para parar a ação atual a partir de um gancho. Essa API é apenas para reverter uma ação que foi iniciada explicitamente a partir de um gancho ou script. Se você precisar parar a ação atual, utilize os mecanismos de exceção da linguagem de script para emitir uma exceção ou fazer com que o gancho de validação de ação retorne "false."

Feedback