com.ibm.soa.parlayx21.terminal_location
Interface TerminalLocationNotification

All Superinterfaces:
java.rmi.Remote
All Known Subinterfaces:
TerminalLocationNotification_RI
All Known Implementing Classes:
TerminalLocationNotificationBindingStub, TerminalLocationNotificationProxy

public interface TerminalLocationNotification
extends java.rmi.Remote

Notification interface to which notifications are delivered.


Method Summary
 void locationEnd(java.lang.String correlator)
          The notifications have completed for this correlator.
 void locationError(java.lang.String correlator, java.net.URI address, ServiceError reason)
          The location error message is sent to the application to indicate that the notification for a terminal, or for the whole notification, is being cancelled by the Web Service.
 void locationNotification(java.lang.String correlator, LocationData[] data, EnteringLeavingCriteria criteria)
          When the location of a monitored device changes a notification is delivered to the application with the new location information.
 

Method Detail

locationNotification

void locationNotification(java.lang.String correlator,
                          LocationData[] data,
                          EnteringLeavingCriteria criteria)
                          throws java.rmi.RemoteException

When the location of a monitored device changes a notification is delivered to the application with the new location information. If a group identifier was used, the terminal device URI is provided, not the group URI.

Referenced faults

None.

Parameters:
correlator - xsd:string Correlator provided in request to set up this notification
data - LocationInfoData [1 .. unbounded] Location information for terminal
criteria - EnteringLeavingCriteria NoYes Indicates whether the notification was caused by the terminal entering or leaving the target area. (This part is provided for geographical notifications, not for periodic notifications)
Throws:
java.rmi.RemoteException

locationError

void locationError(java.lang.String correlator,
                   java.net.URI address,
                   ServiceError reason)
                   throws java.rmi.RemoteException

The location error message is sent to the application to indicate that the notification for a terminal, or for the whole notification, is being cancelled by the Web Service.

Referenced faults

None.

Parameters:
correlator - xsd:string Correlator provided in request to set up this notification
address - xsd:anyURI Address of terminal if the error applies to an individual terminal, or not specified if it applies to the whole notification
reason - common:ServiceError Reason notification is being discontinued
Throws:
java.rmi.RemoteException

locationEnd

void locationEnd(java.lang.String correlator)
                 throws java.rmi.RemoteException

The notifications have completed for this correlator. This message will be delivered when the duration or count for notifications have been completed. This message will not be delivered in the case of an error ending the notifications or deliberate ending of the notifications (using endNotification operation).

Referenced faults

None.

Parameters:
correlator - xsd:string Correlator provided in request to set up this notification
Throws:
java.rmi.RemoteException


Copyright © 2003 IBM Corp. All Rights Reserved.