org.alfresco.module.vti.metadata.dic

Enum PutOption

java.lang.Object

java.lang.Enum<PutOption>

org.alfresco.module.vti.metadata.dic.PutOption

All Implemented Interfaces:

Serializable, Comparable<PutOption>

public enum PutOption
extends Enum<PutOption>

Used to define the behavior of file upload operations.

Author:

Michael Shavnev

Enum Constant Summary

Enum Constants

Enum Constant and Description
atomic Specified, the server does all the needed checking to ensure that all the files can be updated before changing the first one
checkin Used to support long-term checkout operations
checkout Valid only if checkin is specified.
createdir The parent directory is created if it does not exist.
edit Uses the date and time the document was last modified to determine whether the item has been concurrently modified by another user.
forceversions Acts as though versioning is enabled, even if it is not
listthickets Requests that metadata be returned for thicket supporting files.
migrationsemantics Preserves information about who created the file and when.
noadd Does not add the document to source control.
none The client MUST send "none" if it does not want to specify any of the options given by a RENAME-OPTION-VAL.
overwrite Uses the date and time the document was last modified, as specified in the inbound metainfo, rather than the extent of time on the server.
thicket Specifies that the associated file is a thicket supporting file.

Method Summary

Modifier and Type	Method and Description
static EnumSet<PutOption>	getOptions(String stringValues)
static PutOption	valueOf(String name) Returns the enum constant of this type with the specified name.
static PutOption[]	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

none

public static final PutOption none

The client MUST send "none" if it does not want to specify any of the options given by a RENAME-OPTION-VAL.

atomic

public static final PutOption atomic

Specified, the server does all the needed checking to ensure that all the files can be updated before changing the first one

checkin

public static final PutOption checkin

Used to support long-term checkout operations

checkout

public static final PutOption checkout

Valid only if checkin is specified. Notifies the source control of the new content (checkin), but keeps the document checked out.

createdir

public static final PutOption createdir

The parent directory is created if it does not exist.

edit

public static final PutOption edit

Uses the date and time the document was last modified to determine whether the item has been concurrently modified by another user. This flag is used to prevent race conditions where two users could edit the same data

forceversions

public static final PutOption forceversions

Acts as though versioning is enabled, even if it is not

listthickets

public static final PutOption listthickets

Requests that metadata be returned for thicket supporting files.

migrationsemantics

public static final PutOption migrationsemantics

Preserves information about who created the file and when.

noadd

public static final PutOption noadd

Does not add the document to source control.

overwrite

public static final PutOption overwrite

Uses the date and time the document was last modified, as specified in the inbound metainfo, rather than the extent of time on the server.

thicket

public static final PutOption thicket

Specifies that the associated file is a thicket supporting file.

Method Detail

values

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

Returns:

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

valueOf

public static PutOption valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getOptions

public static EnumSet<PutOption> getOptions(String stringValues)