com.uc4.api.objects

Class Rollback

java.lang.Object

com.uc4.api.objects.Rollback

public class Rollback
extends java.lang.Object

This class represents the rollback tab on executable Automation Engine objects.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Rollback(com.uc4.util.XMLDocument doc) Constructs a Rollback object from the specified XMLDocument

Method Summary

Modifier and Type	Method and Description
java.lang.String	getBackupDirectory() Returns the backup directory or an empty String if not set.
UC4ObjectName	getBackupObject() Returns the UC4 Object for the backup or an empty instance if not set.
UC4ObjectName	getRollbackObject() Returns the UC4 Object for rollback.
boolean	isDeleteBeforeRestore() Returns true if the "Delete before restore" checkbox is selected in the User Interface.
boolean	isEnabled() Returns true if rollback is enabled for this object otherwise false.
boolean	isIncludeSubdirectories() Returns true if the "Include sub-directories" option is selected in the User Interface.
void	setBackupDirectory(java.lang.String backupDir) Sets the backup directory.
void	setBackupObject(UC4ObjectName backupObject) Sets the UC4 object for backup.
void	setDeleteBeforeRestore(boolean deleteBeforeRestore) Enables or disables the "Delete before restore" option.
void	setEnabled(boolean enabled) Enables or disables rollback.
void	setIncludeSubdirectories(boolean includeSubdirectories) Enables or disables the "Include sub-directories" option.
void	setRollbackObject(UC4ObjectName rollbackObject) Sets the rollback object.
protected void	store(com.uc4.util.XMLDocument doc, org.w3c.dom.Element objectElement) Stores the data of this class in the specified XML document

Methods inherited from class java.lang.Object

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

Constructor Detail

Rollback

protected Rollback(com.uc4.util.XMLDocument doc)

Constructs a Rollback object from the specified XMLDocument

Parameters:

doc - XML Document

Method Detail

isEnabled

public boolean isEnabled()

Returns true if rollback is enabled for this object otherwise false.

Returns:

Rollback enabled?

setEnabled

public void setEnabled(boolean enabled)

Enables or disables rollback.

Parameters:

enabled - true if rollback should be enabled

getBackupObject

public UC4ObjectName getBackupObject()

Returns the UC4 Object for the backup or an empty instance if not set.

Returns:

Backup object, never null

setBackupObject

public void setBackupObject(UC4ObjectName backupObject)

Sets the UC4 object for backup.

Parameters:

backupObject - Backup, null or an empty instance can be used to clear this field.

getRollbackObject

public UC4ObjectName getRollbackObject()

Returns the UC4 Object for rollback. This method does not return null.

Returns:

Rollback object or an empty UC4ObjectName instance if not set.

setRollbackObject

public void setRollbackObject(UC4ObjectName rollbackObject)

Sets the rollback object.

Parameters:

rollbackObject - null or an empty instance can be used to clear this field.

getBackupDirectory

public java.lang.String getBackupDirectory()

Returns the backup directory or an empty String if not set.

Returns:

Directory, never null

setBackupDirectory

public void setBackupDirectory(java.lang.String backupDir)

Sets the backup directory.

Parameters:

backupDir - Directory, null or an empty String can be used to clear this field.

isDeleteBeforeRestore

public boolean isDeleteBeforeRestore()

Returns true if the "Delete before restore" checkbox is selected in the User Interface.

Returns:

Delete before restore

setDeleteBeforeRestore

public void setDeleteBeforeRestore(boolean deleteBeforeRestore)

Enables or disables the "Delete before restore" option.

Parameters:

deleteBeforeRestore - Delete before restore

isIncludeSubdirectories

public boolean isIncludeSubdirectories()

Returns true if the "Include sub-directories" option is selected in the User Interface.

Returns:

Include sub directories?

setIncludeSubdirectories

public void setIncludeSubdirectories(boolean includeSubdirectories)

Enables or disables the "Include sub-directories" option.

Parameters:

includeSubdirectories - Include sub directories?

store

protected void store(com.uc4.util.XMLDocument doc,
                     org.w3c.dom.Element objectElement)

Stores the data of this class in the specified XML document

Parameters:

doc - Document

objectElement - Object element