Records one step in the lifecycle history of a ProductOrder, such as being added to a cart, ordered, shipped or cancelled. A ProductOrder accumulates one ProductOrderStatus row every time its status changes, giving a full audit trail of the order's progress. Status codes are free-text, application-defined values such as "added" or "ordered" rather than a fixed enumeration.
Group: Database Entities
Implements: Serializable, Relational
Properties
| Property | Returns | Description |
|---|---|---|
| adminOrg | Organisation | The organisation that owns the order this status belongs to. |
| description | String | A human-readable description of this status, such as "Order placed" or "Added to cart". |
| id | long | The database identifier of this status record. |
| productOrder | ProductOrder | The order this status record belongs to. |
| refCode | String | An optional reference code associated with this status, for example a shipment tracking number. |
| statusCode | String | The application-defined code identifying this lifecycle step, such as "added" or "ordered". Not a fixed enumeration - callers are free to define their own status codes for a given workflow. |
| statusDate | Date | The date and time this status took effect. |
Methods
getId() · getAdminOrg() · setAdminOrg(Organisation adminOrg) · getProductOrder() · setProductOrder(ProductOrder productOrder) · getStatusDate() · setStatusDate(Date statusDate) · getStatusCode() · setStatusCode(String statusCode) · getDescription() · setDescription(String description) · getRefCode() · setRefCode(String refCode) · rowId()
getId()
Returns: long
The database identifier of this status record.
getAdminOrg()
Returns: Organisation
The organisation that owns the order this status belongs to.
setAdminOrg(Organisation adminOrg)
Returns: void
Sets the organisation that owns the order this status belongs to.
| Parameter | Description |
|---|---|
adminOrg | the owning organisation |
getProductOrder()
Returns: ProductOrder
The order this status record belongs to.
setProductOrder(ProductOrder productOrder)
Returns: void
Sets the order this status record belongs to.
| Parameter | Description |
|---|---|
productOrder | the order this status describes |
getStatusDate()
Returns: Date
The date and time this status took effect.
setStatusDate(Date statusDate)
Returns: void
Sets the date and time this status took effect.
| Parameter | Description |
|---|---|
statusDate | the date this status was recorded |
getStatusCode()
Returns: String
The application-defined code identifying this lifecycle step, such as "added" or "ordered". Not a fixed enumeration - callers are free to define their own status codes for a given workflow.
setStatusCode(String statusCode)
Returns: void
Sets the application-defined code identifying this lifecycle step.
| Parameter | Description |
|---|---|
statusCode | the status code |
getDescription()
Returns: String
A human-readable description of this status, such as "Order placed" or "Added to cart".
setDescription(String description)
Returns: void
Sets the human-readable description of this status.
| Parameter | Description |
|---|---|
description | the status description |
getRefCode()
Returns: String
An optional reference code associated with this status, for example a shipment tracking number.
setRefCode(String refCode)
Returns: void
Sets the optional reference code associated with this status, for example a shipment tracking number.
| Parameter | Description |
|---|---|
refCode | the reference code |
rowId()
Returns: Long
The database identifier of this status record, as required by the Relational interface.