BlackBerry Administration API
v5.0.3.29

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

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

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

Java class for GetUserReturnStatusEnumType.

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

 <simpleType name="GetUserReturnStatusEnumType">
   <restriction base="{http://www.w3.org/2001/XMLSchema}string">
     <enumeration value="SUCCESS"/>
     <enumeration value="UNKNOWN"/>
     <enumeration value="NOT_AUTHORIZED"/>
     <enumeration value="INVALID_PARAMETER"/>
     <enumeration value="USER_NOT_FOUND"/>
     <enumeration value="USER_IS_NOT_BLACKBERRY_ENABLED_USER"/>
   </restriction>
 </simpleType>
 


Enum Constant Summary
INVALID_PARAMETER
          An invalid parameter was passed into the API call.
NOT_AUTHORIZED
          User does not have permission to perform the operation.
SUCCESS
          API call completed successfully.
UNKNOWN
          An unknown error has occurred.
USER_IS_NOT_BLACKBERRY_ENABLED_USER
          User is not BlackBerry enabled user.
USER_NOT_FOUND
          Cannot find user with specified ID.
 
Method Summary
static GetUserReturnStatusEnumType fromValue(java.lang.String v)
           
 java.lang.String value()
           
static GetUserReturnStatusEnumType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static GetUserReturnStatusEnumType[] 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 GetUserReturnStatusEnumType SUCCESS
API call completed successfully.


UNKNOWN

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


NOT_AUTHORIZED

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


INVALID_PARAMETER

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


USER_NOT_FOUND

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


USER_IS_NOT_BLACKBERRY_ENABLED_USER

public static final GetUserReturnStatusEnumType USER_IS_NOT_BLACKBERRY_ENABLED_USER
User is not BlackBerry enabled user.

Method Detail

values

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

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

valueOf

public static GetUserReturnStatusEnumType 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 GetUserReturnStatusEnumType fromValue(java.lang.String v)

BlackBerry Administration API
v5.0.3.29

Copyright 2009 Research In Motion Limited. All Rights Reserved.