com.ibm.soa.parlayx21.sms
Class ReceiveSmsProxy

java.lang.Object
  extended by com.ibm.soa.parlayx21.sms.ReceiveSmsProxy
All Implemented Interfaces:
ReceiveSms, java.rmi.Remote

public class ReceiveSmsProxy
extends java.lang.Object
implements ReceiveSms


Constructor Summary
ReceiveSmsProxy()
           
 
Method Summary
 java.lang.String getEndpoint()
           
 SmsMessage[] getReceivedSms(java.lang.String registrationIdentifier)
          The invocation of getReceivedSms retrieves all the SMS messages received that fulfil the criteria identified by registrationIdentifier.
 ReceiveSms getReceiveSms()
           
 void setEndpoint(java.lang.String endpoint)
           
 void useJNDI(boolean useJNDI)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ReceiveSmsProxy

public ReceiveSmsProxy()
Method Detail

useJNDI

public void useJNDI(boolean useJNDI)

getEndpoint

public java.lang.String getEndpoint()

setEndpoint

public void setEndpoint(java.lang.String endpoint)

getReceiveSms

public ReceiveSms getReceiveSms()

getReceivedSms

public SmsMessage[] getReceivedSms(java.lang.String registrationIdentifier)
                            throws java.rmi.RemoteException,
                                   PolicyException,
                                   ServiceException
Description copied from interface: ReceiveSms

The invocation of getReceivedSms retrieves all the SMS messages received that fulfil the criteria identified by registrationIdentifier. The method returns only the list of SMS messages received since the previous invocation of the same method, for example, each time the method is executed the messages returned are removed from the server. Moreover, each SMS message will be automatically removed from the server after a maximum time interval specified in an off-line configuration step.

The received SMS messages are returned in receivedSms. An SMS message is identified by a structure indicating the sender of the SMS message and the content.

Referenced faults

ServiceException from ES 202 391-1 [2]:
  * SVC0001 - Service error.
  * SVC0002 - Invalid input value.

PolicyException from ES 202 391-1 [2]:
  * POL0001 - Policy error.

Specified by:
getReceivedSms in interface ReceiveSms
Parameters:
registrationIdentifier - xsd:string Identifies the off-line provisioning step that enables the application to receive notification of SMS reception according to specified criteria
Returns:
result SmsMessage [0..unbounded] It lists the received SMS since last invocation
Throws:
java.rmi.RemoteException
PolicyException
ServiceException


Copyright © 2003 IBM Corp. All Rights Reserved.