Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.7.0)
E25378-07

oracle.bpel.services.notification
Class NotificationService

java.lang.Object
  extended by oracle.bpel.services.notification.NotificationService

public class NotificationService
extends java.lang.Object

Since:
release specific (what release of product did this appear in)

Constructor Summary
NotificationService()
           
 
Method Summary
static org.w3c.dom.Element getChildElement(org.w3c.dom.Element parent, java.lang.String childElementName)
          Describe getChildElement method here.
static ServiceStatus getStatus()
          gets notification status
static IArrayOfResponseType sendEmailNotification(IEmailPayloadType payload)
          Sends Email Notification
static IArrayOfResponseType sendEmailNotification(java.lang.String caller, java.lang.String taskId, IEmailPayloadType payload)
          Sends Email Notification
static IArrayOfResponseType sendFaxNotification(IFaxPayloadType payload)
          Sends Fax Notification
static IArrayOfResponseType sendFaxNotification(java.lang.String caller, java.lang.String taskId, IFaxPayloadType payload)
          Sends Fax Notification
static IArrayOfResponseType sendIMNotification(IIMPayloadType payload)
          Sends IM Notification
static IArrayOfResponseType sendIMNotification(java.lang.String caller, java.lang.String taskId, IIMPayloadType payload)
          Sends IM Notification
static IArrayOfResponseType sendNotifications(java.lang.String[] userIds, java.lang.String[] groupIds, java.lang.String caller, java.lang.String taskId, IGenericPayloadType genericPayload)
           
static IArrayOfResponseType sendNotificationToGroup(IGroupNotificationPayloadType payload)
          Sends notification to a Group
static IArrayOfResponseType sendNotificationToGroup(java.lang.String caller, java.lang.String taskId, IGroupNotificationPayloadType payload)
          Sends notification to a Group
static IArrayOfResponseType sendNotificationToUser(IUserNotificationPayloadType payload)
          Sends notification to a user
static IArrayOfResponseType sendNotificationToUser(java.lang.String caller, java.lang.String taskId, IUserNotificationPayloadType payload)
          Sends notification to a user
static IArrayOfResponseType sendPagerNotification(IPagerPayloadType payload)
          Sends pager Notification
static IArrayOfResponseType sendPagerNotification(java.lang.String caller, java.lang.String taskId, IPagerPayloadType payload)
          Sends pager Notification
static IArrayOfResponseType sendSMSNotification(ISMSPayloadType payload)
          Sends SMS Notification
static IArrayOfResponseType sendSMSNotification(java.lang.String caller, java.lang.String taskId, ISMSPayloadType payload)
          Sends SMS Notification
static IArrayOfResponseType sendURINotification(IURIPayloadType payload)
          Sends URI Notification
static IArrayOfResponseType sendURINotification(java.lang.String caller, java.lang.String taskId, IURIPayloadType payload)
          Sends URI Notification
static IArrayOfResponseType sendVoiceNotification(IVoicePayloadType payload)
          Sends Voice Notification
static IArrayOfResponseType sendVoiceNotification(java.lang.String caller, java.lang.String taskId, IVoicePayloadType payload)
          Sends Voice Notification
static void shutdown()
          Stops Notification Service
static void startup()
          Starts the timer agent, to schedule error notification retry.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NotificationService

public NotificationService()
Method Detail

startup

public static void startup()
Starts the timer agent, to schedule error notification retry.


shutdown

public static void shutdown()
Stops Notification Service


getStatus

public static ServiceStatus getStatus()
gets notification status


sendIMNotification

public static IArrayOfResponseType sendIMNotification(IIMPayloadType payload)
                                               throws oracle.bpel.services.notification.NotificationServiceException
Sends IM Notification

Parameters:
payload - details of the fax message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendIMNotification

public static IArrayOfResponseType sendIMNotification(java.lang.String caller,
                                                      java.lang.String taskId,
                                                      IIMPayloadType payload)
                                               throws oracle.bpel.services.notification.NotificationServiceException
Sends IM Notification

Parameters:
payload - details of the fax message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendFaxNotification

public static IArrayOfResponseType sendFaxNotification(IFaxPayloadType payload)
                                                throws oracle.bpel.services.notification.NotificationServiceException
Sends Fax Notification

Parameters:
payload - details of the fax message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendFaxNotification

public static IArrayOfResponseType sendFaxNotification(java.lang.String caller,
                                                       java.lang.String taskId,
                                                       IFaxPayloadType payload)
                                                throws oracle.bpel.services.notification.NotificationServiceException
Sends Fax Notification

Parameters:
payload - details of the fax message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendVoiceNotification

public static IArrayOfResponseType sendVoiceNotification(IVoicePayloadType payload)
                                                  throws oracle.bpel.services.notification.NotificationServiceException
Sends Voice Notification

