com.novell.db.object.bean
Class BackupCommandBean

java.lang.Object
  com.novell.sentinel.client.bean.SentinelBean
      com.novell.db.object.bean.BackupCommandBean

public class BackupCommandBean
extends SentinelBean

An automatically-generated "bean" class for the Sentinel data object type 'backup-command'.

The description of the type is:

"null"

The Sentinel data object bean classes are designed to be used to transport data to and from the Sentinel server. There exists a supporting infrastructure that handles the serialization/parsing of the data to/from the JSON transport format and which handles the actual HTTP transport.

A more complete description of Sentinel data object beans is found in the description of SentinelBean.

See Also:

SentinelBean, BeanTransporter

Field Summary

static String	COMMANDID The "bean name" of the Sentinel data object field 'CommandId'.
static String	COMMANDNAME The "bean name" of the Sentinel data object field 'CommandName'.
static String	DESTINATIONDIRECTORY The "bean name" of the Sentinel data object field 'DestinationDirectory'.
static String	DESTINATIONFILE The "bean name" of the Sentinel data object field 'DestinationFile'.
static String	DONEFILE The "bean name" of the Sentinel data object field 'DoneFile'.
static String	OPTIONS The "bean name" of the Sentinel data object field 'Options'.
static String	PARTITIONRANGE The "bean name" of the Sentinel data object field 'PartitionRange'.
static String	SOURCEDIRECTORY The "bean name" of the Sentinel data object field 'SourceDirectory'.
static String	SOURCEFILE The "bean name" of the Sentinel data object field 'SourceFile'.

Constructor Summary

	BackupCommandBean() Construct an instance of the bean class.
protected	BackupCommandBean(BeanMetaData<? extends SentinelBean> metadata) Constructor for use by derived classes.

Method Summary

void	clearCommandId() Clear any current value for the 'CommandId' field in the bean.
void	clearCommandName() Clear any current value for the 'command-name' field in the bean.
void	clearDestinationDirectory() Clear any current value for the 'dest-dir' field in the bean.
void	clearDestinationFile() Clear any current value for the 'dest-file' field in the bean.
void	clearDoneFile() Clear any current value for the 'done-file' field in the bean.
void	clearOptions() Clear any current value for the 'options' field in the bean.
void	clearPartitionRange() Clear any current value for the 'part-range' field in the bean.
void	clearSourceDirectory() Clear any current value for the 'src-dir' field in the bean.
void	clearSourceFile() Clear any current value for the 'src-file' field in the bean.
BackupCommandBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends BackupCommandBean>	getBeanMetaData() Get the metadata class instance for this type.
long	getCommandId() Get the value for the 'CommandId' field.
String	getCommandName() Get the value for the 'command-name' field.
String	getDestinationDirectory() Get the value for the 'dest-dir' field.
String	getDestinationFile() Get the value for the 'dest-file' field.
String	getDoneFile() Get the value for the 'done-file' field.
String	getOptions() Get the value for the 'options' field.
String	getPartitionRange() Get the value for the 'part-range' field.
String	getSourceDirectory() Get the value for the 'src-dir' field.
String	getSourceFile() Get the value for the 'src-file' field.
boolean	isCommandIdClear() Get whether the value for the 'CommandId' field is clear or not.
boolean	isCommandIdNull() Get whether the 'CommandId' field has been set to Null or not.
boolean	isCommandNameClear() Get whether the value for the 'command-name' field is clear or not.
boolean	isCommandNameNull() Get whether the 'command-name' field has been set to Null or not.
boolean	isDestinationDirectoryClear() Get whether the value for the 'dest-dir' field is clear or not.
boolean	isDestinationDirectoryNull() Get whether the 'dest-dir' field has been set to Null or not.
boolean	isDestinationFileClear() Get whether the value for the 'dest-file' field is clear or not.
boolean	isDestinationFileNull() Get whether the 'dest-file' field has been set to Null or not.
boolean	isDoneFileClear() Get whether the value for the 'done-file' field is clear or not.
boolean	isDoneFileNull() Get whether the 'done-file' field has been set to Null or not.
boolean	isOptionsClear() Get whether the value for the 'options' field is clear or not.
boolean	isOptionsNull() Get whether the 'options' field has been set to Null or not.
boolean	isPartitionRangeClear() Get whether the value for the 'part-range' field is clear or not.
boolean	isPartitionRangeNull() Get whether the 'part-range' field has been set to Null or not.
boolean	isSourceDirectoryClear() Get whether the value for the 'src-dir' field is clear or not.
boolean	isSourceDirectoryNull() Get whether the 'src-dir' field has been set to Null or not.
boolean	isSourceFileClear() Get whether the value for the 'src-file' field is clear or not.
boolean	isSourceFileNull() Get whether the 'src-file' field has been set to Null or not.
void	setCommandId(long commandId) Set the value for the 'CommandId' field.
void	setCommandIdNull() Set to Null any current value for the 'CommandId' field in the bean.
void	setCommandName(String commandName) Set the value for the 'command-name' field.
void	setCommandNameNull() Set to Null any current value for the 'command-name' field in the bean.
void	setDestinationDirectory(String destinationDirectory) Set the value for the 'dest-dir' field.
void	setDestinationDirectoryNull() Set to Null any current value for the 'dest-dir' field in the bean.
void	setDestinationFile(String destinationFile) Set the value for the 'dest-file' field.
void	setDestinationFileNull() Set to Null any current value for the 'dest-file' field in the bean.
void	setDoneFile(String doneFile) Set the value for the 'done-file' field.
void	setDoneFileNull() Set to Null any current value for the 'done-file' field in the bean.
void	setOptions(String options) Set the value for the 'options' field.
void	setOptionsNull() Set to Null any current value for the 'options' field in the bean.
void	setPartitionRange(String partitionRange) Set the value for the 'part-range' field.
void	setPartitionRangeNull() Set to Null any current value for the 'part-range' field in the bean.
void	setSourceDirectory(String sourceDirectory) Set the value for the 'src-dir' field.
void	setSourceDirectoryNull() Set to Null any current value for the 'src-dir' field in the bean.
void	setSourceFile(String sourceFile) Set the value for the 'src-file' field.
void	setSourceFileNull() Set to Null any current value for the 'src-file' field in the bean.

