CancelGroup

PL/SQL Syntax

procedure CancelGroup
  (gid in number,
   cancel_comment in varchar2 default null,
   timeout in boolean default FALSE);

Description

This procedure may be invoked by the sender or administrator to cancel the individual copies of a specific notification sent to all users in a notification group. The notifications are identified by the notification group ID (gid). The notification status is then changed to 'CANCELED' but the rows are not removed from the WF_NOTIFICATIONS table until a purge operation is performed.

If the notification was delivered via e-mail and expects a response, a 'Canceled' e-mail is sent to the original recipient as a warning that the notification is no longer valid.

Note: You can optionally use the Send E-mails for Canceled Notifications mailer parameter to prevent notification mailers from sending any notification cancellation messages. See: Notification Mailer Configuration Wizard.

Generally, this function is called only if a notification activity has 'Expanded Roles' checked in its properties page. If Expanded Roles is not checked, then the Cancel() function is called instead. See: Voting Activity.

Arguments (input)

gid The notification group ID.
cancel_comment An optional comment on the cancellation.
timeout Specify TRUE or FALSE to indicate whether the cancellation was caused by a timeout event.