Package de.uka.ipd.sdq.workflow.configuration

Class AbstractJobConfiguration

java.lang.Object

de.uka.ipd.sdq.workflow.configuration.AbstractJobConfiguration

All Implemented Interfaces:

IJobConfiguration, Cloneable

Direct Known Subclasses:

AbstractComposedJobConfiguration, AbstractExtendableJobConfiguration, AbstractExtensionJobConfiguration, AbstractWorkflowBasedRunConfiguration

public abstract class AbstractJobConfiguration
extends Object
implements IJobConfiguration, Cloneable

The Class AbstractJobConfiguration.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isFixed	Boolean flag indicating that this configuration object is immutable.

Constructor Summary

Constructors

Constructor	Description
AbstractJobConfiguration()	Constructor of an abstract job configuration.

Method Summary

Modifier and Type	Method	Description
protected void	checkFixed()	Used in setter methods to check whether the object can still be modified.
protected Object	clone()
abstract String	getErrorMessage()	Gets the error message.
boolean	isFrozen()	Get the status of this configuration.
boolean	isValid()	Checks if is valid.
abstract void	setDefaults()	Sets usefull default values for the configuration object.
void	validateAndFreeze()	The last method to call by any builder or code creating an configuration for the workflow engine.

Methods inherited from class java.lang.Object

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

Field Detail

isFixed

protected boolean isFixed

Boolean flag indicating that this configuration object is immutable.

Constructor Detail

AbstractJobConfiguration

public AbstractJobConfiguration()

Constructor of an abstract job configuration.

Method Detail

validateAndFreeze

public void validateAndFreeze()
                       throws InvalidWorkflowJobConfigurationException

The last method to call by any builder or code creating an configuration for the workflow engine. The configuration will be checked and if the check is successful it cannot be changed any longer. If check fails it throws an Exception.

Throws:

InvalidWorkflowJobConfigurationException - the invalid workflow job configuration

isFrozen

public boolean isFrozen()

Get the status of this configuration. If it is frozen, it cannot be changed any longer and hence is ready to be passed to the workflow engine.

Returns:

Whether the configuration can still be changed

checkFixed

protected void checkFixed()

Used in setter methods to check whether the object can still be modified.

getErrorMessage

public abstract String getErrorMessage()

Description copied from interface: IJobConfiguration

Gets the error message.

Specified by:

getErrorMessage in interface IJobConfiguration

Returns:

An error message for the user if the configuration is not valid or null if it is valid

isValid

public boolean isValid()

Description copied from interface: IJobConfiguration

Checks if is valid.

Specified by:

isValid in interface IJobConfiguration

Returns:

true if the configuration is valid and can be executed, false otherwise

setDefaults

public abstract void setDefaults()

Description copied from interface: IJobConfiguration

Sets usefull default values for the configuration object.

Specified by:

setDefaults in interface IJobConfiguration

clone

protected Object clone()
                throws CloneNotSupportedException

Overrides:

clone in class Object

Throws:

CloneNotSupportedException