BlackBerry Administration API
v5.0.3.29

com.rim.bes.bas.baa.dto
Enum SendMessageToUserReturnStatusEnumType

Package class diagram package SendMessageToUserReturnStatusEnumType
java.lang.Object
  extended by java.lang.Enum<SendMessageToUserReturnStatusEnumType>
      extended by com.rim.bes.bas.baa.dto.SendMessageToUserReturnStatusEnumType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<SendMessageToUserReturnStatusEnumType>

public enum SendMessageToUserReturnStatusEnumType
extends java.lang.Enum<SendMessageToUserReturnStatusEnumType>

Java class for SendMessageToUserReturnStatusEnumType.

The following schema fragment specifies the expected content contained within this class.

 <simpleType name="SendMessageToUserReturnStatusEnumType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="SUCCESS"/>
     <enumeration value="UNKNOWN"/>
     <enumeration value="NOT_AUTHORIZED"/>
     <enumeration value="RESULT_ERROR_EXISTS"/>
     <enumeration value="INVALID_PARAMETER"/>
     <enumeration value="USER_NOT_FOUND"/>
     <enumeration value="USER_NOT_BLACKBERRY_ENABLED"/>
     <enumeration value="USER_DOES_NOT_HAVE_A_DEVICE_ASSOCIATED"/>
     <enumeration value="COULD_NOT_SEND_MESSAGE"/>
   </restriction>
 </simpleType>
 


Enum Constant Summary
COULD_NOT_SEND_MESSAGE
          Failed to send message to user.
INVALID_PARAMETER
          An invalid parameter was passed into the API call.
NOT_AUTHORIZED
          User does not have permission to perform the operation.
RESULT_ERROR_EXISTS
          Failed to send message to at least one user.
SUCCESS
          API call completed successfully.
UNKNOWN
          An unknown error has occurred.
USER_DOES_NOT_HAVE_A_DEVICE_ASSOCIATED
          Cannot send PIN message to user that do not have a device associated.
USER_NOT_BLACKBERRY_ENABLED
          Cannot send email message to user that is not BlackBerry enabled.
USER_NOT_FOUND
          Cannot find user with specified ID.
 
Method Summary
static SendMessageToUserReturnStatusEnumType fromValue(java.lang.String v)
           
 java.lang.String value()
           
static SendMessageToUserReturnStatusEnumType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static SendMessageToUserReturnStatusEnumType[] 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, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

SUCCESS

public static final SendMessageToUserReturnStatusEnumType SUCCESS
API call completed successfully.


UNKNOWN

public static final SendMessageToUserReturnStatusEnumType UNKNOWN
An unknown error has occurred. Inspect the message for details or consult the log file.


NOT_AUTHORIZED

public static final SendMessageToUserReturnStatusEnumType NOT_AUTHORIZED
User does not have permission to perform the operation.


RESULT_ERROR_EXISTS

public static final SendMessageToUserReturnStatusEnumType RESULT_ERROR_EXISTS
Failed to send message to at least one user. Check the return status of individual return results.


INVALID_PARAMETER

public static final SendMessageToUserReturnStatusEnumType INVALID_PARAMETER
An invalid parameter was passed into the API call.


USER_NOT_FOUND

public static final SendMessageToUserReturnStatusEnumType USER_NOT_FOUND
Cannot find user with specified ID.


USER_NOT_BLACKBERRY_ENABLED

public static final SendMessageToUserReturnStatusEnumType USER_NOT_BLACKBERRY_ENABLED
Cannot send email message to user that is not BlackBerry enabled.


USER_DOES_NOT_HAVE_A_DEVICE_ASSOCIATED

public static final SendMessageToUserReturnStatusEnumType USER_DOES_NOT_HAVE_A_DEVICE_ASSOCIATED
Cannot send PIN message to user that do not have a device associated.


COULD_NOT_SEND_MESSAGE

public static final SendMessageToUserReturnStatusEnumType COULD_NOT_SEND_MESSAGE
Failed to send message to user. Check log file for details.

Method Detail

values

public static SendMessageToUserReturnStatusEnumType[] 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 (SendMessageToUserReturnStatusEnumType c : SendMessageToUserReturnStatusEnumType.values())
    System.out.println(c);

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

valueOf

public static SendMessageToUserReturnStatusEnumType valueOf(java.lang.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:
java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
java.lang.NullPointerException - if the argument is null

value

public java.lang.String value()

fromValue

public static SendMessageToUserReturnStatusEnumType fromValue(java.lang.String v)

BlackBerry Administration API
v5.0.3.29

Copyright 2009 Research In Motion Limited. All Rights Reserved.