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

java.lang.Object
  java.lang.Enum<SetUserReturnStatusEnumType>
      com.rim.bes.bas.baa.dto.SetUserReturnStatusEnumType

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<SetUserReturnStatusEnumType>

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

Java class for SetUserReturnStatusEnumType.

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

 <simpleType name="SetUserReturnStatusEnumType">
   <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="INVALID_USER"/>
     <enumeration value="USER_NOT_FOUND"/>
     <enumeration value="MUST_ALLOW_ADMINISTRATION"/>
     <enumeration value="LOGIN_NAME_ALREADY_EXISTS"/>
     <enumeration value="NO_MAILSTORE_SERVICE_INSTALLED_FOR_USER"/>
     <enumeration value="DIRECTORY_SERVER_DOES_NOT_EXIST"/>
     <enumeration value="COULD_NOT_CRYPT_PASSWORD"/>
     <enumeration value="STALE_OBJECT"/>
     <enumeration value="USER_IS_NOT_BLACKBERY_ENABLED_USER"/>
   </restriction>
 </simpleType>
 

Enum Constant Summary

COULD_NOT_CRYPT_PASSWORD
Cannot encode/decode the login password.

DIRECTORY_SERVER_DOES_NOT_EXIST
Directory server does not exist.

INVALID_PARAMETER
An invalid parameter was passed into the API call.

INVALID_USER
The user object is invalid.

LOGIN_NAME_ALREADY_EXISTS
Login name already exists.

MUST_ALLOW_ADMINISTRATION
Cannot make user not an administrator.

NO_MAILSTORE_SERVICE_INSTALLED_FOR_USER
Mailstore service required to set this user.

NOT_AUTHORIZED
User does not have permission to perform the operation.

STALE_OBJECT
Stale User object, please refresh and try again.

SUCCESS
API call completed successfully.

UNKNOWN
An unknown error has occurred.

USER_IS_NOT_BLACKBERY_ENABLED_USER

USER_NOT_FOUND
Cannot find user.

Method Summary

static SetUserReturnStatusEnumType	fromValue(java.lang.String v)
java.lang.String	value()
static SetUserReturnStatusEnumType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static SetUserReturnStatusEnumType[]	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 SetUserReturnStatusEnumType SUCCESS

API call completed successfully.

UNKNOWN

public static final SetUserReturnStatusEnumType UNKNOWN

An unknown error has occurred. Inspect the message for details or consult the log file.

NOT_AUTHORIZED

public static final SetUserReturnStatusEnumType NOT_AUTHORIZED

User does not have permission to perform the operation.

INVALID_PARAMETER

public static final SetUserReturnStatusEnumType INVALID_PARAMETER

An invalid parameter was passed into the API call.

INVALID_USER

public static final SetUserReturnStatusEnumType INVALID_USER

The user object is invalid. Please refresh the user by using the getUser() api.

USER_NOT_FOUND

public static final SetUserReturnStatusEnumType USER_NOT_FOUND

Cannot find user.

MUST_ALLOW_ADMINISTRATION

public static final SetUserReturnStatusEnumType MUST_ALLOW_ADMINISTRATION

Cannot make user not an administrator. Must have at least one administrator.

LOGIN_NAME_ALREADY_EXISTS

public static final SetUserReturnStatusEnumType LOGIN_NAME_ALREADY_EXISTS

Login name already exists.

NO_MAILSTORE_SERVICE_INSTALLED_FOR_USER

public static final SetUserReturnStatusEnumType NO_MAILSTORE_SERVICE_INSTALLED_FOR_USER

Mailstore service required to set this user.

DIRECTORY_SERVER_DOES_NOT_EXIST

public static final SetUserReturnStatusEnumType DIRECTORY_SERVER_DOES_NOT_EXIST

Directory server does not exist.

COULD_NOT_CRYPT_PASSWORD

public static final SetUserReturnStatusEnumType COULD_NOT_CRYPT_PASSWORD

Cannot encode/decode the login password.

STALE_OBJECT

public static final SetUserReturnStatusEnumType STALE_OBJECT

Stale User object, please refresh and try again.

USER_IS_NOT_BLACKBERY_ENABLED_USER

public static final SetUserReturnStatusEnumType USER_IS_NOT_BLACKBERY_ENABLED_USER

Method Detail

values

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

Returns:

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

valueOf

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