org.csapi.jr.se.mm.us
Interface UserStatus

All Superinterfaces:
CsapiInterface, java.io.Serializable, Service

public interface UserStatus
extends Service

This interface represents a UserStatus.


Field Summary
 
Fields inherited from interface org.csapi.jr.se.Service
IN_SERVICE_STATE, OUT_OF_SERVICE_STATE
 
Method Summary
 void addUserStatusListener(org.csapi.jr.se.mm.us.UserStatusListener userStatusListener)
          Adds a UserStatusListener which is interested in events generated by the UserStatus.
 org.csapi.jr.se.mm.us.ExtendedStatusReport createExtendedStatusReport()
          Creates a ExtendedStatusReport object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.mm.us.ExtTriggeredStatusReporting createExtTriggeredStatusReporting()
          Creates a ExtTriggeredStatusReporting object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.mm.us.StatusReport createStatusReport()
          Creates a StatusReport object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.mm.us.TriggeredStatusReporting createTriggeredStatusReporting()
          Creates a TriggeredStatusReporting object and returns a reference to the interface used to gain access to it's methods.
 org.csapi.jr.se.mm.TriggeredStatusRequestSetEntry getNextTriggeredStatusRequest(boolean reset)
          Invokes the getNextTriggeredStatusRequest() method on the Parlay Gateway.
 void removeUserStatusListener(org.csapi.jr.se.mm.us.UserStatusListener userStatusListener)
          Removes a UserStatusListener which is no longer interested in events generated by the UserStatus.
 
Methods inherited from interface org.csapi.jr.se.Service
addServiceStateChangeListener, getServiceState, removeServiceStateChangeListener, setCallback
 

Method Detail

addUserStatusListener

public void addUserStatusListener(org.csapi.jr.se.mm.us.UserStatusListener userStatusListener)
Adds a UserStatusListener which is interested in events generated by the UserStatus.

Parameters:
userStatusListener - A reference to the UserStatusListener which is to be added as a listener.

removeUserStatusListener

public void removeUserStatusListener(org.csapi.jr.se.mm.us.UserStatusListener userStatusListener)
Removes a UserStatusListener which is no longer interested in events generated by the UserStatus.

Parameters:
userStatusListener - A reference to the UserStatusListener which is to be removed as a listener.

getNextTriggeredStatusRequest

public org.csapi.jr.se.mm.TriggeredStatusRequestSetEntry getNextTriggeredStatusRequest(boolean reset)
                                                                                throws PlatformException,
                                                                                       CommonException
Invokes the getNextTriggeredStatusRequest() method on the Parlay Gateway.

PlatformException
CommonException

createExtTriggeredStatusReporting

public org.csapi.jr.se.mm.us.ExtTriggeredStatusReporting createExtTriggeredStatusReporting()
Creates a ExtTriggeredStatusReporting object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the ExtTriggeredStatusReporting interface.

createStatusReport

public org.csapi.jr.se.mm.us.StatusReport createStatusReport()
Creates a StatusReport object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the StatusReport interface.

createExtendedStatusReport

public org.csapi.jr.se.mm.us.ExtendedStatusReport createExtendedStatusReport()
Creates a ExtendedStatusReport object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the ExtendedStatusReport interface.

createTriggeredStatusReporting

public org.csapi.jr.se.mm.us.TriggeredStatusReporting createTriggeredStatusReporting()
Creates a TriggeredStatusReporting object and returns a reference to the interface used to gain access to it's methods.

Returns:
A reference to the TriggeredStatusReporting interface.