BlackBerry Administration API
v5.0.3.29

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

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

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

Java class for AddUserToGroupReturnStatusEnumType.

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

 <simpleType name="AddUserToGroupReturnStatusEnumType">
   <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="GROUP_NOT_FOUND"/>
     <enumeration value="CANNOT_ADD_USER_TO_EXTERNAL_GROUP"/>
     <enumeration value="CANNOT_ADD_USER_TO_DYNAMIC_GROUP"/>
     <enumeration value="GROUP_ATTACHMENT_ALREADY_EXISTS"/>
   </restriction>
 </simpleType>
 


Enum Constant Summary
CANNOT_ADD_USER_TO_DYNAMIC_GROUP
          Cannot add user to group since the group is of type Dynamic.
CANNOT_ADD_USER_TO_EXTERNAL_GROUP
          Cannot add user to group since the group is of type External.
GROUP_ATTACHMENT_ALREADY_EXISTS
          User is already added to group.
GROUP_NOT_FOUND
          Cannot find group with specified ID.
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
          At least one user failed to be attached to the group.
SUCCESS
          API call completed successfully.
UNKNOWN
          An unknown error has occurred.
USER_NOT_FOUND
          Cannot find user with specified ID.
 
Method Summary
static AddUserToGroupReturnStatusEnumType fromValue(java.lang.String v)
           
 java.lang.String value()
           
static AddUserToGroupReturnStatusEnumType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static AddUserToGroupReturnStatusEnumType[] 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 AddUserToGroupReturnStatusEnumType SUCCESS
API call completed successfully.


UNKNOWN

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


NOT_AUTHORIZED

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


RESULT_ERROR_EXISTS

public static final AddUserToGroupReturnStatusEnumType RESULT_ERROR_EXISTS
At least one user failed to be attached to the group. Check the return status of individual attach user to group results.


INVALID_PARAMETER

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


USER_NOT_FOUND

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


GROUP_NOT_FOUND

public static final AddUserToGroupReturnStatusEnumType GROUP_NOT_FOUND
Cannot find group with specified ID.


CANNOT_ADD_USER_TO_EXTERNAL_GROUP

public static final AddUserToGroupReturnStatusEnumType CANNOT_ADD_USER_TO_EXTERNAL_GROUP
Cannot add user to group since the group is of type External.


CANNOT_ADD_USER_TO_DYNAMIC_GROUP

public static final AddUserToGroupReturnStatusEnumType CANNOT_ADD_USER_TO_DYNAMIC_GROUP
Cannot add user to group since the group is of type Dynamic.


GROUP_ATTACHMENT_ALREADY_EXISTS

public static final AddUserToGroupReturnStatusEnumType GROUP_ATTACHMENT_ALREADY_EXISTS
User is already added to group.

Method Detail

values

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

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

valueOf

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

BlackBerry Administration API
v5.0.3.29

Copyright 2009 Research In Motion Limited. All Rights Reserved.