net.rim.pushsdk.subscription
Enum SubIllegalArgumentErrorCode

java.lang.Object
  extended by java.lang.Enum<SubIllegalArgumentErrorCode>
      extended by net.rim.pushsdk.subscription.SubIllegalArgumentErrorCode
All Implemented Interfaces:
Serializable, Comparable<SubIllegalArgumentErrorCode>

public enum SubIllegalArgumentErrorCode
extends Enum<SubIllegalArgumentErrorCode>

Error codes relating to invalid arguments to a subscription operation.

Author:
mdandrea

Enum Constant Summary
INVALID_ADDRESS
          If the address specified for the subscriber was null, empty, or too long.
INVALID_PARAMETERS
          If the model or OS version specified for the subscriber was null or empty.
INVALID_PUSH_APPLICATION
          If the push application id specified for the subscriber was null or empty.
INVALID_SUBSCRIBER_ID
          If the subscriber id specified was null or empty.
INVALID_TYPE
          If the type specified for the subscriber is not one of null or a valid subscriber type.
 
Method Summary
 SubscriptionStatusCode getStatusCode()
          Return the SubscriptionStatusCode object matching this error code.
 String toString()
           
static SubIllegalArgumentErrorCode valueOf(String name)
          Returns the enum constant of this type with the specified name.
static SubIllegalArgumentErrorCode[] values()
          Returns an array containing the constants of this enum type, in the order they are declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

INVALID_PUSH_APPLICATION

public static final SubIllegalArgumentErrorCode INVALID_PUSH_APPLICATION
If the push application id specified for the subscriber was null or empty.


INVALID_SUBSCRIBER_ID

public static final SubIllegalArgumentErrorCode INVALID_SUBSCRIBER_ID
If the subscriber id specified was null or empty.


INVALID_ADDRESS

public static final SubIllegalArgumentErrorCode INVALID_ADDRESS
If the address specified for the subscriber was null, empty, or too long.


INVALID_PARAMETERS

public static final SubIllegalArgumentErrorCode INVALID_PARAMETERS
If the model or OS version specified for the subscriber was null or empty.


INVALID_TYPE

public static final SubIllegalArgumentErrorCode INVALID_TYPE
If the type specified for the subscriber is not one of null or a valid subscriber type.

Since:
1.1
Method Detail

values

public static SubIllegalArgumentErrorCode[] values()
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
for (SubIllegalArgumentErrorCode c : SubIllegalArgumentErrorCode.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static SubIllegalArgumentErrorCode valueOf(String name)
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:
name - the name of the enum constant to be returned.
Returns:
the enum constant with the specified name
Throws:
IllegalArgumentException - if this enum type has no constant with the specified name
NullPointerException - if the argument is null

toString

public String toString()
Overrides:
toString in class Enum<SubIllegalArgumentErrorCode>

getStatusCode

public SubscriptionStatusCode getStatusCode()
Return the SubscriptionStatusCode object matching this error code.

Returns:
the SubscriptionStatusCode object matching this error
Since:
1.1


Copyright © 2011 Research In Motion. All Rights Reserved.