Packagecom.pushtechnology.diffusion
Classpublic class ServiceTopicResponse
InheritanceServiceTopicResponse Inheritance Object

Since : 4.1.0

Encapsulates a response from a service request.

This encapsulates the details of a response from a call to ServiceTopicHandler#request(String, TopicMessage).



Public Methods
 MethodDefined By
  
ServiceTopicResponse(handler:ServiceTopicHandler, requestId:String, responseType:String, responseMessage:TopicMessage)
ServiceTopicResponse
  
Returns the handler that the request was issued to.
ServiceTopicResponse
  
getRequestId():String
Return the request identifier.
ServiceTopicResponse
  
Return details of the response in the form of a Message containing headers and/or data returned from the server.
ServiceTopicResponse
  
Returns a response type.
ServiceTopicResponse
Constructor Detail
ServiceTopicResponse()Constructor
public function ServiceTopicResponse(handler:ServiceTopicHandler, requestId:String, responseType:String, responseMessage:TopicMessage)



Parameters
handler:ServiceTopicHandler
 
requestId:String
 
responseType:String
 
responseMessage:TopicMessage
Method Detail
getHandler()method
public function getHandler():ServiceTopicHandler

Returns the handler that the request was issued to.

Returns
ServiceTopicHandler — handler
getRequestId()method 
public function getRequestId():String

Return the request identifier.

This returns the original identifier that was passed with the request, as returned by ServiceTopicHandler#request(String, TopicMessage).

Returns
String — the request identifier.
getResponseMessage()method 
public function getResponseMessage():TopicMessage

Return details of the response in the form of a Message containing headers and/or data returned from the server.

Note that it is permissible for the response Message to be completely empty.

Returns
TopicMessage — the response message - may be an empty message but will not be null.
getResponseType()method 
public function getResponseType():String

Returns a response type.

This identifies the type of response and is as defined by the service itself.

Returns
String — response type.