co.poynt.os.services.v1

Interface IPoyntProductService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntProductService.Stub

public interface IPoyntProductService
extends android.os.IInterface

Provides the interfaces necessary to retrive Catalogs and Products that belong to the business and store that the current terminal is associated with. All calls require the necessary permissions declared in the caller's Android Manifest file. Please refer to Poynt OS Permissions for more details. When the requested information is not available locally (Poynt Content Providers), it will be fetched from the Poynt Cloud and saved locally for future references.

Since:

1.0-beta2

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IPoyntProductService.Stub Local-side IPC implementation stub class.

Method Summary

Modifier and Type	Method and Description
void	getCatalog(java.lang.String catalogId, IPoyntProductCatalogListener callback) Retrieves the Catalog associated with the given catalogId.
void	getCategories(java.lang.String catalogId, java.util.List<java.lang.String> categoryIds, IPoyntProductCategoriesListener callback) Retrieves a list of all categories of products associated with the given categoryIds for the given catalogId.
void	getProduct(java.lang.String productId, IPoyntProductListener callback) Retrieves the Product associated with the given productId.
void	getProductBySku(java.lang.String sku, IPoyntProductListener callback) Retrieves the Product associated with the given sku (stock keeping unit).
void	getProductByUpc(java.lang.String upc, IPoyntProductListener callback) Retrieves the Product associated with the given upc code.
void	getProducts(java.util.List<java.lang.String> productIds, IPoyntProductListListener callback) Retrieves a list of all products associated with the given productIds.
void	getProductsFromCloud(java.util.List<java.lang.String> productIds, IPoyntProductListListener callback) Retrieves a list of all products associated with the given productIds.
void	getRegisterCatalog(IPoyntProductCatalogListener callback) Retrieves the Catalog associated with the terminal.
void	getRegisterCatalogFromCloud(IPoyntProductCatalogListener callback) Retrieves the Catalog associated with the terminal.
void	getRegisterCatalogWithProducts(IPoyntProductCatalogWithProductListener callback) Retrieves the CatalogWithProduct associated with the terminal.
void	getRegisterCatalogWithProductsFromCloud(IPoyntProductCatalogWithProductListener callback) Retrieves the CatalogWithProduct associated with the terminal.
void	updateProduct(java.lang.String productId, java.lang.String jsonArrayPatchElementsArray, IPoyntProductListener callback) Upate the Product associated with the given productId.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

getCatalog

void getCatalog(java.lang.String catalogId,
                IPoyntProductCatalogListener callback)
         throws android.os.RemoteException

Retrieves the Catalog associated with the given catalogId. If the catalog information is not available locally, it will be fetched from the Poynt Cloud.

Parameters:

catalogId - ID of the catalog to retrieve

callback - IPoyntProductCatalogListener

Throws:

android.os.RemoteException

getRegisterCatalog

void getRegisterCatalog(IPoyntProductCatalogListener callback)
                 throws android.os.RemoteException

Retrieves the Catalog associated with the terminal. If the catalog information is not available locally, it will be fetched from the Poynt Cloud.

Parameters:

callback - IPoyntProductCatalogListener

Throws:

android.os.RemoteException

getRegisterCatalogWithProducts

void getRegisterCatalogWithProducts(IPoyntProductCatalogWithProductListener callback)
                             throws android.os.RemoteException

Retrieves the CatalogWithProduct associated with the terminal. If the catalog information is not available locally, it will be fetched from the Poynt Cloud. This catalog contains a fully hydrated category and product lists so you do not have to perform additional calls to retreive the data.

Parameters:

callback - IPoyntProductCatalogWithProductListener

Throws:

android.os.RemoteException

getRegisterCatalogWithProductsFromCloud

void getRegisterCatalogWithProductsFromCloud(IPoyntProductCatalogWithProductListener callback)
                                      throws android.os.RemoteException

Retrieves the CatalogWithProduct associated with the terminal. This call will skip the local data store and access the Poynt Cloud directly. This catalog contains a fully hydrated category and product lists so you do not have to perform additional calls to retreive the data.

Parameters:

callback - IPoyntProductCatalogWithProductListener

Throws:

android.os.RemoteException

getRegisterCatalogFromCloud

void getRegisterCatalogFromCloud(IPoyntProductCatalogListener callback)
                          throws android.os.RemoteException

Retrieves the Catalog associated with the terminal. This call will skip the local data store and access the Poynt Cloud directly.

Parameters:

callback - IPoyntProductCatalogListener

Throws:

android.os.RemoteException

getProduct

void getProduct(java.lang.String productId,
                IPoyntProductListener callback)
         throws android.os.RemoteException

Retrieves the Product associated with the given productId. If the product information is not available locally, it will be fetched from the Poynt Cloud.

Parameters:

productId - ID of the product to retrieve

callback - IPoyntProductListener

Throws:

android.os.RemoteException

getProductBySku

void getProductBySku(java.lang.String sku,
                     IPoyntProductListener callback)
              throws android.os.RemoteException

Retrieves the Product associated with the given sku (stock keeping unit). If the product information is not available locally, it will be fetched from the Poynt Cloud.

Parameters:

sku - sku of the product to retrieve

callback - IPoyntProductListener

Throws:

android.os.RemoteException

getProductByUpc

void getProductByUpc(java.lang.String upc,
                     IPoyntProductListener callback)
              throws android.os.RemoteException

Retrieves the Product associated with the given upc code. If the product information is not available locally, it will be fetched from the Poynt Cloud.

Parameters:

upc - UPC code of the product to retrieve

callback - IPoyntProductListener

Throws:

android.os.RemoteException

getProducts

void getProducts(java.util.List<java.lang.String> productIds,
                 IPoyntProductListListener callback)
          throws android.os.RemoteException

Retrieves a list of all products associated with the given productIds. If the product information is not available locally, it will be fetched from the Poynt Cloud.

Parameters:

productIds - List of all productIds

callback - IPoyntProductListListener

Throws:

android.os.RemoteException

getProductsFromCloud

void getProductsFromCloud(java.util.List<java.lang.String> productIds,
                          IPoyntProductListListener callback)
                   throws android.os.RemoteException

Retrieves a list of all products associated with the given productIds. This call skips the local databases and accesses the data remotely from the Poynt Cloud.

Parameters:

productIds - List of all productIds

callback - IPoyntProductListener

Throws:

android.os.RemoteException

getCategories

void getCategories(java.lang.String catalogId,
                   java.util.List<java.lang.String> categoryIds,
                   IPoyntProductCategoriesListener callback)
            throws android.os.RemoteException

Retrieves a list of all categories of products associated with the given categoryIds for the given catalogId. If the product information is not available locally, it will be fetched from the Poynt Cloud.

Parameters:

catalogId - Id of the catalog

categoryIds - List of all categoryIds

callback - IPoyntProductCategoriesListener

Throws:

android.os.RemoteException

updateProduct

void updateProduct(java.lang.String productId,
                   java.lang.String jsonArrayPatchElementsArray,
                   IPoyntProductListener callback)
            throws android.os.RemoteException

Upate the Product associated with the given productId.

Parameters:

productId - ID of the product to update

jsonPatchElementsArray - array of jsonPatchElement to be updated passed as a string.

callback - IPoyntProductListener

Throws:

android.os.RemoteException