Package com.avoka.fc.core.service.archive

Enum FormVersionArchiveService.ImportOption

java.lang.Object

java.lang.Enum<FormVersionArchiveService.ImportOption>

com.avoka.fc.core.service.archive.FormVersionArchiveService.ImportOption

All Implemented Interfaces:

IJMImportOption, Serializable, Comparable<FormVersionArchiveService.ImportOption>

Enclosing class:

FormVersionArchiveService

public static enum FormVersionArchiveService.ImportOption
extends Enum<FormVersionArchiveService.ImportOption>
implements IJMImportOption

Various import options controlling which entities will be imported

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTACHMENTS
CATEGORIES
COPY_FROM_LATEST_VERSION
CURRENT_VERSION
DELIVERY_DETAILS
DEPLOYMENT_PLAN
FORM_DATA_CONFIGURATION
FORM_DEFINITION
FORM_FUNCTIONS
FORM_GROUPS
FORM_SPACES
METADATA
PROPERTIES
VERSION_SERVICES

Method Summary

Modifier and Type	Method	Description
Set<FormVersionArchiveService.ImportOption>	defaultForImportAction(String metadataImportAction)	Returns the set of import actions that constitute a sensible default for the given metadata import action
String	toString()	Returns a string representation of the import option
static FormVersionArchiveService.ImportOption	valueOf(String name)	Returns the enum constant of this type with the specified name.
static FormVersionArchiveService.ImportOption[]	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

FORM_DEFINITION

public static final FormVersionArchiveService.ImportOption FORM_DEFINITION

DELIVERY_DETAILS

public static final FormVersionArchiveService.ImportOption DELIVERY_DETAILS

FORM_FUNCTIONS

public static final FormVersionArchiveService.ImportOption FORM_FUNCTIONS

FORM_GROUPS

public static final FormVersionArchiveService.ImportOption FORM_GROUPS

FORM_SPACES

public static final FormVersionArchiveService.ImportOption FORM_SPACES

CURRENT_VERSION

public static final FormVersionArchiveService.ImportOption CURRENT_VERSION

DEPLOYMENT_PLAN

public static final FormVersionArchiveService.ImportOption DEPLOYMENT_PLAN

FORM_DATA_CONFIGURATION

public static final FormVersionArchiveService.ImportOption FORM_DATA_CONFIGURATION

ATTACHMENTS

public static final FormVersionArchiveService.ImportOption ATTACHMENTS

PROPERTIES

public static final FormVersionArchiveService.ImportOption PROPERTIES

VERSION_SERVICES

public static final FormVersionArchiveService.ImportOption VERSION_SERVICES

METADATA

public static final FormVersionArchiveService.ImportOption METADATA

CATEGORIES

public static final FormVersionArchiveService.ImportOption CATEGORIES

COPY_FROM_LATEST_VERSION

public static final FormVersionArchiveService.ImportOption COPY_FROM_LATEST_VERSION

Method Detail

values

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

Returns:

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

valueOf

public static FormVersionArchiveService.ImportOption 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

defaultForImportAction

public Set<FormVersionArchiveService.ImportOption> defaultForImportAction(String metadataImportAction)

Returns the set of import actions that constitute a sensible default for the given metadata import action

Specified by:

defaultForImportAction in interface IJMImportOption

Parameters:

metadataImportAction - the import action that will be performed (one of BaseArchiveService.METADATA_IMPORT_ACTION_CREATE, BaseArchiveService.METADATA_IMPORT_ACTION_UPDATE)

Returns:

the default set of import options for the given metadata import action (immutable)

Since:

20.05.0

toString

public String toString()

Returns a string representation of the import option

Overrides:

toString in class Enum<FormVersionArchiveService.ImportOption>

Returns:

a readable string representation of the import option's name