Parameters:
payload - details of the voice message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendVoiceNotification

public static IArrayOfResponseType sendVoiceNotification(java.lang.String caller,
                                                         java.lang.String taskId,
                                                         IVoicePayloadType payload)
                                                  throws oracle.bpel.services.notification.NotificationServiceException
Sends Voice Notification

Parameters:
payload - details of the voice message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendSMSNotification

public static IArrayOfResponseType sendSMSNotification(ISMSPayloadType payload)
                                                throws oracle.bpel.services.notification.NotificationServiceException
Sends SMS Notification

Parameters:
payload - details of the sms message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendSMSNotification

public static IArrayOfResponseType sendSMSNotification(java.lang.String caller,
                                                       java.lang.String taskId,
                                                       ISMSPayloadType payload)
                                                throws oracle.bpel.services.notification.NotificationServiceException
Sends SMS Notification

Parameters:
payload - details of the sms message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendPagerNotification

public static IArrayOfResponseType sendPagerNotification(IPagerPayloadType payload)
                                                  throws oracle.bpel.services.notification.NotificationServiceException
Sends pager Notification

Parameters:
payload - details of the pager message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendPagerNotification

public static IArrayOfResponseType sendPagerNotification(java.lang.String caller,
                                                         java.lang.String taskId,
                                                         IPagerPayloadType payload)
                                                  throws oracle.bpel.services.notification.NotificationServiceException
Sends pager Notification

Parameters:
payload - details of the pager message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendURINotification

public static IArrayOfResponseType sendURINotification(IURIPayloadType payload)
                                                throws oracle.bpel.services.notification.NotificationServiceException
Sends URI Notification

Parameters:
payload - details of the URI message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendURINotification

public static IArrayOfResponseType sendURINotification(java.lang.String caller,
                                                       java.lang.String taskId,
                                                       IURIPayloadType payload)
                                                throws oracle.bpel.services.notification.NotificationServiceException
Sends URI Notification

Parameters:
payload - details of the URI message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendNotificationToUser

public static IArrayOfResponseType sendNotificationToUser(IUserNotificationPayloadType payload)
                                                   throws oracle.bpel.services.notification.NotificationServiceException
Sends notification to a user

Parameters:
payload - details of the user message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendNotificationToUser

public static IArrayOfResponseType sendNotificationToUser(java.lang.String caller,
                                                          java.lang.String taskId,
                                                          IUserNotificationPayloadType payload)
                                                   throws oracle.bpel.services.notification.NotificationServiceException
Sends notification to a user

Parameters:
payload - details of the user message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendNotificationToGroup

public static IArrayOfResponseType sendNotificationToGroup(IGroupNotificationPayloadType payload)
                                                    throws oracle.bpel.services.notification.NotificationServiceException
Sends notification to a Group

Parameters:
payload - details of the group message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendNotificationToGroup

public static IArrayOfResponseType sendNotificationToGroup(java.lang.String caller,
                                                           java.lang.String taskId,
                                                           IGroupNotificationPayloadType payload)
                                                    throws oracle.bpel.services.notification.NotificationServiceException
Sends notification to a Group

Parameters:
payload - details of the group message
Returns:
Array of IResponse objects which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendNotifications

public static IArrayOfResponseType sendNotifications(java.lang.String[] userIds,
                                                     java.lang.String[] groupIds,
                                                     java.lang.String caller,
                                                     java.lang.String taskId,
                                                     IGenericPayloadType genericPayload)
                                              throws oracle.bpel.services.notification.NotificationServiceException
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendEmailNotification

public static IArrayOfResponseType sendEmailNotification(IEmailPayloadType payload)
                                                  throws oracle.bpel.services.notification.NotificationServiceException
Sends Email Notification

Parameters:
payload - details of the e-mail message
Returns:
IResponse object which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

sendEmailNotification

public static IArrayOfResponseType sendEmailNotification(java.lang.String caller,
                                                         java.lang.String taskId,
                                                         IEmailPayloadType payload)
                                                  throws oracle.bpel.services.notification.NotificationServiceException
Sends Email Notification

Parameters:
payload - details of the e-mail message
Returns:
IResponse object which can be used to track the status of the notification
Throws:
oracle.bpel.services.notification.NotificationServiceException

getChildElement

public static org.w3c.dom.Element getChildElement(org.w3c.dom.Element parent,
                                                  java.lang.String childElementName)
                                           throws java.lang.Exception
Describe getChildElement method here.

Parameters:
parent - an Element value
childElementName - a String value
Returns:
an Element value
Throws:
java.lang.Exception - if an error occurs

Oracle Fusion Middleware
Java API Reference for Oracle BPM Suite
11g Release 1 (11.1.1.7.0)
E25378-07

Copyright © 2009, 2013, Oracle and/or its affiliates. All rights reserved.