net.rim.pushsdk.query.subscription
Class SubscriptionQueryMessage

java.lang.Object
  extended by net.rim.pushsdk.query.subscription.SubscriptionQueryMessage
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
SubscriptionQueryRequest, SubscriptionQueryResponse

public class SubscriptionQueryMessage
extends Object
implements Serializable

Represents a message (request/response) for a subscription query to the PPG.

Author:
mdandrea
See Also:
Serialized Form

Field Summary
static String ADDRESS_ATTR
          The address XML attribute indicating the address (e.g.
static String ADDRESS_TAG
          The address XML tag.
static String CURRENT_MSG_VERSION
          The current version being used of the subscription query message.
static String EVENT_TIME_ATTR
          The event time XML attribute.
static String PUSHAPP_ID_ATTR
          The app id XML attribute indicating the application associated with the subscription query message.
protected  String pushApplicationId
          The push application id.
static String QUERY_OUTERMOST_TAG
          The outermost XML tag in a subscription query (both request and response).
static String VERSION_ATTR
          The version XML attribute indicating the subscription query message version.
 
Constructor Summary
SubscriptionQueryMessage()
          Constructs a subscription query message.
SubscriptionQueryMessage(String pushApplicationId)
          Constructs a subscription query message with the given push app id.
 
Method Summary
 boolean equals(Object obj)
          Returns true if two subscription query messages are found to be equal and false otherwise.
 String getPushApplicationId()
          Gets the push application id.
 int hashCode()
          Returns a hashcode for this subscription query message.
 void setPushApplicationId(String pushApplicationId)
          Sets the push application id.
 String toString()
          Constructs a String with all attributes in name = value format.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Field Detail

QUERY_OUTERMOST_TAG

public static final String QUERY_OUTERMOST_TAG
The outermost XML tag in a subscription query (both request and response).

See Also:
Constant Field Values

VERSION_ATTR

public static final String VERSION_ATTR
The version XML attribute indicating the subscription query message version.

See Also:
Constant Field Values

PUSHAPP_ID_ATTR

public static final String PUSHAPP_ID_ATTR
The app id XML attribute indicating the application associated with the subscription query message.

See Also:
Constant Field Values

ADDRESS_TAG

public static final String ADDRESS_TAG
The address XML tag.

See Also:
Constant Field Values

ADDRESS_ATTR

public static final String ADDRESS_ATTR
The address XML attribute indicating the address (e.g. PIN) associated with the subscription query message.

See Also:
Constant Field Values

EVENT_TIME_ATTR

public static final String EVENT_TIME_ATTR
The event time XML attribute.

See Also:
Constant Field Values

CURRENT_MSG_VERSION

public static final String CURRENT_MSG_VERSION
The current version being used of the subscription query message.

See Also:
Constant Field Values

pushApplicationId

protected String pushApplicationId
The push application id.

Constructor Detail

SubscriptionQueryMessage

public SubscriptionQueryMessage()
Constructs a subscription query message.


SubscriptionQueryMessage

public SubscriptionQueryMessage(String pushApplicationId)
Constructs a subscription query message with the given push app id.

Parameters:
pushApplicationId - the push application id
Method Detail

setPushApplicationId

public void setPushApplicationId(String pushApplicationId)
Sets the push application id.

Parameters:
pushApplicationId - the push application id to set

getPushApplicationId

public String getPushApplicationId()
Gets the push application id.

Returns:
the push application id

hashCode

public int hashCode()
Returns a hashcode for this subscription query message.

Overrides:
hashCode in class Object
Returns:
a hashcode for this subscription query message.

equals

public boolean equals(Object obj)
Returns true if two subscription query messages are found to be equal and false otherwise.

Overrides:
equals in class Object
Returns:
whether two subscription query messages are equal

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.