IJobDescriptor.IJobParameterChoiceType

Enclosing interface:: IJobDescriptor

public static interface IJobDescriptor.IJobParameterChoiceType

Optional "flavor" type adding choice support to any type.

Author:: Stepan Roh, Polarion Software

Method Summary

Modifier and Type

Method

Description

IJobDescriptor.IJobParameterChoice

getChoice(String name)

Return choice of given name (if any).

List

getChoices()

Available choices.

boolean

isRestricted()

Whether choices are restricted to those available or user may supply its own value.

Method Details
- getChoices
  
  List getChoices()
  
  Available choices.
  Order suggests how they should be presented in UI.
  
  Returns:
  
  List of IJobDescriptor.IJobParameterChoices (not null)
- getChoice
  
  IJobDescriptor.IJobParameterChoice getChoice(String name)
  
  Return choice of given name (if any).
  
  Parameters:
  
  name - choice name
  
  Returns:
  
  choice or null if unknown
  
  Throws:
  
  IllegalArgumentException - if name is null
- isRestricted
  
  boolean isRestricted()
  
  Whether choices are restricted to those available or user may supply its own value.
  
  Returns:
  
  true if only available choices are permitted, false if any value is permitted