Oracle Workflow API Reference Release 2.6.3.5 Part Number B12163-02 |
Previous | Next | Contents | Index | Glossary |
function SEND
(role in varchar2,
msg_type in varchar2,
msg_name in varchar2,
due_date in date default null,
callback in varchar2 default null,
context in varchar2 default null,
send_comment in varchar2 default null
priority in number default null)
return number;
Java Syntax
public static BigDecimal send
(WFContext wCtx,
String role,
String messageType,
String messageName,
String dueDate,
String callback,
String context,
string sendComment,
BigDecimal priority)
Description
This function sends the specified message to a role, returning a notification ID if successful. The notification ID must be used in all future references to the notification.
If your message has message attributes, the procedure looks up the values of the attributes from the message attribute table or it can use an optionally supplied callback interface function to get the value from the item type attributes table. A callback function can also be used when a notification is responded to.
Note: If you are using the Oracle Workflow Notification System and its e-mail-based or web-based notification client, the Send procedure implicitly calls the WF_ENGINE.CB callback function. If you are using your own custom notification system that does not call the Workflow Engine, then you must define your own callback function following a standard format and specify its name for the callback argument. See: Custom Callback Function.
Arguments (input)
wCtx | Workflow context information. Required for the Java method only. See: Oracle Workflow Context. |
role | The role name assigned as the performer of the notification activity. |
msg_type or messageType | The item type associated with the message. |
msg_name or messageName | The message internal name. |
due_date or dueDate | The date that a response is required. This optional due date is only for the recipient's information; it has no effect on processing. |
callback | The callback function name used for communication of SEND and RESPOND source message attributes. |
context | Context information passed to the callback function. |
send_comment or sendComment | A comment presented with the message. |
priority | The priority of the message, as derived from the #PRIORITY notification activity attribute. If #PRIORITY does not exist or if the value is null, the Workflow Engine uses the default priority of the message. |
Previous | Next | Contents | Index | Glossary |