public interface

ButtonProductCompatible

com.usebutton.merchant.ButtonProductCompatible
Known Indirect Subclasses

Class Overview

An interface that defines the product properties that may be provided when reporting user activity.

Summary

Public Methods
abstract Map<String, String> getAttributes()
abstract List<String> getCategories()
abstract String getCurrency()
abstract String getId()
abstract String getName()
abstract Integer getQuantity()
abstract String getUpc()
abstract String getUrl()
abstract Integer getValue()

Public Methods

public abstract Map<String, String> getAttributes ()

Returns
  • any additional attributes to be included with the product

public abstract List<String> getCategories ()

Returns
  • a flat array of the names of the categories to which the product belongs

public abstract String getCurrency ()

Returns
  • the ISO-4217 currency code in which the product's value is reported

public abstract String getId ()

Returns
  • the product identifier

public abstract String getName ()

Returns
  • the name of the product

public abstract Integer getQuantity ()

Returns
  • the quantity of the product

public abstract String getUpc ()

Returns
  • the UPC (Universal Product Code) of the product

public abstract String getUrl ()

Returns
  • the URL of the product

public abstract Integer getValue ()

Returns
  • the value of the order. Includes any discounts, if applicable. e.g: 1234 for $12.34