com.clover.sdk.v1.merchant

Enum Module

java.lang.Object

java.lang.Enum<Module>

com.clover.sdk.v1.merchant.Module

All Implemented Interfaces:

Parcelable, Serializable, Comparable<Module>

public enum Module
extends Enum<Module>
implements Parcelable

Modules control which software features a merchant has access to and which apps a merchant may install and use. The modules enabled for a particular merchant are defined by the plan that a merchant is currently enrolled in. See Clover Docs: Understanding Modules for detailed information about plans and modules.

App developers can choose which modules they consider required for their app on the developer app dashboard. Merchants will not be able to purchase or install an app unless their plan has all the required modules for that particular app.

An app developer may choose to not require a module but could instead detect the enabled modules at runtime to show or hide software features.

Modules do not affect API functionality. For example, assuming an app has proper permissions, an app may still use the inventory APIs for a merchant that does not have the "ITEMS" module enabled.

See Also:

Merchant.getModules(), MerchantConnector

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

Parcelable.ClassLoaderCreator<T>, Parcelable.Creator<T>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ADVANCED_REPORTING
AUTOMATIC_DISCOUNTS
BAR_TAB_MANAGEMENT
CASH
COMBINE_ASSIGN_ORDERS
COST_OF_GOODS
CUSTOMER_PREFERENCES_PROMOTIONS
CUSTOMERS
DISCOUNTS
EMPLOYEES
FAST_PAY
FISCAL_PRINTERS
ITEM_EXCHANGES
ITEM_MODIFIERS
ITEM_VARIANTS
ITEMS
MERCHANT
ORDER_PRINTERS
ORDER_TYPES
ORDERS
PAYMENTS
PHONE_SALES
PRINTERS
REGISTER_PREAUTH
RESTAURANT_SHIFT_MANAGEMENT
RETAIL_HUB
SERVICE_CHARGES
TABLE_MANAGEMENT
TABLE_SERVICE
TAX_RATES
WEIGH_PER_UNIT_ITEMS

Field Summary

Fields

Modifier and Type	Field and Description
static Parcelable.Creator<Module>	CREATOR

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Modifier and Type	Method and Description
int	describeContents()
static Module	valueOf(String name) Returns the enum constant of this type with the specified name.
static Module[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
void	writeToParcel(Parcel dest, int flags)

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

MERCHANT

public static final Module MERCHANT

PAYMENTS

public static final Module PAYMENTS

EMPLOYEES

public static final Module EMPLOYEES

PRINTERS

public static final Module PRINTERS

CUSTOMERS

public static final Module CUSTOMERS

ORDERS

public static final Module ORDERS

ITEMS

public static final Module ITEMS

CASH

public static final Module CASH

DISCOUNTS

public static final Module DISCOUNTS

TAX_RATES

public static final Module TAX_RATES

ORDER_TYPES

public static final Module ORDER_TYPES

ORDER_PRINTERS

public static final Module ORDER_PRINTERS

ITEM_MODIFIERS

public static final Module ITEM_MODIFIERS

SERVICE_CHARGES

public static final Module SERVICE_CHARGES

COMBINE_ASSIGN_ORDERS

public static final Module COMBINE_ASSIGN_ORDERS

AUTOMATIC_DISCOUNTS

public static final Module AUTOMATIC_DISCOUNTS

WEIGH_PER_UNIT_ITEMS

public static final Module WEIGH_PER_UNIT_ITEMS

ITEM_VARIANTS

public static final Module ITEM_VARIANTS

TABLE_MANAGEMENT

public static final Module TABLE_MANAGEMENT

ITEM_EXCHANGES

public static final Module ITEM_EXCHANGES

CUSTOMER_PREFERENCES_PROMOTIONS

public static final Module CUSTOMER_PREFERENCES_PROMOTIONS

BAR_TAB_MANAGEMENT

public static final Module BAR_TAB_MANAGEMENT

RESTAURANT_SHIFT_MANAGEMENT

public static final Module RESTAURANT_SHIFT_MANAGEMENT

FISCAL_PRINTERS

public static final Module FISCAL_PRINTERS

PHONE_SALES

public static final Module PHONE_SALES

REGISTER_PREAUTH

public static final Module REGISTER_PREAUTH

FAST_PAY

public static final Module FAST_PAY

TABLE_SERVICE

public static final Module TABLE_SERVICE

COST_OF_GOODS

public static final Module COST_OF_GOODS

ADVANCED_REPORTING

public static final Module ADVANCED_REPORTING

RETAIL_HUB

public static final Module RETAIL_HUB

Field Detail

CREATOR

public static final Parcelable.Creator<Module> CREATOR

Method Detail

values

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

Returns:

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

valueOf

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

describeContents

public int describeContents()

Specified by:

describeContents in interface Parcelable

writeToParcel

public void writeToParcel(Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface Parcelable