Package com.polarion.platform.jobs.spi

Class AbstractJobParameter

java.lang.Object

com.polarion.platform.jobs.spi.AbstractJobParameter

All Implemented Interfaces:

IJobDescriptor.IJobParameter

Direct Known Subclasses:

ArrayJobParameter, BuildArtifactJobParameter, LocationJobParameter, PathJobParameter, PropertiesJobParameter, SimpleJobParameter

public abstract class AbstractJobParameter
extends Object
implements IJobDescriptor.IJobParameter

Abstract IJobDescriptor.IJobParameter.

Parameter is by default active and required, has no default value and no description.

Allows to modify all values which are not protected by dynamic change.

Version:

$Revision$ $Date$

Author:

Stepan Roh, Polarion Software

Constructor Summary

Constructors

Constructor	Description
AbstractJobParameter(IJobDescriptor.IJobParameterGroup group, String name, String label, IJobDescriptor.IJobParameterType type)	Constructor.

Method Summary

Modifier and Type	Method	Description
Object	getDefaultValue()	Default value.
String	getDescription()	Human-readable description (if any).
IJobDescriptor.IJobParameterGroup	getGroup()	Parent group.
String	getLabel()	Human-readable label.
String	getName()	Name.
IJobDescriptor.IJobParameterType	getType()	Type.
boolean	isActive()	Whether this parameter is active.
boolean	isRequired()	Whether this parameter is required.
AbstractJobParameter	setActive(boolean active)	Set active flag.
AbstractJobParameter	setDefaultValue(Object defaultValue)	Set default value.
AbstractJobParameter	setDescription(String description)	Set description;
AbstractJobParameter	setLabel(String label)	Set label.
AbstractJobParameter	setRequired(boolean required)	Set required flag.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.polarion.platform.jobs.IJobDescriptor.IJobParameter

convertValue

Constructor Details

AbstractJobParameter

public AbstractJobParameter(IJobDescriptor.IJobParameterGroup group,
 String name,
 String label,
 IJobDescriptor.IJobParameterType type)

Constructor.

Parameters:

group - job parameter group

name - job name

label - job label

type - parameter type

Throws:

IllegalArgumentException - if group is null

IllegalArgumentException - if name is null

IllegalArgumentException - if label is null

IllegalArgumentException - if type is null

Method Details

getDefaultValue

public Object getDefaultValue()

Description copied from interface: IJobDescriptor.IJobParameter

Default value.

Specified by:

getDefaultValue in interface IJobDescriptor.IJobParameter

Returns:

default value or null

getDescription

public String getDescription()

Description copied from interface: IJobDescriptor.IJobParameter

Human-readable description (if any).

Specified by:

getDescription in interface IJobDescriptor.IJobParameter

Returns:

description or null

getGroup

public IJobDescriptor.IJobParameterGroup getGroup()

Description copied from interface: IJobDescriptor.IJobParameter

Parent group.

Protected from dynamic change.

Specified by:

getGroup in interface IJobDescriptor.IJobParameter

Returns:

parameter group (not null)

getLabel

public String getLabel()

Description copied from interface: IJobDescriptor.IJobParameter

Human-readable label.

Specified by:

getLabel in interface IJobDescriptor.IJobParameter

Returns:

label (not null)

getName

public String getName()

Description copied from interface: IJobDescriptor.IJobParameter

Name.

Unique within one job descriptor.

Protected from dynamic change.

Specified by:

getName in interface IJobDescriptor.IJobParameter

Returns:

name (not null)

getType

public IJobDescriptor.IJobParameterType getType()

Description copied from interface: IJobDescriptor.IJobParameter

Type.

Protected from dynamic change.

Specified by:

getType in interface IJobDescriptor.IJobParameter

Returns:

type (not null)

isActive

public boolean isActive()

Description copied from interface: IJobDescriptor.IJobParameter

Whether this parameter is active.

(In)activity is used in dynamic descriptors to mark configuration currently unnecessary.

Specified by:

isActive in interface IJobDescriptor.IJobParameter

Returns:

true if this parameter is active, false otherwise

isRequired

public boolean isRequired()

Description copied from interface: IJobDescriptor.IJobParameter

Whether this parameter is required.

Only relevant if IJobDescriptor.IJobParameter.isActive() is true.

Specified by:

isRequired in interface IJobDescriptor.IJobParameter

Returns:

true if parameter is required, false otherwise

setActive

public AbstractJobParameter setActive(boolean active)

Set active flag.

Parameters:

active - active flag

Returns:

this

See Also:

• isActive()

setDefaultValue

public AbstractJobParameter setDefaultValue(Object defaultValue)

Set default value.

Parameters:

defaultValue - default value (can be null)

Returns:

this

See Also:

• getDefaultValue()

setDescription

public AbstractJobParameter setDescription(String description)

Set description;

Parameters:

description - description (can be null)

Returns:

this

See Also:

• getDescription()

setLabel

public AbstractJobParameter setLabel(String label)

Set label.

Parameters:

label - label

Returns:

this

Throws:

IllegalArgumentException - if label is null

See Also:

• getLabel()

setRequired

public AbstractJobParameter setRequired(boolean required)

Set required flag.

Parameters:

required - required flag

Returns:

this

See Also:

• isRequired()