com.marklogic.client.bitemporal

Enum TemporalDocumentManager.ProtectionLevel

java.lang.Object

java.lang.Enum<TemporalDocumentManager.ProtectionLevel>

com.marklogic.client.bitemporal.TemporalDocumentManager.ProtectionLevel

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TemporalDocumentManager.ProtectionLevel>

Enclosing interface:

TemporalDocumentManager<R extends AbstractReadHandle,W extends AbstractWriteHandle>

public static enum TemporalDocumentManager.ProtectionLevel
extends java.lang.Enum<TemporalDocumentManager.ProtectionLevel>

Various protection levels to prevent updation/deletion and wiping of temporal documents. You can request a more restrictive protection level than the current protection level but not a lesser restrictive level. The descending order of restriction levels are as follows: NOUPDATE, NODELETE and NOWIPE

Enum Constant Summary

Enum Constants

Enum Constant and Description
NODELETE Protection level to prevent deletion of a temporal document.
NOUPDATE Protection level to prevent updating a temporal document.
NOWIPE Protection level to prevent wiping of a temporal document

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()
static TemporalDocumentManager.ProtectionLevel	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TemporalDocumentManager.ProtectionLevel[]	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

NOUPDATE

public static final TemporalDocumentManager.ProtectionLevel NOUPDATE

Protection level to prevent updating a temporal document. This includes protection against temporal document wipe and delete as well.

NODELETE

public static final TemporalDocumentManager.ProtectionLevel NODELETE

Protection level to prevent deletion of a temporal document. This includes protection against temporal document wipe as well.

NOWIPE

public static final TemporalDocumentManager.ProtectionLevel NOWIPE

Protection level to prevent wiping of a temporal document

Method Detail

values

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

Returns:

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

valueOf

public static TemporalDocumentManager.ProtectionLevel 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Enum<TemporalDocumentManager.ProtectionLevel>