IJobDescriptor.IJobParameterGroup

Enclosing interface:: IJobDescriptor

public static interface IJobDescriptor.IJobParameterGroup

Parameter group.

Groups are hierarchical.

Version:: $Revision$ $Date$
Author:: Stepan Roh, Polarion Software

Method Summary

Modifier and Type

Method

Description

String

getDescription()

Human-readable description (if any).

String

getLabel()

Human-readable label.

String

getName()

Name.

List

getParameters()

Available parameters placed inside this group (not subgroups).

IJobDescriptor.IJobParameterGroup

getParent()

Parent group.

List

getSubgroups()

Available subgroups placed inside this group (not subgroups).

boolean

isActive()

Whether this group is active.

Method Details
- getName
  
  String getName()
  
  Name.
  Unique within one job descriptor.
  Protected from dynamic change.
  
  Returns:
  
  name (not null)
- getLabel
  
  String getLabel()
  
  Human-readable label.
  
  Returns:
  
  label (not null)
- getDescription
  
  String getDescription()
  
  Human-readable description (if any).
  
  Returns:
  
  description or null
- getParameters
  
  List getParameters()
  
  Available parameters placed inside this group (not subgroups).
  Order suggests how they should be presented in UI.
  Protected from dynamic change.
  
  Returns:
  
  List of IJobDescriptor.IJobParameters (not null)
- getSubgroups
  
  List getSubgroups()
  
  Available subgroups placed inside this group (not subgroups).
  Order suggests how they should be presented in UI.
  Protected from dynamic change.
  
  Returns:
  
  List of IJobDescriptor.IJobParameterGroups (not null)
- getParent
  
  IJobDescriptor.IJobParameterGroup getParent()
  
  Parent group.
  Protected from dynamic change.
  
  Returns:
  
  parameter group (null only if this is root group)
- isActive
  
  boolean isActive()
  
  Whether this group is active.
  If group is inactive, all its subgroups and parameters placed inside this group are inactive too.
  (In)activity is used in dynamic descriptors to mark configuration currently unnecessary.
  
  Returns:
  
  true if this group is active, false otherwise