Validate

Descripción

Valida el objeto Entity e informa sobre todos los errores.

Antes de que se pueda confirmar una entidad, se debe validar (aunque no se haya cambiado ningún campo). Si va a cambiar el contenido de un registro de modo programático, debe asegurarse de que el código proporcione datos válidos.

No trate de analizar e interpretar el valor String devuelto de modo programático, puesto que el texto de error puede cambiar en futuros releases. Si desea intentar corregir el valor de un campo con valores incorrectos, puede utilizar el método GetInvalidFieldValues para obtener el objeto FieldInfo para dicho campo.

Sólo se puede llamar a este método si el objeto Entity se puede editar. Para convertir un objeto Entity existente en editable, llame al método EditEntity del objeto Session.

Nota: En caso de anomalía, este método puede devolver un valor String que contiene un mensaje de error o una excepción, dependiendo de la causa de la anomalía. Por ejemplo, el método devuelve un valor String que contiene un mensaje de error para anomalías como, por ejemplo, valores no válidos establecidos para campos. Sin embargo, el método lanza una excepción para otras anomalías, tales como intentar cambiar una entidad que no presenta un estado editable. El código debe manejar ambos tipos de posibles anomalías. Consulte el apartado Comprobación y validación de errores para obtener más información. En el apartado Ejemplo de enganche de confirmación de acción se proporcionan ejemplos de manejo de errores y excepciones al llamar a los métodos Validate y Commit.

También puede llamar a este método desde dentro de cualquier enganche para renovar los datos de validación que están disponibles en los clientes de ClearQuest. Sin embargo, tenga en cuenta que si se utiliza este tipo de validación demasiado a menudo puede disminuir el rendimiento.

Sintaxis

VBScript

entity.Validate 

Perl

$entity->Validate(); 
Identificador
Descripción
entity
Un objeto Entity que representa un registro de datos de usuario. En un enganche, si se omite esta parte de la sintaxis, se presupone el objeto Entity correspondiente al registro de datos actual (sólo VBScript).
Valor de retorno
Si el objeto Entity es válido, este método devuelve un Empty String (''). Si se detecta algún error de validación, el valor String contiene una explicación del problema, adecuada para presentar al usuario.

Ejemplos

VBScript

set sessionObj = GetSession 

set entityObj = sessionObj.GetEntity("defect", "BUGID00000042")
sessionObj.EditEntity entityObj, "modify"   

' modify the Entity object 


status = entityObj.Validate 

     if status = "" then

         entityObj.Commit 
      else

          entityObj.Revert  

       End If
' The Entity object is no longer editable 

Perl

# Get the current session

$sessionobj = $entity->GetSession();

# Select an entity to modify

$entityobj = $session->GetEntity("defect","BUGID00000042");


# Take the modify action on the entity object

$sessionobj->EditEntity($entityobj,"modify");

# ...make modifications to the entity object


$status = $entityobj->Validate();

   if ($status == ""){

      $entityobj->Commit();

      }

   else {

         $entityobj->Revert();

      }

# At this point, the entity object is no longer modifiable 

Comentarios