com.foreach.across.modules.webcms.data

Enum WebCmsDataImportAction

java.lang.Object

java.lang.Enum<WebCmsDataImportAction>

com.foreach.across.modules.webcms.data.WebCmsDataImportAction

All Implemented Interfaces:

Serializable, Comparable<WebCmsDataImportAction>

public enum WebCmsDataImportAction
extends Enum<WebCmsDataImportAction>

Represents the default action to perform with the data represented by a WebCmsDataEntry. Can be present in a data collection as the wcm:action key.

Since:

0.0.1

Author:

Arne Vandamme

Enum Constant Summary

Enum Constants

Enum Constant and Description
CREATE Only create the entities if they do not yet exist.
CREATE_OR_REPLACE Replace the entities if they exist, create them if they do not.
CREATE_OR_UPDATE Create the entities if they do not yet exist, or update any existing entities.
DELETE Delete the entities.
REPLACE Replace the entities if they exist.
UPDATE Only update the entities, do nothing if they do not yet exist.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ATTRIBUTE_NAME

Method Summary

Modifier and Type	Method and Description
static WebCmsDataImportAction	fromAttributeValue(String attributeValue) Retrieve the action represented by an attribute value.
static WebCmsDataImportAction	valueOf(String name) Returns the enum constant of this type with the specified name.
static WebCmsDataImportAction[]	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

CREATE

public static final WebCmsDataImportAction CREATE

Only create the entities if they do not yet exist.

CREATE_OR_UPDATE

public static final WebCmsDataImportAction CREATE_OR_UPDATE

Create the entities if they do not yet exist, or update any existing entities. Updating will only apply the defined properties and will keep all others untouched.

UPDATE

public static final WebCmsDataImportAction UPDATE

Only update the entities, do nothing if they do not yet exist.

DELETE

public static final WebCmsDataImportAction DELETE

Delete the entities.

REPLACE

public static final WebCmsDataImportAction REPLACE

Replace the entities if they exist. If they do not exist no action will be performed.

A replace wipes all values of the existing entities except ID properties, but the resulting instances should be the same as if newly created. Replace support is implementation dependant.

CREATE_OR_REPLACE

public static final WebCmsDataImportAction CREATE_OR_REPLACE

Replace the entities if they exist, create them if they do not.

A replace wipes all values of the existing entities except ID properties, but the resulting instances should be the same as if newly created. Replace support is implementation dependant.

Field Detail

ATTRIBUTE_NAME

public static final String ATTRIBUTE_NAME

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static WebCmsDataImportAction 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

fromAttributeValue

public static WebCmsDataImportAction fromAttributeValue(String attributeValue)

Retrieve the action represented by an attribute value.

Parameters:

attributeValue - that represents the action

Returns:

action or null if could not be mapped