Methods inherited from class com.novell.sentinel.client.bean.SentinelBean

clearField, cloneBean, equals, fields, getBeanName, getBeanValue, getField, getFieldNoNull, getLink, getMetaData, isFieldClear, isFieldNull, isLinkClear, setField, setFieldNull, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

COMMANDID

public static final String COMMANDID

The "bean name" of the Sentinel data object field 'CommandId'. The value is ""CommandId"".

The description of the 'CommandId' field is:

"No description provided."

See Also:

Constant Field Values

PARTITIONRANGE

public static final String PARTITIONRANGE

The "bean name" of the Sentinel data object field 'PartitionRange'. The value is ""part-range"".

The description of the 'part-range' field is:

"No description provided."

See Also:

Constant Field Values

DONEFILE

public static final String DONEFILE

The "bean name" of the Sentinel data object field 'DoneFile'. The value is ""done-file"".

The description of the 'done-file' field is:

"No description provided."

See Also:

Constant Field Values

SOURCEDIRECTORY

public static final String SOURCEDIRECTORY

The "bean name" of the Sentinel data object field 'SourceDirectory'. The value is ""src-dir"".

The description of the 'src-dir' field is:

"No description provided."

See Also:

Constant Field Values

COMMANDNAME

public static final String COMMANDNAME

The "bean name" of the Sentinel data object field 'CommandName'. The value is ""command-name"".

The description of the 'command-name' field is:

"No description provided."

See Also:

Constant Field Values

DESTINATIONFILE

public static final String DESTINATIONFILE

The "bean name" of the Sentinel data object field 'DestinationFile'. The value is ""dest-file"".

The description of the 'dest-file' field is:

"No description provided."

See Also:

Constant Field Values

DESTINATIONDIRECTORY

public static final String DESTINATIONDIRECTORY

The "bean name" of the Sentinel data object field 'DestinationDirectory'. The value is ""dest-dir"".

The description of the 'dest-dir' field is:

"No description provided."

See Also:

Constant Field Values

SOURCEFILE

public static final String SOURCEFILE

The "bean name" of the Sentinel data object field 'SourceFile'. The value is ""src-file"".

The description of the 'src-file' field is:

"No description provided."

See Also:

Constant Field Values

OPTIONS

public static final String OPTIONS

The "bean name" of the Sentinel data object field 'Options'. The value is ""options"".

The description of the 'options' field is:

"No description provided."

See Also:

Constant Field Values

Constructor Detail

BackupCommandBean

public BackupCommandBean()

Construct an instance of the bean class.

BackupCommandBean

protected BackupCommandBean(BeanMetaData<? extends SentinelBean> metadata)

Constructor for use by derived classes.

Parameters:

metadata - The metadata instance for the derived bean class. Normally this constructor will only be called by generated code.

Method Detail

getCommandName

public String getCommandName()

Get the value for the 'command-name' field. The description of the 'command-name' field is:

