com.tplan.robot.scheduler

Class ScheduleParameter

java.lang.Object

com.tplan.robot.scheduler.ScheduleParameter

All Implemented Interfaces:

Cloneable

public class ScheduleParameter
extends Object
implements Cloneable

Representation of a schedule or work item parameter.

Since:

6.3

T-Plan Robot Enterprise, (C) 2009-2022 T-Plan Limited. All rights reserved.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ScheduleParameter.ParamType Parameter types.

Constructor Summary

Constructors

Constructor and Description
ScheduleParameter()

Method Summary

Modifier and Type	Method and Description
Object	clone() Clone this parameter.
String	getDefaultValue() Get the parameter default value (optional).
String	getDescription() Get the parameter description.
String	getLabel() Get the parameter label (display name), i.e.
String	getName() Get the parameter name.
ScheduleParameter.ParamType	getType() Get the parameter type.
String	getValue() Get the parameter value.
boolean	isEncrypted() Indicate whether the parameter attributes should be encrypted.
boolean	isMandatory() Indicate whether the parameter value is required for the workitem to execute.
void	setDefaultValue(String value) Get the optional parameter default value.
void	setDescription(String description) Set the parameter description.
void	setEncrypted(boolean encrypted) Indicate whether the parameter attributes should be encrypted.
void	setLabel(String label) Set the parameter label (display name), i.e.
void	setMandatory(boolean mandatory) Indicate whether the parameter value is required for the workitem to execute.
void	setName(String name) Set the parameter name.
void	setType(ScheduleParameter.ParamType type) Set the parameter type.
void	setValue(String value) Set the parameter value.
String	toString() Get the parameter description/summary for debugging purposes.

Methods inherited from class java.lang.Object

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

Constructor Detail

ScheduleParameter

public ScheduleParameter()

Method Detail

clone

public Object clone()
             throws CloneNotSupportedException

Clone this parameter.

Overrides:

clone in class Object

Returns:

a clone of this parameter.

Throws:

CloneNotSupportedException - if the parameter can not be cloned.

toString

public String toString()

Get the parameter description/summary for debugging purposes.

Overrides:

toString in class Object

Returns:

parameter description.

getName

public String getName()

Get the parameter name.

Returns:

the name.

setName

public void setName(String name)

Set the parameter name.

Parameters:

name - the name to set

getLabel

public String getLabel()

Get the parameter label (display name), i.e. text for the field prior to the parameter editor.

Returns:

the parameter label.

setLabel

public void setLabel(String label)

Set the parameter label (display name), i.e. text for the field prior to the parameter editor.

Parameters:

label - the label to set

getDescription

public String getDescription()

Get the parameter description.

Returns:

the description.

setDescription

public void setDescription(String description)

Set the parameter description.

Parameters:

description - the description to set.

getDefaultValue

public String getDefaultValue()

Get the parameter default value (optional).

Returns:

the default value.

setDefaultValue

public void setDefaultValue(String value)

Get the optional parameter default value.

Parameters:

value - the value to set.

isMandatory

public boolean isMandatory()

Indicate whether the parameter value is required for the workitem to execute.

Returns:

true to refuse to start the workitem without the value or false if the parameter value is not necessary.

setMandatory

public void setMandatory(boolean mandatory)

Indicate whether the parameter value is required for the workitem to execute.

Parameters:

mandatory - true to make the workitem refuse to start without the value or false if the parameter value is not necessary.

isEncrypted

public boolean isEncrypted()

Indicate whether the parameter attributes should be encrypted. Reserved for future use.

Returns:

true if encrypted or false otherwise.

setEncrypted

public void setEncrypted(boolean encrypted)

Indicate whether the parameter attributes should be encrypted. Reserved for future use.

Parameters:

encrypted - true/false to set on/off encryption.

getType

public ScheduleParameter.ParamType getType()

Get the parameter type.

Returns:

the parameter type.

setType

public void setType(ScheduleParameter.ParamType type)

Set the parameter type.

Parameters:

type - the type to set.

getValue

public String getValue()

Get the parameter value. If the value is not populated the method returns the default value or null if it was not specified.

Returns:

the parameter value.

setValue

public void setValue(String value)

Set the parameter value.

Parameters:

value - the value to set.