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

Enum PortalArchiveService.Option

java.lang.Object

java.lang.Enum<PortalArchiveService.Option>

com.avoka.fc.core.service.archive.PortalArchiveService.Option

All Implemented Interfaces:

IJMImportOption, Serializable, Comparable<PortalArchiveService.Option>

Enclosing class:

PortalArchiveService

public static enum PortalArchiveService.Option
extends Enum<PortalArchiveService.Option>
implements IJMImportOption

The option enum includes various import options for the archive service to perform import and export.

Enum Constant Summary

Enum Constants

Enum Constant	Description
PAGES
PORTAL_DEFINITION
PROPERTIES
RESOURCES

Method Summary

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

PORTAL_DEFINITION

public static final PortalArchiveService.Option PORTAL_DEFINITION

PAGES

public static final PortalArchiveService.Option PAGES

PROPERTIES

public static final PortalArchiveService.Option PROPERTIES

RESOURCES

public static final PortalArchiveService.Option RESOURCES

Method Detail

values

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

Returns:

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

valueOf

public static PortalArchiveService.Option 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<PortalArchiveService.Option> 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<PortalArchiveService.Option>

Returns:

a readable string representation of the import option's name