Package ru.easydonate.easydonate4j.api.v3.data.model.shop

Enum ActivityFlag

java.lang.Object

java.lang.Enum<ActivityFlag>

ru.easydonate.easydonate4j.api.v3.data.model.shop.ActivityFlag

All Implemented Interfaces:

Serializable, Comparable<ActivityFlag>

public enum ActivityFlag
extends Enum<ActivityFlag>

The enum that represents all possible and actual activity flags.
This flag can be used to filter the mass sales/coupons list response.

Author:

soknight

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	Represents a filter for any items.
ONLY_ACTIVE	Represents a filter for only active items.
ONLY_INACTIVE	Represents a filter for only inactive items.

Method Summary

Modifier and Type	Method	Description
@NotNull QueryParams	addAsQueryParameter(@NotNull QueryParams queryParams)	Add this activity flag constant as a query parameter.
static ActivityFlag	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ActivityFlag[]	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

ONLY_ACTIVE

public static final ActivityFlag ONLY_ACTIVE

Represents a filter for only active items.

ONLY_INACTIVE

public static final ActivityFlag ONLY_INACTIVE

Represents a filter for only inactive items.

ALL

public static final ActivityFlag ALL

Represents a filter for any items.

Method Detail

values

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

Returns:

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

valueOf

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

addAsQueryParameter

@NotNull
public @NotNull QueryParams addAsQueryParameter(@NotNull
                                                @NotNull QueryParams queryParams)

Add this activity flag constant as a query parameter.

Parameters:

queryParams - the original query params instance.

Returns:

The modified query params instance (not a new object).