org.eclipse.stardust.engine.api.runtime

Class DeploymentOptions

java.lang.Object

org.eclipse.stardust.engine.api.runtime.DeploymentOptions

All Implemented Interfaces:

Serializable

public class DeploymentOptions
extends Object
implements Serializable

Container class for the deployment options.

Version:

$Revision: $

Author:

Florin.Herinean

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static DeploymentOptions	DEFAULT Deployment options with default values: no comment, warning are not ignored, no validity restriction and 'overwrite' operations without an initial model are not allowed.

Constructor Summary

Constructors

Constructor and Description
DeploymentOptions()

Method Summary

Methods

Modifier and Type	Method and Description
String	getComment() Retrieves the deployment comment.
Date	getValidFrom() Retrieves the moment from when the deployed models will be valid.
boolean	isAllowOverwriteWithoutInitialModel() Retrieves if 'overwrite' operations without an initial model are allowed.
boolean	isIgnoreWarnings() Retrieves if the warnings should be ignored during deployment.
void	setAllowOverwriteWithoutInitialModel(boolean allowOverwriteWithoutInitialModel) Sets whether 'overwrite' operations without an initial model should be allowed.
void	setComment(String comment) Set the deployment comment.
void	setIgnoreWarnings(boolean ignoreWarnings) Sets that warnings should be ignored during deployment.
void	setValidFrom(Date validFrom) Sets the validity start time.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final DeploymentOptions DEFAULT

Deployment options with default values: no comment, warning are not ignored, no validity restriction and 'overwrite' operations without an initial model are not allowed.

Constructor Detail

DeploymentOptions

public DeploymentOptions()

Method Detail

getComment

public String getComment()

Retrieves the deployment comment.

Returns:

the comment, or null if not set.

setComment

public void setComment(String comment)

Set the deployment comment.

Parameters:

comment - the deployment comment.

getValidFrom

public Date getValidFrom()

Retrieves the moment from when the deployed models will be valid.

Returns:

the valid from timestamp, or null if there are no validity restrictions.

setValidFrom

public void setValidFrom(Date validFrom)

Sets the validity start time.

Parameters:

validFrom - the valid from timestamp or null if there are no validity restrictions.

isIgnoreWarnings

public boolean isIgnoreWarnings()

Retrieves if the warnings should be ignored during deployment.

Returns:

true if warning will be ignored. If false, warning will be treated like errors.

setIgnoreWarnings

public void setIgnoreWarnings(boolean ignoreWarnings)

Sets that warnings should be ignored during deployment.

Parameters:

ignoreWarnings - true to ignore warnings, false to treat warnings as errors.

isAllowOverwriteWithoutInitialModel

public boolean isAllowOverwriteWithoutInitialModel()

Retrieves if 'overwrite' operations without an initial model are allowed. If this option is set, the operation to perform is 'overwrite' and there's no initial model, a 'deploy' operation is done instead.

Returns:

whether 'overwrite' operations without an initial model are allowed

setAllowOverwriteWithoutInitialModel

public void setAllowOverwriteWithoutInitialModel(boolean allowOverwriteWithoutInitialModel)

Sets whether 'overwrite' operations without an initial model should be allowed. If this option is set, the operation to perform is 'overwrite' and there's no initial model, a 'deploy' operation is done instead.

Parameters:

allowOverwriteWithoutInitialModel - whether 'overwrite' operations without an initial model should be allowed