GetFieldChoiceList

Description

Devuelve la lista de valores permitidos para el campo especificado.

El administrador especifica si los valores permitidos para un campo determinado se limitan al contenido de la lista de opciones. Si existe una restricción, al especificar un valor que no se encuentra en la lista de opciones se produce un error de validación. Si no existe ninguna restricción, se pueden especificar valores que no están en la lista de opciones. (Tenga en cuenta que todos los valores que especifique se deben validar).

Si este método devuelve un Empty Variant, no implica que estén permitidos todos los valores; sólo significa que el administrador no ha proporcionado ninguna sugerencia sobre los valores permitidos en el campo.

Si el administrador elige utilizar un enganche para determinar los valores de la lista de opciones, IBM Rational ClearQuest ejecuta previamente el enganche y almacena en antememoria los valores resultantes en un objeto HookChoices (sólo Visual Basic). Puede utilizar dicho objeto para recuperar los valores.

Si tiene un enganche de lista de opciones, que genera el conjunto de opciones para un campo, éste debe devolver los resultados al rellenar una recopilación que se pasa en el procedimiento de enganche.

Puede utilizar el método GetFieldNames para obtener una lista de nombres válidos para el parámetro field_name.

Nota: Cuando se llama a este método desde un programa Visual Basic externo, este método lanza una excepción si la entidad no se puede editar.

Sintaxis

VBScript

entity.GetFieldChoiceList field_name 

Perl

$entity->GetFieldChoiceList(field_name); 
Identificador
Description
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).
field_name
Un valor String que identifica un nombre de campo válido de entidad.
Valor de retorno
Para Visual Basic, devuelve un valor Variant que contiene una matriz. Cada elemento de la matriz contiene un valor aceptable para el campo especificado. Si no se ha proporcionado una lista de opciones para el campo, el valor devuelto es Empty Variant.

Para Perl, una referencia a una matriz de series.

Ejemplos

VBScript

fieldValue = GetFieldValue("field1").GetValue 

' Check to see if the field's current value is in the choice list
fieldChoiceList = GetFieldChoiceList("field1") 
For Each fieldChoice in fieldChoiceList
   If fieldValue = fieldChoice Then
      ' This is a valid choice 
   End If 
Next 

Perl

# If the field must have a value from a closed choice list, assign

# the first value in the list to the field by default. 



$choicetype = $entity->GetFieldChoiceType("field1");

if ($choicetype eq $CQPerlExt::CQ_CLOSED_CHOICE)

 {

 # Set the field to the first item in the choice list. 

 $fieldchoicelist = $entity->GetFieldChoiceList("field1");

 $entity->SetFieldValue("field1",@$fieldchoicelist[0]);

 } 
#Ejemplo 2: 
sub Dyn_choice_get_values 

{

   my $session;

   my $fieldchoicelist;   

   $session = $entity->GetSession();

   $fieldchoicelist = $entity->GetFieldChoiceList("Dyn_List_Example");

   $session->OutputDebugString(" CHOICELIST @$fieldchoicelist \n");

   return 0;

} 

Comentarios