"No description provided."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

COMMANDNAME

isCommandNameNull

public boolean isCommandNameNull()

Get whether the 'command-name' field has been set to Null or not. The description of the 'command-name' field is:

"No description provided."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setCommandNameNull(), COMMANDNAME

isCommandNameClear

public boolean isCommandNameClear()

Get whether the value for the 'command-name' field is clear or not. The description of the 'command-name' field is:

"No description provided."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearCommandName(), COMMANDNAME

setCommandName

public void setCommandName(String commandName)

Set the value for the 'command-name' field. The description of the 'command-name' field is:

"No description provided."

Parameters:

commandName - Value to set

See Also:

COMMANDNAME

clearCommandName

public void clearCommandName()

Clear any current value for the 'command-name' field in the bean. The description of the 'command-name' field is:

"No description provided."

Using this method will not clear the server value when the bean is PUT to the server. Use the setCommandNameNull() method to clear the server's value.

See the description of cleared values.

See Also:

COMMANDNAME

setCommandNameNull

public void setCommandNameNull()

Set to Null any current value for the 'command-name' field in the bean. The description of the 'command-name' field is:

"No description provided."

Using this method will clear the server value when the bean is PUT to the server. Use the clearCommandName() method to avoid clearing the server's value.

See the description of Null values.

See Also:

COMMANDNAME

getDestinationFile

public String getDestinationFile()

Get the value for the 'dest-file' field. The description of the 'dest-file' field is:

"No description provided."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

DESTINATIONFILE

isDestinationFileNull

public boolean isDestinationFileNull()

Get whether the 'dest-file' field has been set to Null or not. The description of the 'dest-file' field is:

"No description provided."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setDestinationFileNull(), DESTINATIONFILE

isDestinationFileClear

public boolean isDestinationFileClear()

Get whether the value for the 'dest-file' field is clear or not. The description of the 'dest-file' field is:

"No description provided."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearDestinationFile(), DESTINATIONFILE

setDestinationFile

public void setDestinationFile(String destinationFile)

Set the value for the 'dest-file' field. The description of the 'dest-file' field is:

"No description provided."

Parameters:

destinationFile - Value to set

See Also:

DESTINATIONFILE

clearDestinationFile

public void clearDestinationFile()

Clear any current value for the 'dest-file' field in the bean. The description of the 'dest-file' field is:

"No description provided."

Using this method will not clear the server value when the bean is PUT to the server. Use the setDestinationFileNull() method to clear the server's value.

See the description of cleared values.

See Also:

DESTINATIONFILE

setDestinationFileNull

public void setDestinationFileNull()

Set to Null any current value for the 'dest-file' field in the bean. The description of the 'dest-file' field is:

"No description provided."

Using this method will clear the server value when the bean is PUT to the server. Use the clearDestinationFile() method to avoid clearing the server's value.

See the description of Null values.

See Also:

DESTINATIONFILE

getSourceDirectory

public String getSourceDirectory()

Get the value for the 'src-dir' field. The description of the 'src-dir' field is:

"No description provided."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

SOURCEDIRECTORY

isSourceDirectoryNull

public boolean isSourceDirectoryNull()

Get whether the 'src-dir' field has been set to Null or not. The description of the 'src-dir' field is:

"No description provided."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setSourceDirectoryNull(), SOURCEDIRECTORY

isSourceDirectoryClear

public boolean isSourceDirectoryClear()

Get whether the value for the 'src-dir' field is clear or not. The description of the 'src-dir' field is:

"No description provided."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearSourceDirectory(), SOURCEDIRECTORY

setSourceDirectory

public void setSourceDirectory(String sourceDirectory)

Set the value for the 'src-dir' field. The description of the 'src-dir' field is:

"No description provided."

Parameters:

sourceDirectory - Value to set

See Also:

SOURCEDIRECTORY

clearSourceDirectory

public void clearSourceDirectory()

Clear any current value for the 'src-dir' field in the bean. The description of the 'src-dir' field is:

"No description provided."

Using this method will not clear the server value when the bean is PUT to the server. Use the setSourceDirectoryNull() method to clear the server's value.

See the description of cleared values.

See Also:

SOURCEDIRECTORY

setSourceDirectoryNull

public void setSourceDirectoryNull()

Set to Null any current value for the 'src-dir' field in the bean. The description of the 'src-dir' field is:

"No description provided."

Using this method will clear the server value when the bean is PUT to the server. Use the clearSourceDirectory() method to avoid clearing the server's value.

See the description of Null values.

See Also:

SOURCEDIRECTORY

getSourceFile

public String getSourceFile()

