Oracle Fusion Middleware User Messaging Service 11.1.1.7.0 Java API Reference
E14011-05

oracle.sdp.messaging
Interface Status

All Superinterfaces:
MessagingObject, Serializable
All Known Subinterfaces:
Status

public interface Status
extends MessagingObject

Status reports the delivery status of a sent message. Status helps the client to track message status.
It is also reported to the system by a remote gateway or service center. This information could be a delivery notification, a failure notification, or a state update. A status may have a failover status. Failover status is the status of the failover address. Statuses may be chained to reflect the statuses of a failover chain. Status may have following fields:
- type: the status type.
- content: the status details.
- date: the date when the status/event occurred.
- address: the recipient's address associated with this status.
- message id: the message id associated with this status.
- gateway id: the message id sent by the remote gateway or service center.
- failover status: the failover status, if applicable.

Since:
11.0.0

Field Summary
 
Fields inherited from interface oracle.sdp.messaging.MessagingObject
METADATA_APPLICATION_NAME, NAMESPACE_NOTIFICATION_PREFERENCES, NAMESPACE_SDPM, NAMESPACE_UMS
 
Method Summary
 Address getAddress()
          Get address of the status.
 java.lang.String getContent()
          Get the status content.
 Calendar getDate()
          Get the date and time when this status was received.
 java.lang.String getDriver()
          Get the name of the reporting driver.
 int getFailoverOrder()
          Get the failover order number of this recipient.
 Status getFailoverStatus()
          A Status object may be chained if the recipient has failover address(es).
 java.lang.String getGatewayMessageId()
          Get the gateway assigned message ID of the status.
 java.lang.String getMessageId()
          Get Messaging assigned message ID of the status.
 Address getRecipient()
          Get the logical recipient for which this status applies.
 int getTotalFailovers()
          Get the total number of failover addresses of this recipient.
 StatusType getType()
          Get the status type.
 
Methods inherited from interface oracle.sdp.messaging.MessagingObject
getAllNamespaces, getMetaData, getMetaDataNames, setMetaData
 

Method Detail

getContent

java.lang.String getContent()
Get the status content.

Returns:
the status content.

getType

StatusType getType()
Get the status type.

Returns:
the status type.

getDate

Calendar getDate()
Get the date and time when this status was received.

Returns:
the date.

getMessageId

java.lang.String getMessageId()
Get Messaging assigned message ID of the status.

Returns:
the Messaging assigned message ID.

getGatewayMessageId

java.lang.String getGatewayMessageId()
Get the gateway assigned message ID of the status.

Returns:
the gateway assigned message ID.

getAddress

Address getAddress()
Get address of the status.

Returns:
the address.

getRecipient

Address getRecipient()
Get the logical recipient for which this status applies. This method returns the head of the complete failover address chain, of which the address returned by getAddress() is one entry.

Returns:
The logical recipient Address object.

getFailoverStatus

Status getFailoverStatus()
A Status object may be chained if the recipient has failover address(es).
Failover status is useful when Messaging Client uses getStatus() to retrieve all failover statuses of a recipient by the message ID (or WorkOrder) returned from send().
Failover status is NOT AVAILABLE for realtime callback status, because the next failover has not been tried.
For example: a recipient has failover addresses in following order: 1-222-333333 (SMS), 1-333-444444 (Fax), 1-444-5551234 (voice) and foo@bar.com (Email) Suppose first two attempts fail and msg gets delivered to 3rd address. Status chain may have 3 nodes.

Returns:
getFailoverStatus() returns the next status node (status of failover attempt) in the chain.
null if current node doesn't have failover status (yet).

getTotalFailovers

int getTotalFailovers()
Get the total number of failover addresses of this recipient.

Returns:
0: total number of failover addresses of this recipient is unknown or not available
>0: total number of failover addresses of this recipient.

getFailoverOrder

int getFailoverOrder()
Get the failover order number of this recipient.

Returns:
0: the current failover order number is unknown or not available.
>0: current status is the status of the nth failover address.

getDriver

java.lang.String getDriver()
Get the name of the reporting driver.

Returns:
the name of the reporting driver.

Oracle Fusion Middleware User Messaging Service 11.1.1.7.0 Java API Reference
E14011-05

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