net.rim.pushsdk.pap.unmarshal
Class PushResponse

java.lang.Object
  extended by net.rim.pushsdk.pap.unmarshal.PapMessage
      extended by net.rim.pushsdk.pap.unmarshal.PushResponse

public class PushResponse
extends PapMessage

Represents the response from a push request message.

Author:
mdicesare

Constructor Summary
PushResponse()
          Default push response constructor.
 
Method Summary
 StatusCode getCode()
          Gets the status code from the response result associated with the push response.
 String getDescription()
          Gets the status description from the response result associated with the push response.
 Date getReplyTime()
          Gets the date and time at which the push response was created.
 ResponseResult getResult()
          Gets the response result (i.e.
 String getSenderAddress()
          Gets the address of the PPG that processed the push request.
 String getSenderName()
          Gets the textual name of the PPG that processed the push request.
 void setReplyTime(Date replyTime)
          Sets the date and time at which the push response was created.
 void setResult(ResponseResult result)
          Sets the response result (i.e.
 void setSenderAddress(String senderAddress)
          Sets the address of the PPG that processed the push request.
 void setSenderName(String senderName)
          Sets the textual name of the PPG that processed the push request.
 String toString()
          Constructs a String with all attributes in name = value format.
 
Methods inherited from class net.rim.pushsdk.pap.unmarshal.PapMessage
getPushId, setPushId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PushResponse

public PushResponse()
Default push response constructor.

Method Detail

getSenderAddress

public String getSenderAddress()
Gets the address of the PPG that processed the push request.

Returns:
the address of the PPG

setSenderAddress

public void setSenderAddress(String senderAddress)
Sets the address of the PPG that processed the push request.

Parameters:
senderAddress - the address of the PPG

getSenderName

public String getSenderName()
Gets the textual name of the PPG that processed the push request.

Returns:
the name of the PPG

setSenderName

public void setSenderName(String senderName)
Sets the textual name of the PPG that processed the push request.

Parameters:
senderName - the name of the PPG

getReplyTime

public Date getReplyTime()
Gets the date and time at which the push response was created.

Returns:
the push response's created date

setReplyTime

public void setReplyTime(Date replyTime)
Sets the date and time at which the push response was created.

Parameters:
replyTime - the push response's created date

getResult

public ResponseResult getResult()
Gets the response result (i.e. status code and status description) associated with the push response.

Returns:
the response result

setResult

public void setResult(ResponseResult result)
Sets the response result (i.e. status code and status description) associated with the push response.

Parameters:
result - the response result

getCode

public StatusCode getCode()
Gets the status code from the response result associated with the push response.

Returns:
the status code

getDescription

public String getDescription()
Gets the status description from the response result associated with the push response.

Returns:
the status description

toString

public String toString()
Constructs a String with all attributes in name = value format.

Overrides:
toString in class PapMessage
Returns:
a String representation of this object.


Copyright © 2011 Research In Motion. All Rights Reserved.