To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Tracks one restore of an organisation's data from a backup file, from the moment it is started through to the moment it finishes. A record is created with only its created date and creator, and the completed date is filled in when the restore finishes, so a record with no completed date is still running or failed. The file name and hash identify the backup file the data was read from, and file names are unique within an organisation.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| completedDate | Date | When the restore finished. Null while it is still running, or if it never completed. |
| createdBy | Profile | The administrator who started the restore. Never null. |
| createdDate | Date | When the restore was started, as a timestamp. Restores for an organisation are listed newest first by this value. |
| fileHash | String | Content hash of the backup file the data was restored from, which is how the file itself is fetched from the content store. |
| fileName | String | Name of the backup file the data was restored from, unique within the organisation and used to look the restore up. |
| id | long | The database identifier of this restore record. |
Methods
getId() · setOrganisation(Organisation organisation) · getCreatedDate() · setCreatedDate(Date createdDate) · getCreatedBy() · setCreatedBy(Profile createdBy) · getCompletedDate() · setCompletedDate(Date completedDate) · getFileName() · setFileName(String fileName) · getFileHash() · setFileHash(String fileHash)
getId()
Returns: long
The database identifier of this restore record.
setOrganisation(Organisation organisation)
Returns: void
Sets the organisation whose data is being restored.
| Parameter | Description |
|---|---|
organisation | the organisation the restore belongs to |
getCreatedDate()
Returns: Date
When the restore was started, as a timestamp. Restores for an organisation are listed newest first by this value.
setCreatedDate(Date createdDate)
Returns: void
Sets when the restore was started.
| Parameter | Description |
|---|---|
createdDate | the date and time the restore was started |
getCreatedBy()
Returns: Profile
The administrator who started the restore. Never null.
setCreatedBy(Profile createdBy)
Returns: void
Sets the administrator who started the restore.
| Parameter | Description |
|---|---|
createdBy | the profile that started the restore |
getCompletedDate()
Returns: Date
When the restore finished. Null while it is still running, or if it never completed.
setCompletedDate(Date completedDate)
Returns: void
Sets when the restore finished.
| Parameter | Description |
|---|---|
completedDate | the date and time the restore completed |
getFileName()
Returns: String
Name of the backup file the data was restored from, unique within the organisation and used to look the restore up.
setFileName(String fileName)
Returns: void
Sets the name of the backup file the data was restored from.
| Parameter | Description |
|---|---|
fileName | the backup file name, unique within the organisation |
getFileHash()
Returns: String
Content hash of the backup file the data was restored from, which is how the file itself is fetched from the content store.
setFileHash(String fileHash)
Returns: void
Sets the content hash of the backup file the data was restored from.
| Parameter | Description |
|---|---|
fileHash | the backup file's content hash |
© 2025 Kademi Ltd