Package com.swiftmq.swiftlet.scheduler

Class JobParameter

java.lang.Object

com.swiftmq.swiftlet.scheduler.JobParameter

public class JobParameter
extends Object

A JobParameter object contains meta data about Job parameters. It is used from the Scheduler Swiftlet to verify user-specified parameter values before a Job is started.

Author:

IIT GmbH, Bremen/Germany, Copyright (c) 2000-2003, All Rights Reserved

Constructor Summary

Constructors

Constructor	Description
JobParameter(String name, String description, String defaultValue, boolean mandatory, JobParameterVerifier verifier)	Creates a new JobParameter object.

Method Summary

Modifier and Type	Method	Description
String	getDefaultValue()	Returns the default value (null if no default is specified).
String	getDescription()	Returns the description.
String	getName()	Returns the name.
JobParameterVerifier	getVerifier()	Returns the optional verifier.
boolean	isMandatory()	Returns whether this parameter is optional or mandatory.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

JobParameter

public JobParameter(String name,
 String description,
 String defaultValue,
 boolean mandatory,
 JobParameterVerifier verifier)

Creates a new JobParameter object.

Parameters:

name - Name

description - Short Description

defaultValue - optional default value

mandatory - whether it is mandatory or optional

verifier - optional verifier

Method Details

getName

public String getName()

Returns the name.

Returns:

Name

getDescription

public String getDescription()

Returns the description.

Returns:

description

getDefaultValue

public String getDefaultValue()

Returns the default value (null if no default is specified).

Returns:

default value

isMandatory

public boolean isMandatory()

Returns whether this parameter is optional or mandatory.

Returns:

true / false

getVerifier

public JobParameterVerifier getVerifier()

Returns the optional verifier.

Returns:

verifier

toString

public String toString()

Overrides:

toString in class Object