BlackBerry Administration API
v5.0.3.29

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

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

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

Java class for CreateUserReturnStatusEnumType.

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

 <simpleType name="CreateUserReturnStatusEnumType">
   <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="TARGET_SERVICE_INSTANCE_NOT_RUNNING"/>
     <enumeration value="USER_ALREADY_BLACKBERRY_ENABLED"/>
     <enumeration value="COULD_NOT_ENABLE_DELETED_BLACKBERRY_USER"/>
     <enumeration value="MAILBOX_ASSIGNED_TO_ANOTHER_USER"/>
     <enumeration value="COULD_NOT_ENABLE_BLACKBERRY_USER"/>
     <enumeration value="CANNOT_ADD_USER_TO_GROUP"/>
     <enumeration value="CANNOT_ATTACH_ITPOLICY_TO_USER"/>
     <enumeration value="CANNOT_ATTACH_SOFTWARE_CONFIGURATION_TO_USER"/>
   </restriction>
 </simpleType>
 


Enum Constant Summary
CANNOT_ADD_USER_TO_GROUP
          Failed to add user to group.
CANNOT_ATTACH_ITPOLICY_TO_USER
          Failed to attach IT Policy to user.
CANNOT_ATTACH_SOFTWARE_CONFIGURATION_TO_USER
          Failed to attach Software Configuration to user.
COULD_NOT_ENABLE_BLACKBERRY_USER
          Failed to create a BlackBerry enabled user.
COULD_NOT_ENABLE_DELETED_BLACKBERRY_USER
          Cannot enable BlackBerry service for a user being deleted.
INVALID_PARAMETER
          An invalid parameter was passed into the API call.
MAILBOX_ASSIGNED_TO_ANOTHER_USER
          Mailbox is already assigned to another user.
NOT_AUTHORIZED
          User does not have permission to perform the operation.
RESULT_ERROR_EXISTS
          At least one user failed to be created.
SUCCESS
          API call completed successfully.
TARGET_SERVICE_INSTANCE_NOT_RUNNING
          The target service instance is not running.
UNKNOWN
          An unknown error has occurred.
USER_ALREADY_BLACKBERRY_ENABLED
          User already has BlackBerry service enabled.
 
Method Summary
static CreateUserReturnStatusEnumType fromValue(java.lang.String v)
           
 java.lang.String value()
           
static CreateUserReturnStatusEnumType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static CreateUserReturnStatusEnumType[] 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 CreateUserReturnStatusEnumType SUCCESS
API call completed successfully.


UNKNOWN

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


NOT_AUTHORIZED

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


RESULT_ERROR_EXISTS

public static final CreateUserReturnStatusEnumType RESULT_ERROR_EXISTS
At least one user failed to be created. Check the return status of individual create user results.


INVALID_PARAMETER

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


TARGET_SERVICE_INSTANCE_NOT_RUNNING

public static final CreateUserReturnStatusEnumType TARGET_SERVICE_INSTANCE_NOT_RUNNING
The target service instance is not running.


USER_ALREADY_BLACKBERRY_ENABLED

public static final CreateUserReturnStatusEnumType USER_ALREADY_BLACKBERRY_ENABLED
User already has BlackBerry service enabled.


COULD_NOT_ENABLE_DELETED_BLACKBERRY_USER

public static final CreateUserReturnStatusEnumType COULD_NOT_ENABLE_DELETED_BLACKBERRY_USER
Cannot enable BlackBerry service for a user being deleted.


MAILBOX_ASSIGNED_TO_ANOTHER_USER

public static final CreateUserReturnStatusEnumType MAILBOX_ASSIGNED_TO_ANOTHER_USER
Mailbox is already assigned to another user. Make sure user has not been created already.


COULD_NOT_ENABLE_BLACKBERRY_USER

public static final CreateUserReturnStatusEnumType COULD_NOT_ENABLE_BLACKBERRY_USER
Failed to create a BlackBerry enabled user.


CANNOT_ADD_USER_TO_GROUP

public static final CreateUserReturnStatusEnumType CANNOT_ADD_USER_TO_GROUP
Failed to add user to group.


CANNOT_ATTACH_ITPOLICY_TO_USER

public static final CreateUserReturnStatusEnumType CANNOT_ATTACH_ITPOLICY_TO_USER
Failed to attach IT Policy to user.


CANNOT_ATTACH_SOFTWARE_CONFIGURATION_TO_USER

public static final CreateUserReturnStatusEnumType CANNOT_ATTACH_SOFTWARE_CONFIGURATION_TO_USER
Failed to attach Software Configuration to user.

Method Detail

values

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

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

valueOf

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

BlackBerry Administration API
v5.0.3.29

Copyright 2009 Research In Motion Limited. All Rights Reserved.