|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<SubtreeAccessibilityState>
com.unboundid.ldap.sdk.unboundidds.extensions.SubtreeAccessibilityState
public enum SubtreeAccessibilityState
NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.This enum defines the set of allowed accessibility states that may be used with the
SetSubtreeAccessibilityExtendedRequest
.
Enum Constant Summary | |
---|---|
ACCESSIBLE
Indicates that the subtree should return to normal accessibility so that all appropriately-authorized users will be able to perform all kinds of operations in the target subtree. |
|
HIDDEN
Indicates that the subtree should be made hidden so that is is not accessible to most clients for any kinds of operations. |
|
READ_ONLY_BIND_ALLOWED
Indicates that the subtree should be made read-only so that search and compare operations targeting those entries will be allowed, but add, delete, modify, and modify DN operations will only be allowed for one specified user (as indicated in the set subtree accessibility request). |
|
READ_ONLY_BIND_DENIED
Indicates that the subtree should be made read-only so that search and compare operations targeting those entries will be allowed, but add, delete, modify, and modify DN operations will only be allowed for one specified user (as indicated in the set subtree accessibility request). |
Method Summary | |
---|---|
static SubtreeAccessibilityState |
forName(java.lang.String name)
Retrieves the subtree accessibility state with the provided name. |
java.lang.String |
getStateName()
Retrieves the name for this subtree accessibility state. |
int |
intValue()
Retrieves the integer value for this subtree accessibility state. |
boolean |
isAccessible()
Indicates whether this state object represents the ACCESSIBLE state. |
boolean |
isHidden()
Indicates whether this state object represents the HIDDEN state. |
boolean |
isReadOnly()
Indicates whether this state object represents one of the read-only states. |
java.lang.String |
toString()
Retrieves a string representation of this subtree accessibility state. |
static SubtreeAccessibilityState |
valueOf(int intValue)
Retrieves the subtree accessibility state with the specified integer value. |
static SubtreeAccessibilityState |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static SubtreeAccessibilityState[] |
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, valueOf |
Methods inherited from class java.lang.Object |
---|
getClass, notify, notifyAll, wait, wait, wait |
Enum Constant Detail |
---|
public static final SubtreeAccessibilityState ACCESSIBLE
public static final SubtreeAccessibilityState READ_ONLY_BIND_ALLOWED
public static final SubtreeAccessibilityState READ_ONLY_BIND_DENIED
public static final SubtreeAccessibilityState HIDDEN
Method Detail |
---|
public static SubtreeAccessibilityState[] values()
for (SubtreeAccessibilityState c : SubtreeAccessibilityState.values()) System.out.println(c);
public static SubtreeAccessibilityState valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic int intValue()
public java.lang.String getStateName()
public boolean isAccessible()
true
if this state object represents the ACCESSIBLE state,
or false
if not.public boolean isHidden()
true
if this state object represents the HIDDEN state,
or false
if not.public boolean isReadOnly()
true
if this state object represents one of the read-only
states, or false
if not.public static SubtreeAccessibilityState valueOf(int intValue)
intValue
- The integer value for the state to retrieve.
null
if there is no accessibility state with the
specified integer value.public static SubtreeAccessibilityState forName(java.lang.String name)
name
- The name for the subtree accessibility state to retrieve.
null
if no state has the provided name.public java.lang.String toString()
toString
in class java.lang.Enum<SubtreeAccessibilityState>
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |