IJobDescriptor.IJobParameterStructureType

All Superinterfaces:: IJobDescriptor.IJobParameterType

Enclosing interface:: IJobDescriptor

public static interface IJobDescriptor.IJobParameterStructureType extends IJobDescriptor.IJobParameterType

Structure type (map).

Note that value of list type does not necessarily implement Map.

Author:: Stepan Roh, Polarion Software

Method Summary

Modifier and Type

Method

Description

Object

createStructure(Map items)

Create structure value based on map of items.

Map

getItemTypes()

Item names and types.

IJobDescriptor.IJobParameterType

getUnknownItemType()

Item type of unknown items (those not mentioned in getItemTypes()).

Methods inherited from interface com.polarion.platform.jobs.IJobDescriptor.IJobParameterType
getDescription, getLabel, getTypeClass

Method Details
- getItemTypes
  
  Map getItemTypes()
  
  Item names and types.
  Protected from dynamic change.
  
  Returns:
  
  Map between String item name and IJobDescriptor.IJobParameterType (not null)
- getUnknownItemType
  
  IJobDescriptor.IJobParameterType getUnknownItemType()
  
  Item type of unknown items (those not mentioned in getItemTypes()).
  Protected from dynamic change.
  
  Returns:
  
  type or null if unknown items are forbidden
- createStructure
  
  Object createStructure(Map items)
  
  Create structure value based on map of items.
  
  Parameters:
  
  items - Map between String item name and value
  
  Returns:
  
  object representing structure composed of given items (can be null)
  
  Throws:
  
  IllegalArgumentException - if items is null