Package com.inteliqua.rest.coupon.payload

Enum CouponRequestAction

java.lang.Object

java.lang.Enum<CouponRequestAction>

com.inteliqua.rest.coupon.payload.CouponRequestAction

All Implemented Interfaces:

Serializable, Comparable<CouponRequestAction>

public enum CouponRequestAction
extends Enum<CouponRequestAction>

Enum representing various actions that can be performed on a coupon.

The actions include assigning, using, and executing flows for coupons. Some of the actions, such as ASSIGN_GIVE_EXECUTE_FLOW, USE_EXECUTE_FLOW, and EXECUTE_FLOW, are deprecated as transaction/member flows are always triggered when configured in TaskFlowEvent.

This enum helps manage and validate different coupon-related actions in the system.

Author:

nikritikos

Enum Constant Summary

Enum Constants

Enum Constant	Description
ASSIGN	Assign a coupon.
ASSIGN_EXECUTE_COUPON_FLOW	Assign and execute a coupon flow.
ASSIGN_GIVE	Assign and give a coupon.
ASSIGN_GIVE_EXECUTE_FLOW	Deprecated.
ASSIGN_GIVE_USE	Assign, give, and use a coupon.
EXECUTE_FLOW	Deprecated.
USE_EXECUTE_COUPON_FLOW	Use and execute a coupon flow.
USE_EXECUTE_FLOW	Deprecated.

Method Summary

Modifier and Type	Method	Description
String	getAction()	Gets the string representation of the coupon action.
static CouponRequestAction	resolveCouponRequestActionValue(String action)	Resolves the given action string to the corresponding CouponRequestAction.
static boolean	validateAction(String action)	Validates if a given action is a valid CouponRequestAction.
static CouponRequestAction	valueOf(String name)	Returns the enum constant of this type with the specified name.
static CouponRequestAction[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ASSIGN

public static final CouponRequestAction ASSIGN

Assign a coupon.

ASSIGN_GIVE

public static final CouponRequestAction ASSIGN_GIVE

Assign and give a coupon.

ASSIGN_GIVE_USE

public static final CouponRequestAction ASSIGN_GIVE_USE

Assign, give, and use a coupon.

ASSIGN_GIVE_EXECUTE_FLOW

@Deprecated
public static final CouponRequestAction ASSIGN_GIVE_EXECUTE_FLOW

Deprecated.

Deprecated action.

USE_EXECUTE_FLOW

@Deprecated
public static final CouponRequestAction USE_EXECUTE_FLOW

Deprecated.

Deprecated action.

EXECUTE_FLOW

@Deprecated
public static final CouponRequestAction EXECUTE_FLOW

Deprecated.

Deprecated action.

ASSIGN_EXECUTE_COUPON_FLOW

public static final CouponRequestAction ASSIGN_EXECUTE_COUPON_FLOW

Assign and execute a coupon flow.

USE_EXECUTE_COUPON_FLOW

public static final CouponRequestAction USE_EXECUTE_COUPON_FLOW

Use and execute a coupon flow.

Method Detail

values

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

Returns:

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

valueOf

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

getAction

public String getAction()

Gets the string representation of the coupon action.

Returns:

The action as a string.

validateAction

public static boolean validateAction(String action)

Validates if a given action is a valid CouponRequestAction.

Parameters:

action - The action to validate.

Returns:

true if the action is valid; false otherwise.

resolveCouponRequestActionValue

public static CouponRequestAction resolveCouponRequestActionValue(String action)

Resolves the given action string to the corresponding CouponRequestAction.

Parameters:

action - The action string to resolve.

Returns:

The corresponding CouponRequestAction.

Throws:

IllegalArgumentException - If the action is not valid.