Records one member's relationship with an alert: that the alert has been activated for them, and, once they dismiss it, that they have acknowledged it. A row with no ack date is an activation still waiting to be read, which is what makes the alert appear on the member's dashboard. Setting the ack date is what dismisses the alert and hides it from them. Rows are created automatically for most alerts, but alerts with a control state of event get an activation row created explicitly, optionally recording the EmailTrigger that raised it.
Group: Database Entities
Implements: Serializable
Properties
| Property | Returns | Description |
|---|---|---|
| ackDate | Date | When the member dismissed the alert. Null while the alert is still active for them, so a non-null value is what marks the alert as acknowledged and hides it. |
| alert | Alert | The alert this row relates to. Never null for a persisted row, and loaded lazily. |
| createdByTrigger | EmailTrigger | The email trigger which raised this activation, when the alert was activated by a trigger rather than automatically. Null otherwise, and loaded lazily. |
| createdDate | Date | When the alert was activated for this member, which is when the row was created. |
| id | long | The database identifier of this ack row. |
| profile | Profile | The member the alert was activated for, and who acknowledges it. Never null for a persisted row, and loaded lazily. |
Methods
getId() · getAckDate() · setAckDate(Date ackDate) · getAlert() · setAlert(Alert alert) · getProfile() · setProfile(Profile profile) · getCreatedByTrigger() · setCreatedByTrigger(EmailTrigger createdByTrigger) · getCreatedDate() · setCreatedDate(Date createdDate)
getId()
Returns: long
The database identifier of this ack row.
getAckDate()
Returns: Date
When the member dismissed the alert. Null while the alert is still active for them, so a non-null value is what marks the alert as acknowledged and hides it.
setAckDate(Date ackDate)
Returns: void
Sets the date the member dismissed the alert. Setting a date hides the alert from them.
| Parameter | Description |
|---|---|
ackDate | the acknowledgement date, or null to make the alert active again |
getAlert()
Returns: Alert
The alert this row relates to. Never null for a persisted row, and loaded lazily.
setAlert(Alert alert)
Returns: void
Sets the alert this row relates to.
| Parameter | Description |
|---|---|
alert | the alert being activated or acknowledged |
getProfile()
Returns: Profile
The member the alert was activated for, and who acknowledges it. Never null for a persisted row, and loaded lazily.
setProfile(Profile profile)
Returns: void
Sets the member the alert was activated for.
| Parameter | Description |
|---|---|
profile | the member this ack row belongs to |
getCreatedByTrigger()
Returns: EmailTrigger
The email trigger which raised this activation, when the alert was activated by a trigger rather than automatically. Null otherwise, and loaded lazily.
setCreatedByTrigger(EmailTrigger createdByTrigger)
Returns: void
Sets the email trigger which raised this activation.
| Parameter | Description |
|---|---|
createdByTrigger | the trigger which created this activation, or null for none |
getCreatedDate()
Returns: Date
When the alert was activated for this member, which is when the row was created.
setCreatedDate(Date createdDate)
Returns: void
Sets the date the alert was activated for this member.
| Parameter | Description |
|---|---|
createdDate | the activation date |