To get full access to the Kademi Hub existing customers can login here, or new customers can register here.
Holds the current progress of a background job, so a client can poll it while the job is still running. There is at most one status row per AsyncJob, and it is updated in place as the job runs rather than appended to, so it shows the latest state and not a history. It is deliberately not second level cached, because a stale reading would report progress that has already moved on. The state data field carries an XML encoded map for handing structured results back to the client, capped at MAX_STATUS_DATA_LENGTH characters.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| id | long | Database identifier for this status record, assigned when it is first saved. |
| job | AsyncJob | The background job this status belongs to. Never null, and a job has at most one status row. |
| stateData | String | XML encoded map of data the job wants to hand back to the client, for example counts or a reference to a result file. Limited to MAX_STATUS_DATA_LENGTH characters, so it is not a place for bulk output. |
| status | String | Short, user friendly message describing how far the job has got, suitable for showing in a progress display. Limited to 255 characters. |
Methods
getId()
Returns: long
Database identifier for this status record, assigned when it is first saved.
getJob()
Returns: AsyncJob
The background job this status belongs to. Never null, and a job has at most one status row.
getStatus()
Returns: String
Short, user friendly message describing how far the job has got, suitable for showing in a progress display. Limited to 255 characters.
getStateData()
Returns: String
XML encoded map of data the job wants to hand back to the client, for example counts or a reference to a result file. Limited to MAX_STATUS_DATA_LENGTH characters, so it is not a place for bulk output.
© 2025 Kademi Ltd