Skip to content

Commit

Permalink
PI-2525 Update recall domain events docs (#4274)
Browse files Browse the repository at this point in the history
Closes #4200
  • Loading branch information
marcus-bcl authored Oct 3, 2024
1 parent 036a93a commit 678f3a5
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
13 changes: 8 additions & 5 deletions projects/make-recall-decisions-and-delius/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,14 @@ Allocation domain events are raised in real time as probation cases are
allocated to a practitioner. The individual elements of the case are raised as
separate events.

| Business Event | Message Class | Message Event Type / Filter |
|--------------------------------|--------------------|-----------------------------------------------------|
| Recommendation Process Started | HMPPS Domain Event | "prison-recall.recommendation.started" |
| Management Oversight of Recall | HMPPS Domain Event | "prison-recall.recommendation.management-oversight" |
| Recall being considered | HMPPS Domain Event | "prison-recall.recommendation.consideration" |
| Business Event | Message Class | Message Event Type / Filter |
|-----------------------------------|--------------------|-----------------------------------------------------|
| Recall being considered | HMPPS Domain Event | "prison-recall.recommendation.consideration" |
| Recall decision has been made | HMPPS Domain Event | "prison-recall.recommendation.management-oversight" |
| Recommendation deleted or expired | HMPPS Domain Event | "prison-recall.recommendation.deleted" |

For more details of asynchronous events used by this service, see
the [AsyncAPI Reference](https://ministryofjustice.github.io/hmpps-probation-integration-services/tech-docs/projects/make-recall-decisions-and-delius/asyncapi-reference.html)

## Authorisation

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
package uk.gov.justice.digital.hmpps.messaging

import org.openfolder.kotlinasyncapi.annotation.Schema
import org.openfolder.kotlinasyncapi.annotation.channel.Channel
import org.openfolder.kotlinasyncapi.annotation.channel.Message
import org.openfolder.kotlinasyncapi.annotation.channel.Publish
Expand All @@ -24,12 +23,9 @@ class Handler(
) : NotificationHandler<HmppsDomainEvent> {
@Publish(
messages = [
Message(name = "consider-a-recall/management_oversight"),
Message(title = "prison-recall.recommendation.deleted", payload = Schema(HmppsDomainEvent::class)),
Message(
title = "prison-recall.recommendation.consideration",
payload = Schema(HmppsDomainEvent::class)
),
Message(name = "consider-a-recall/recommendation-consideration"),
Message(name = "consider-a-recall/recommendation-management-oversight"),
Message(name = "consider-a-recall/recommendation-deleted"),
]
)
override fun handle(notification: Notification<HmppsDomainEvent>) {
Expand Down

0 comments on commit 678f3a5

Please sign in to comment.