Get the value for the 'src-file' field. The description of the 'src-file' field is:

"No description provided."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

SOURCEFILE

isSourceFileNull

public boolean isSourceFileNull()

Get whether the 'src-file' field has been set to Null or not. The description of the 'src-file' field is:

"No description provided."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setSourceFileNull(), SOURCEFILE

isSourceFileClear

public boolean isSourceFileClear()

Get whether the value for the 'src-file' field is clear or not. The description of the 'src-file' field is:

"No description provided."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearSourceFile(), SOURCEFILE

setSourceFile

public void setSourceFile(String sourceFile)

Set the value for the 'src-file' field. The description of the 'src-file' field is:

"No description provided."

Parameters:

sourceFile - Value to set

See Also:

SOURCEFILE

clearSourceFile

public void clearSourceFile()

Clear any current value for the 'src-file' field in the bean. The description of the 'src-file' field is:

"No description provided."

Using this method will not clear the server value when the bean is PUT to the server. Use the setSourceFileNull() method to clear the server's value.

See the description of cleared values.

See Also:

SOURCEFILE

setSourceFileNull

public void setSourceFileNull()

Set to Null any current value for the 'src-file' field in the bean. The description of the 'src-file' field is:

"No description provided."

Using this method will clear the server value when the bean is PUT to the server. Use the clearSourceFile() method to avoid clearing the server's value.

See the description of Null values.

See Also:

SOURCEFILE

getPartitionRange

public String getPartitionRange()

Get the value for the 'part-range' field. The description of the 'part-range' field is:

"No description provided."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

PARTITIONRANGE

isPartitionRangeNull

public boolean isPartitionRangeNull()

Get whether the 'part-range' field has been set to Null or not. The description of the 'part-range' field is:

"No description provided."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setPartitionRangeNull(), PARTITIONRANGE

isPartitionRangeClear

public boolean isPartitionRangeClear()

Get whether the value for the 'part-range' field is clear or not. The description of the 'part-range' field is:

"No description provided."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearPartitionRange(), PARTITIONRANGE

setPartitionRange

public void setPartitionRange(String partitionRange)

Set the value for the 'part-range' field. The description of the 'part-range' field is:

"No description provided."

Parameters:

partitionRange - Value to set

See Also:

PARTITIONRANGE

clearPartitionRange

public void clearPartitionRange()

Clear any current value for the 'part-range' field in the bean. The description of the 'part-range' field is:

"No description provided."

Using this method will not clear the server value when the bean is PUT to the server. Use the setPartitionRangeNull() method to clear the server's value.

See the description of cleared values.

See Also:

PARTITIONRANGE

setPartitionRangeNull

public void setPartitionRangeNull()

Set to Null any current value for the 'part-range' field in the bean. The description of the 'part-range' field is:

"No description provided."

Using this method will clear the server value when the bean is PUT to the server. Use the clearPartitionRange() method to avoid clearing the server's value.

See the description of Null values.

See Also:

PARTITIONRANGE

getDoneFile

public String getDoneFile()

Get the value for the 'done-file' field. The description of the 'done-file' field is:

"No description provided."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

DONEFILE

isDoneFileNull

public boolean isDoneFileNull()

Get whether the 'done-file' field has been set to Null or not. The description of the 'done-file' field is:

"No description provided."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setDoneFileNull(), DONEFILE

isDoneFileClear

public boolean isDoneFileClear()

Get whether the value for the 'done-file' field is clear or not. The description of the 'done-file' field is:

"No description provided."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearDoneFile(), DONEFILE

setDoneFile

public void setDoneFile(String doneFile)

Set the value for the 'done-file' field. The description of the 'done-file' field is:

"No description provided."

Parameters:

doneFile - Value to set

See Also:

DONEFILE

clearDoneFile

public void clearDoneFile()

Clear any current value for the 'done-file' field in the bean. The description of the 'done-file' field is:

"No description provided."

Using this method will not clear the server value when the bean is PUT to the server. Use the setDoneFileNull() method to clear the server's value.

See the description of cleared values.

See Also:

DONEFILE

setDoneFileNull

public void setDoneFileNull()

Set to Null any current value for the 'done-file' field in the bean. The description of the 'done-file' field is:

"No description provided."

Using this method will clear the server value when the bean is PUT to the server. Use the clearDoneFile() method to avoid clearing the server's value.

See the description of Null values.

See Also:

DONEFILE

getCommandId

public long getCommandId()

Get the value for the 'CommandId' field. The description of the 'CommandId' field is:

"No description provided."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

COMMANDID

isCommandIdNull

public boolean isCommandIdNull()

