BackupJobConfiguration (Cumulus Java Classes Documentation)

java.lang.Object
- com.canto.cumulus.prefs.BaseManager
- - com.canto.cumulus.prefs.BackupJobConfiguration

```
public class BackupJobConfiguration
extends BaseManager
```
This class manages the configuration of a single backup job.

Since:

8.0

See Also:
BackupJob.getJobConfiguration()

Nested Class Summary
- Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager
  BaseManager.PackEntryChangeListener, BaseManager.RegistryEntry

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BACKUP_COLLECTION_DELETE_EMPTY_FLAG`
`static int`	`BACKUP_COLLECTION_DELETE_OLDER_THAN_DAYS_FLAG`
`static int`	`BACKUP_MODE_OPTION_ALL_CATALOGS`
`static int`	`BACKUP_MODE_OPTION_CONFIGURATION`
`static int`	`BACKUP_MODE_OPTION_SPECIFIED_CATALOGS`
`static int`	`TIME_SPECIFICATION_MODE_OPTION_CRON`
`static int`	`TIME_SPECIFICATION_MODE_OPTION_SIMPLE`

Fields inherited from class com.canto.cumulus.prefs.BaseManager
TYPE_EJP, TYPE_NATIVE

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`deleteCollectionsAfterDays()` Returns whether the backup should delete collections that are older than a number of days, see `getCollectionAgeDays()`.
`boolean`	`deleteEmptyCollections()` Returns whether the backup should delete empty collections.
`boolean`	`getAppendBackupTimeToFilename()` Returns whether the backup destination filename should always contain the time of backup.
`int`	`getBackupMode()` Returns the backup mode.
`CatalogList`	`getCatalogList()` Returns the list of catalogs that the job should work on if `getBackupMode()` returns `BACKUP_MODE_OPTION_SPECIFIED_CATALOGS`.
`int`	`getCollectionAgeDays()` Returns the age in days for collections, see `deleteCollectionsAfterDays()`.
`java.lang.String`	`getCronText()` Returns the current CRON mode configuration string.
`java.lang.String`	`getDestinationFolder()` Returns the destination folder for the created backups.
`int`	`getSimpleModeNthWeekRepetition()` Returns the number of weeks between backups configured for simple mode backup.
`int`	`getSimpleSpecDaysOfWeek()` Returns an int representing the days the job should run.
`int`	`getStartTime()` Returns the start date for this job.
`int`	`getTimeSpecificationMode()` Returns the mode this backup job uses for determining the next start date.
`boolean`	`isActive()` Returns whether this backup job is active.
`boolean`	`isExecuteNow()` Returns true if this job should be started immediately by the server ignoring the currently stored start date.
`boolean`	`sameConfiguration(BackupJobConfiguration jobConfiguration)` Returns whether the given jobs configuration equals this jobs configuration.
`void`	`setActive(boolean active)` Sets whether this backup job should be active.
`void`	`setAppendBackupTimeToFilename(boolean value)` Sets whether the backup destination filename should always contain the time of backup.
`void`	`setBackupMode(int value)` Sets the backup mode.
`void`	`setCollectionAgeDays(int collectionAgeDays)` Sets the age in days for collections, see `deleteCollectionsAfterDays()`.
`void`	`setCronText(java.lang.String text)` Sets a new CRON mode configuration string.
`void`	`setDeleteCollectionsAfterDays(boolean deleteCollectionsAfterDays)` Sets whether the backup should delete collections that are older than a number of days, see `getCollectionAgeDays()`.
`void`	`setDeleteEmptyCollections(boolean deleteEmptyCollections)` Sets whether the backup should delete empty collections.
`void`	`setDestinationFolder(java.lang.String value)` Sets the destination folder for the created backups.
`void`	`setExecuteNow(boolean start)` Configures whether this job should be started immediately by the server ignoring the currently stored start date.
`void`	`setSimpleModeNthWeekRepetition(int value)` Sets the number of weeks between backups to use for simple mode backup.
`void`	`setSimpleSpecDaysOfWeek(int val)` Sets the days the job should run.
`void`	`setStartTime(int time)` Sets the start time this job should run the first time.
`void`	`setTimeSpecificationMode(int mode)` Sets the mode this backup job uses for determining the next start date.

Methods inherited from class com.canto.cumulus.prefs.BaseManager
addChangeListener, addChangeListener, addGlobalChangeListener, addPackListener, forgetPush, getPack, isShared, popPack, pushPack, removeChangeListener, removeChangeListener, removeGlobalChangeListener, removePackListener, save, save, toString, writeAsXML

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - BACKUP_MODE_OPTION_CONFIGURATION
```
public static final int BACKUP_MODE_OPTION_CONFIGURATION
```
    See Also:
    Constant Field Values
  - BACKUP_MODE_OPTION_ALL_CATALOGS
```
public static final int BACKUP_MODE_OPTION_ALL_CATALOGS
```
    See Also:
    Constant Field Values
  - BACKUP_MODE_OPTION_SPECIFIED_CATALOGS
```
public static final int BACKUP_MODE_OPTION_SPECIFIED_CATALOGS
```
    See Also:
    Constant Field Values
  - TIME_SPECIFICATION_MODE_OPTION_SIMPLE
```
public static final int TIME_SPECIFICATION_MODE_OPTION_SIMPLE
```
    See Also:
    Constant Field Values
  - TIME_SPECIFICATION_MODE_OPTION_CRON
```
public static final int TIME_SPECIFICATION_MODE_OPTION_CRON
```
    See Also:
    Constant Field Values
  - BACKUP_COLLECTION_DELETE_OLDER_THAN_DAYS_FLAG
```
public static final int BACKUP_COLLECTION_DELETE_OLDER_THAN_DAYS_FLAG
```
    See Also:
    Constant Field Values
  - BACKUP_COLLECTION_DELETE_EMPTY_FLAG
```
public static final int BACKUP_COLLECTION_DELETE_EMPTY_FLAG
```
    See Also:
    Constant Field Values
- Method Detail
  - getBackupMode
```
public int getBackupMode()
```
    Returns the backup mode. Possible values are BACKUP_MODE_OPTION_ALL_CATALOGS, BACKUP_MODE_OPTION_CONFIGURATION and BACKUP_MODE_OPTION_SPECIFIED_CATALOGS.
    
    Returns:
    backup mode
  - setBackupMode
```
public void setBackupMode(int value)
```
    Sets the backup mode. Possible values are BACKUP_MODE_OPTION_ALL_CATALOGS, BACKUP_MODE_OPTION_CONFIGURATION and BACKUP_MODE_OPTION_SPECIFIED_CATALOGS.
    
    Parameters:
    value - backup mode
  - isActive
```
public boolean isActive()
```
    Returns whether this backup job is active.
    
    Returns:
    true if this job is active
  - setActive
```
public void setActive(boolean active)
```
    Sets whether this backup job should be active.
    
    Parameters:
    active - set to true if this job is active
  - isExecuteNow
```
public boolean isExecuteNow()
```
    Returns true if this job should be started immediately by the server ignoring the currently stored start date.
    
    Returns:
    true if this job should start immediately
  - setExecuteNow
```
public void setExecuteNow(boolean start)
```
    Configures whether this job should be started immediately by the server ignoring the currently stored start date.
    
    Parameters:
    start - specify true to make this job start immediately
  - getTimeSpecificationMode
```
public int getTimeSpecificationMode()
```
    Returns the mode this backup job uses for determining the next start date. The possible values are TIME_SPECIFICATION_MODE_OPTION_SIMPLE and TIME_SPECIFICATION_MODE_OPTION_CRON. Defaults to TIME_SPECIFICATION_MODE_OPTION_SIMPLE.
    
    Returns:
    mode this backup job uses for determining the next start date
  - setTimeSpecificationMode
```
public void setTimeSpecificationMode(int mode)
```
    Sets the mode this backup job uses for determining the next start date. The possible values are TIME_SPECIFICATION_MODE_OPTION_SIMPLE and TIME_SPECIFICATION_MODE_OPTION_CRON.
    
    Parameters:
    mode - mode this backup job uses for determining the next start date
  - getCronText
```
public java.lang.String getCronText()
```
    Returns the current CRON mode configuration string.
    
    Returns:
    string for the current CRON configuration
  - setCronText
```
public void setCronText(java.lang.String text)
```
    Sets a new CRON mode configuration string. The string is not validated, therefore invalid values will made this job unusable.
    
    Parameters:
    text - new CRON configuration
  - getCatalogList
```
public CatalogList getCatalogList()
```
    Returns the list of catalogs that the job should work on if getBackupMode() returns BACKUP_MODE_OPTION_SPECIFIED_CATALOGS.
    
    Returns:
    list of catalogs to work on
  - getSimpleSpecDaysOfWeek
```
public int getSimpleSpecDaysOfWeek()
```
    Returns an int representing the days the job should run. The days are encoded in the following way: Bit 0=Sunday, Bit 1=Monday,...,Bit 7=Saturday.
    
    Returns:
    the days the job should run
  - setSimpleSpecDaysOfWeek
```
public void setSimpleSpecDaysOfWeek(int val)
```
    Sets the days the job should run. The days are encoded into the int in the following way: Bit 0=Sunday, Bit 1=Monday,...,Bit 7=Saturday.
    
    Parameters:
    val - the days the job should run
  - getStartTime
```
public int getStartTime()
```
    Returns the start date for this job.
    
    Returns:
    date this job run for the first time.
  - setStartTime
```
public void setStartTime(int time)
```
    Sets the start time this job should run the first time.
    
    Parameters:
    time - the time to start this job
  - getDestinationFolder
```
public java.lang.String getDestinationFolder()
```
    Returns the destination folder for the created backups.
    
    Returns:
    destination folder for the backups of this job or null if not yet defined
  - setDestinationFolder
```
public void setDestinationFolder(java.lang.String value)
```
    Sets the destination folder for the created backups.
    
    Parameters:
    value - destination folder for the backups
  - getAppendBackupTimeToFilename
```
public boolean getAppendBackupTimeToFilename()
```
    Returns whether the backup destination filename should always contain the time of backup.
    
    Returns:
    true if the backup filename should contain the time of backup
  - setAppendBackupTimeToFilename
```
public void setAppendBackupTimeToFilename(boolean value)
```
    Sets whether the backup destination filename should always contain the time of backup.
    
    Parameters:
    value - true if the backup filename should contain the time of backup
  - getSimpleModeNthWeekRepetition
```
public int getSimpleModeNthWeekRepetition()
```
    Returns the number of weeks between backups configured for simple mode backup.
    
    Returns:
    number of weeks
  - setSimpleModeNthWeekRepetition
```
public void setSimpleModeNthWeekRepetition(int value)
```
    Sets the number of weeks between backups to use for simple mode backup.
    
    Parameters:
    value - number of weeks
  - deleteEmptyCollections
```
public boolean deleteEmptyCollections()
```
    Returns whether the backup should delete empty collections.
    
    Returns:
    true if empty collections should be deleted
    Since:
    
    11.1.3
  - setDeleteEmptyCollections
```
public void setDeleteEmptyCollections(boolean deleteEmptyCollections)
```
    Sets whether the backup should delete empty collections.
    
    Parameters:
    deleteEmptyCollections -
    Since:
    
    11.1.3
  - deleteCollectionsAfterDays
```
public boolean deleteCollectionsAfterDays()
```
    Returns whether the backup should delete collections that are older than a number of days, see getCollectionAgeDays().
    
    Returns:
    true if empty collections should be deleted
    Since:
    
    11.1.3
  - setDeleteCollectionsAfterDays
```
public void setDeleteCollectionsAfterDays(boolean deleteCollectionsAfterDays)
```
    Sets whether the backup should delete collections that are older than a number of days, see getCollectionAgeDays().
    
    Parameters:
    deleteCollectionsAfterDays -
    Since:
    
    11.1.3
  - setCollectionAgeDays
```
public void setCollectionAgeDays(int collectionAgeDays)
```
    Sets the age in days for collections, see deleteCollectionsAfterDays().
    
    Parameters:
    collectionAgeDays - age in days for collections
    Since:
    
    11.1.3
  - getCollectionAgeDays
```
public int getCollectionAgeDays()
```
    Returns the age in days for collections, see deleteCollectionsAfterDays().
    
    Returns:
    age in days for collections
    Since:
    
    11.1.3
  - sameConfiguration
```
public boolean sameConfiguration(BackupJobConfiguration jobConfiguration)
```
    Returns whether the given jobs configuration equals this jobs configuration.
    
    Parameters:
    jobConfiguration - the configuration to check for equality
    
    Returns:
    true if both configurations are identical

www.canto.com
Canto, the Canto logo, the Cumulus logo, and Cumulus are registered trademarks of Canto GmbH, registered in the U.S. and other countries.

Class BackupJobConfiguration

Nested Class Summary

Nested classes/interfaces inherited from class com.canto.cumulus.prefs.BaseManager

Field Summary

Fields inherited from class com.canto.cumulus.prefs.BaseManager

Method Summary

Methods inherited from class com.canto.cumulus.prefs.BaseManager

Methods inherited from class java.lang.Object

Field Detail

BACKUP_MODE_OPTION_CONFIGURATION

BACKUP_MODE_OPTION_ALL_CATALOGS

BACKUP_MODE_OPTION_SPECIFIED_CATALOGS

TIME_SPECIFICATION_MODE_OPTION_SIMPLE

TIME_SPECIFICATION_MODE_OPTION_CRON

BACKUP_COLLECTION_DELETE_OLDER_THAN_DAYS_FLAG

BACKUP_COLLECTION_DELETE_EMPTY_FLAG

Method Detail

getBackupMode

setBackupMode

isActive

setActive

isExecuteNow

setExecuteNow

getTimeSpecificationMode

setTimeSpecificationMode

getCronText

setCronText

getCatalogList

getSimpleSpecDaysOfWeek

setSimpleSpecDaysOfWeek

getStartTime

setStartTime

getDestinationFolder

setDestinationFolder

getAppendBackupTimeToFilename

setAppendBackupTimeToFilename

getSimpleModeNthWeekRepetition

setSimpleModeNthWeekRepetition

deleteEmptyCollections

setDeleteEmptyCollections

deleteCollectionsAfterDays

setDeleteCollectionsAfterDays

setCollectionAgeDays

getCollectionAgeDays

sameConfiguration