Este tema contiene los bloques básicos a partir de los cuales puede crear enganches.
Cada llamada a
API se muestra en primer lugar en VBScript y luego en Perl. La sintaxis utiliza el
formato <objeto.><método>.
En Perl, los objetos
Entidad y Sesión actuales están predefinidos como
entity y session (en minúsculas).
Para VBScript, el objeto Entidad actual se da por supuesto y no es
necesario que lo identifique de forma explícita cuando realice llamadas a sus métodos.
Para obtener más información, consulte el manual IBM Rational ClearQuest API Reference.
- Llamada a API (VBScript/Perl)
- Función
- [entity.]GetSession $entity->GetSession
- Obtiene la sesión, necesaria para invocar muchas otras API.
- session.OutputDebugString $session->OutputDebugString
- Proporciona información de corriente de datos de depuración que puede utilizar
para depurar el código del enganche o aplicación externa.
- session.GetEntity $session->GetEntity
- Recupera un registro de la base de datos.
- session.EditEntity $session->EditEntity
- Edita un registro recuperado de la base de datos.
- [entity.]SetFieldValue $entity->SetFieldValue
- Asigna un valor a un campo.
- [entity.]Validate $entity->Validate
- Garantiza que los datos de un registro son aceptables antes de que el registro se guarde en la base de datos.
- [entity.]Commit $entity->Commit
- Confirma el registro, incluida cualquier edición, en la base de datos.
- [entity.]Revert $entity->Revert
- Cancela los cambios. Un buen método para utilizar si la validación falla y el registro no se ha confirmado.
- [entity.]GetFieldValue $entity->GetFieldValue
- Recupera el objeto de información de campo para el campo especificado.
- FieldInfo.GetValue $FieldInfo->GetValue
- Recupera los valores de un campo.
- session.BuildQuery $session->BuildQuery
- Crea una consulta.
- QueryDef.BuildField $QueryDef->BuildField
- Incluye un campo en un conjunto de resultados de consulta.
- QueryDef.BuildFilterOperator QueryFilterNode.BuildFilterOperator $QueryDef->BuildFilterOperator
$QueryFilterNode->BuildFilter Operator
- Crea un operador de filtro para una consulta
del tipo "igual a" o "mayor que".
- QueryFilterNode.BuildFilter $QueryFilterNode->BuildFilter
- Crea soporte para una consulta compleja.
- session.BuildResultSet $session->BuildResultSet
- Crea un objeto ResultSet necesario para ejecutar una consulta.
- ResultSet.Execute $ResultSet->Execute
- Ejecuta la consulta con el objeto ResultSet actual.
- ResultSet.MoveNext $ResultSet->MoveNext
- Mueve el cursor al siguiente registro del conjunto de datos.
- ResultSet.GetColumnValue $ResultSet->GetColumnValue
- Recupera el valor de la columna que especifique de la fila actual.
- session.GetUserLoginName $session->GetUserLoginName
- Obtiene el ID de inicio de sesión del usuario.
- entity.Revert $entity->Revert
- Descarta cualquier cambio realizado en el objeto Entidad. No utilice la API Revert para cancelar anormalmente la acción actual desde dentro de
un enganche. Esta API sólo sirve para invertir una acción que se ha iniciado de forma
explícita desde dentro de un enganche o script. Si debe detener la acción actual, utilice los mecanismos de excepción del lenguaje de script para lanzar una excepción o hacer que el enganche de acción-validación devuelva el valor "false".