Get whether the 'CommandId' field has been set to Null or not. The description of the 'CommandId' field is:

"No description provided."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setCommandIdNull(), COMMANDID

isCommandIdClear

public boolean isCommandIdClear()

Get whether the value for the 'CommandId' field is clear or not. The description of the 'CommandId' field is:

"No description provided."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearCommandId(), COMMANDID

setCommandId

public void setCommandId(long commandId)

Set the value for the 'CommandId' field. The description of the 'CommandId' field is:

"No description provided."

Parameters:

commandId - Value to set

See Also:

COMMANDID

clearCommandId

public void clearCommandId()

Clear any current value for the 'CommandId' field in the bean. The description of the 'CommandId' field is:

"No description provided."

Using this method will not clear the server value when the bean is PUT to the server. Use the setCommandIdNull() method to clear the server's value.

See the description of cleared values.

See Also:

COMMANDID

setCommandIdNull

public void setCommandIdNull()

Set to Null any current value for the 'CommandId' field in the bean. The description of the 'CommandId' field is:

"No description provided."

Using this method will clear the server value when the bean is PUT to the server. Use the clearCommandId() method to avoid clearing the server's value.

See the description of Null values.

See Also:

COMMANDID

getDestinationDirectory

public String getDestinationDirectory()

Get the value for the 'dest-dir' field. The description of the 'dest-dir' field is:

"No description provided."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

DESTINATIONDIRECTORY

isDestinationDirectoryNull

public boolean isDestinationDirectoryNull()

Get whether the 'dest-dir' field has been set to Null or not. The description of the 'dest-dir' field is:

"No description provided."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setDestinationDirectoryNull(), DESTINATIONDIRECTORY

isDestinationDirectoryClear

public boolean isDestinationDirectoryClear()

Get whether the value for the 'dest-dir' field is clear or not. The description of the 'dest-dir' field is:

"No description provided."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearDestinationDirectory(), DESTINATIONDIRECTORY

setDestinationDirectory

public void setDestinationDirectory(String destinationDirectory)

Set the value for the 'dest-dir' field. The description of the 'dest-dir' field is:

"No description provided."

Parameters:

destinationDirectory - Value to set

See Also:

DESTINATIONDIRECTORY

clearDestinationDirectory

public void clearDestinationDirectory()

Clear any current value for the 'dest-dir' field in the bean. The description of the 'dest-dir' field is:

"No description provided."

Using this method will not clear the server value when the bean is PUT to the server. Use the setDestinationDirectoryNull() method to clear the server's value.

See the description of cleared values.

See Also:

DESTINATIONDIRECTORY

setDestinationDirectoryNull

public void setDestinationDirectoryNull()

Set to Null any current value for the 'dest-dir' field in the bean. The description of the 'dest-dir' field is:

"No description provided."

Using this method will clear the server value when the bean is PUT to the server. Use the clearDestinationDirectory() method to avoid clearing the server's value.

See the description of Null values.

See Also:

DESTINATIONDIRECTORY

getOptions

public String getOptions()

Get the value for the 'options' field. The description of the 'options' field is:

"No description provided."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

OPTIONS

isOptionsNull

public boolean isOptionsNull()

Get whether the 'options' field has been set to Null or not. The description of the 'options' field is:

"No description provided."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setOptionsNull(), OPTIONS

isOptionsClear

public boolean isOptionsClear()

Get whether the value for the 'options' field is clear or not. The description of the 'options' field is:

"No description provided."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearOptions(), OPTIONS

setOptions

public void setOptions(String options)

Set the value for the 'options' field. The description of the 'options' field is:

"No description provided."

Parameters:

options - Value to set

See Also:

OPTIONS

clearOptions

public void clearOptions()

Clear any current value for the 'options' field in the bean. The description of the 'options' field is:

"No description provided."

Using this method will not clear the server value when the bean is PUT to the server. Use the setOptionsNull() method to clear the server's value.

See the description of cleared values.

See Also:

OPTIONS

setOptionsNull

public void setOptionsNull()

Set to Null any current value for the 'options' field in the bean. The description of the 'options' field is:

"No description provided."

Using this method will clear the server value when the bean is PUT to the server. Use the clearOptions() method to avoid clearing the server's value.

See the description of Null values.

See Also:

OPTIONS

getBeanMetaData

public static BeanMetaData<? extends BackupCommandBean> getBeanMetaData()

Get the metadata class instance for this type.

The metadata is used primarily as a parameter to a BeanTransporter implementation''s constructor.

clone

public BackupCommandBean clone()

Create a duplicate of this bean instance, including all field values.

Overrides:

clone in class Object