net.rim.pushsdk.push.request
Class PushRequestDetail

java.lang.Object
  extended by net.rim.pushsdk.push.request.PushRequestDetail
All Implemented Interfaces:
Serializable

public class PushRequestDetail
extends Object
implements Serializable

Value object that represents a push request detail object.

A push request detail object models the attributes that define a specific address of a push message. For a given push message, one push request detail object is created for each address in the original push request.

Author:
dstrelbytsky
See Also:
Serialized Form

Constructor Summary
PushRequestDetail()
          Default constructor for creating a push request detail object.
PushRequestDetail(PushRequestDetail detail)
          Copy constructor.
 
Method Summary
 String getAddress()
          Gets the address associated with the push request detail.
 Date getCompletedDate()
          Gets the date when the push request detail reaches a final state (the acknowledgement's event time).
 Date getCreatedDate()
          Gets the date when the push request detail was created.
 String getId()
          Gets the id of the push associated with the push request detail.
 MessageState getMessageState()
          Gets the current state of the push request detail.
 Date getModifiedDate()
          Gets the date when the push request detail was last modified.
 String getSenderAddress()
          Gets the address of the PPG that processed the push associated with the push request detail.
 String getSenderName()
          Gets the textual name of the PPG that processed the push associated with the push request detail.
 StatusCode getStatusCode()
          Gets the status code of the push request detail.
 String getStatusDesc()
          Gets a description of the status code associated with the push request detail.
 String getSubscriberId()
          Gets the subscriber id associated with the push request detail's address at the time of the push.
 SubscriberType getSubscriberType()
          Gets the type of the subscriber.
 void setAddress(String address)
          Sets the address associated with the push request detail.
 void setCompletedDate(Date completedDate)
          Sets the date when the push request detail reaches a final state (the acknowledgement's event time).
 void setCreatedDate(Date createdDate)
          Sets the date when the push request detail was created.
 void setId(String id)
          Sets the id of the push associated with the push request detail.
 void setMessageState(MessageState messageState)
          Sets the current state of the push request detail.
 void setModifiedDate(Date modifiedDate)
          Sets the date when the push request detail was last modified.
 void setSenderAddress(String senderAddress)
          Sets the address of the PPG that processed the push associated with the push request detail.
 void setSenderName(String senderName)
          Sets the textual name of the PPG that processed the push associated with the push request detail.
 void setStatusCode(StatusCode statusCode)
          Sets the status code of the push request detail.
 void setStatusDesc(String statusDesc)
          Sets the description of the status code associated with the push request detail.
 void setSubscriberId(String subscriberId)
          Sets the subscriber id associated with the push request detail's address at the time of the push.
 void setSubscriberType(SubscriberType subscriberType)
          Sets the type of the subscriber.
 String toString()
          Constructs a String with all attributes in name = value format.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

PushRequestDetail

public PushRequestDetail(PushRequestDetail detail)
Copy constructor.

Parameters:
detail - the push request detail to be copied

PushRequestDetail

public PushRequestDetail()
Default constructor for creating a push request detail object.

Method Detail

getId

public String getId()
Gets the id of the push associated with the push request detail.

Returns:
the push id

setId

public void setId(String id)
Sets the id of the push associated with the push request detail.

Parameters:
id - the push id

getMessageState

public MessageState getMessageState()
Gets the current state of the push request detail.

Returns:
the current state

setMessageState

public void setMessageState(MessageState messageState)
Sets the current state of the push request detail.

Parameters:
messageState - the current state

getAddress

public String getAddress()
Gets the address associated with the push request detail.

Returns:
the address

setAddress

public void setAddress(String address)
Sets the address associated with the push request detail.

Parameters:
address - the address

getSubscriberId

public String getSubscriberId()
Gets the subscriber id associated with the push request detail's address at the time of the push.

Returns:
the subscriber id associated with the address at the time of the push; null, if subscription is being bypassed

setSubscriberId

public void setSubscriberId(String subscriberId)
Sets the subscriber id associated with the push request detail's address at the time of the push.

Parameters:
subscriberId - the subscriber id associated with the address at the time of the push; null, if subscription is being bypassed

getStatusCode

public StatusCode getStatusCode()
Gets the status code of the push request detail.

Returns:
the push request detail's status code

setStatusCode

public void setStatusCode(StatusCode statusCode)
Sets the status code of the push request detail.

Parameters:
statusCode - the push request detail's status code

getStatusDesc

public String getStatusDesc()
Gets a description of the status code associated with the push request detail.

Returns:
the description of the status code

setStatusDesc

public void setStatusDesc(String statusDesc)
Sets the description of the status code associated with the push request detail.

Parameters:
statusDesc - the description of the status code

getSenderName

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

Returns:
the name of the PPG

setSenderName

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

Parameters:
senderName - the name of the PPG

getSenderAddress

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

Returns:
the address of the PPG

setSenderAddress

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

Parameters:
senderAddress - the address of the PPG

getCreatedDate

public Date getCreatedDate()
Gets the date when the push request detail was created.

Returns:
the push request detail's created date

setCreatedDate

public void setCreatedDate(Date createdDate)
Sets the date when the push request detail was created.

Parameters:
createdDate - the push request detail's created date

getCompletedDate

public Date getCompletedDate()
Gets the date when the push request detail reaches a final state (the acknowledgement's event time).

Returns:
the push request detail's completed date

setCompletedDate

public void setCompletedDate(Date completedDate)
Sets the date when the push request detail reaches a final state (the acknowledgement's event time).

Parameters:
completedDate - the push request detail's completed date

getModifiedDate

public Date getModifiedDate()
Gets the date when the push request detail was last modified.

Returns:
the push request detail's modified date

setModifiedDate

public void setModifiedDate(Date modifiedDate)
Sets the date when the push request detail was last modified.

Parameters:
modifiedDate - the push request detail's last modified date

getSubscriberType

public SubscriberType getSubscriberType()
Gets the type of the subscriber.

Returns:
the subscriber type
Since:
1.1
See Also:
SubscriberType

setSubscriberType

public void setSubscriberType(SubscriberType subscriberType)
Sets the type of the subscriber.

Parameters:
subscriberType - the subscriber type to set
Since:
1.1
See Also:
SubscriberType

toString

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

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


Copyright © 2011 Research In Motion. All Rights Reserved.