GetFieldChoiceList

Descrizione

Restituisce l'elenco di valori possibili per il campo specificato.

L'amministratore specifica se i valori validi per un dato campo vengono limitati al contenuto dell'elenco selezioni. Se esiste una limitazione, si verifica un errore di convalida se non si specifica un valore nell'elenco selezioni. Se non esiste una limitazione, è possibile specificare dei valori non nell'elenco selezioni. (Tenere presente che qualsiasi valore specificato deve essere ancora convalidato).

Se questo metodo restituisce un valore Variant vuoto, questo non implica che tutti i valori sono consentiti; significa solo che l'amministratore non ha fornito alcun suggerimento sui valori consentiti nel campo.

Se l'amministratore sceglie di utilizzare un hook per determinare i valori dell'elenco selezioni, IBM Rational ClearQuest ha già eseguito l'hook e acquisito i valori risultanti in un Oggetto HookChoices (solo Visual Basic). È possibile utilizzare tale oggetto per richiamare i valori.

Se si dispone di un hook di elenco selezioni, che genera la serie di selezioni per un campo, esso deve restituire i relativi risultati inserendoli in una raccolta trasferita all'interno della procedura hook.

È possibile utilizzare il metodo GetFieldNames per ottenere un elenco di nomi validi per il parametro field_name.

Nota: Se questo metodo viene richiamato da un programma Visual Basic esterno, viene generata un'eccezione se l'entità non è modificabile.

Sintassi

VBScript

entity.GetFieldChoiceList field_name 

Perl

$entity->GetFieldChoiceList(field_name); 
Identificativo
Descrizione
entity
Un oggetto Entity che rappresenta un record di dati dell'utente. All'interno di un hook, se si omette questa parte della sintassi, viene utilizzato l'oggetto Entity corrispondente al record di dati corrente (solo VBScript).
field_name
Una stringa che identifica un nome del campo valido dell'entità.
Valore di ritorno
Per Visual Basic, viene restituito un valore Variant contenente un array. Ogni elemento dell'array contiene un valore accettabile per il campo specificato. Se non viene fornito un elenco selezioni con il campo, il valore Variant restituito sarà vuoto.

Per Perl, viene restituito un riferimento ad un array di stringhe.

Esempi

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]);

 } 
#Example 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;

} 

Feedback