co.poynt.os.services.v1

Interface IPoyntBusinessService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntBusinessService.Stub

public interface IPoyntBusinessService
extends android.os.IInterface

Provides the interfaces necessary to retrive various entities of a business including the terminal activation process. 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	IPoyntBusinessService.Stub Local-side IPC implementation stub class.

Method Summary

Modifier and Type	Method and Description
void	activateTerminal(co.poynt.api.model.ActivateStoreDeviceRequest activateStoreDeviceRequest, IPoyntBusinessActivationListener callback) Activates the terminal using the business credentials (MID and TID) and also creates the owner business user account with the given user name and passcode.
void	createBusinessUser(co.poynt.api.model.BusinessUser businessUser, IPoyntBusinessCustomerListener callback) Adds a new business user to the business/store the terminal is associated with.
void	discoverServices(IPoyntDiscoveryListener callback) Discover various services available for this device
void	discoverTerminal(IPoyntTerminalDiscoveryListener callback) Discover various terminals available for activation.
void	getActivationState(IPoyntBusinessActivationListener callback) Get activation state of this device on initial boot.
void	getAllBusinesses(IPoyntAllBusinessReadListener callback) Retrieves all the Business with which the current Poynt Terminal is associated with.
void	getBusiness(IPoyntBusinessReadListener callback) Retrieves the curent selected Business with which the Poynt Terminal is associated with.
void	getBusinessById(java.lang.String businessId, IPoyntBusinessReadListener callback) Retrieves a business Business with which the Poynt Terminal is associated with using the provided business id.
void	getBusinessProcessorData(IPoyntBusinessProcessorDataListener callback) Retrieves the curent selected Business including Processor data, with which the Poynt Terminal is associated.
void	getBusinessUser(long businessUserId, IPoyntBusinessCustomerListener callback) Retrieves the BusinessUser for the given businessUserId.
void	getBusinessUsers(IPoyntBusinessCustomersListListener callback) Retrieves the co.poynt.api.model.BusinessUsers of the Business with which the current Poynt Terminal is associated with.
void	getBusinessUsersFromCloud(IPoyntBusinessCustomersListListener callback) Retrieves the co.poynt.api.model.BusinessUsers of the Business with which the current Poynt Terminal is associated with, but skips the local data store and retreives the data from the Poynt cloud.
void	recordBusinessAgreement(co.poynt.api.model.BusinessAgreement businessAgreement, IPoyntBusinessAgreementListener callback) Records the business agreement (Eg.
void	updateBusinessUserCredential(long businessUserId, co.poynt.api.model.UserCredentialRequest credential, IPoyntBusinessCustomerListener callback) Updates the login credential for the given business user.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

getBusiness

void getBusiness(IPoyntBusinessReadListener callback)
          throws android.os.RemoteException

Retrieves the curent selected Business with which the Poynt Terminal is associated with. If the business information is not available locally, it will be fetched from the Poynt Cloud.

Parameters:

callback - IPoyntBusinessReadListener

Throws:

android.os.RemoteException

getBusinessUsersFromCloud

void getBusinessUsersFromCloud(IPoyntBusinessCustomersListListener callback)
                        throws android.os.RemoteException

Retrieves the co.poynt.api.model.BusinessUsers of the Business with which the current Poynt Terminal is associated with, but skips the local data store and retreives the data from the Poynt cloud.

Parameters:

callback - IPoyntBusinessCustomersListListener

Throws:

android.os.RemoteException

getBusinessUsers

void getBusinessUsers(IPoyntBusinessCustomersListListener callback)
               throws android.os.RemoteException

Retrieves the co.poynt.api.model.BusinessUsers of the Business with which the current Poynt Terminal is associated with.

Parameters:

callback - IPoyntBusinessCustomersListListener

Throws:

android.os.RemoteException

getBusinessUser

void getBusinessUser(long businessUserId,
                     IPoyntBusinessCustomerListener callback)
              throws android.os.RemoteException

Retrieves the BusinessUser for the given businessUserId.

Parameters:

businessUserId - ID of the business user to fetch.

callback - IPoyntBusinessCustomerListener

Throws:

android.os.RemoteException

activateTerminal

void activateTerminal(co.poynt.api.model.ActivateStoreDeviceRequest activateStoreDeviceRequest,
                      IPoyntBusinessActivationListener callback)
               throws android.os.RemoteException

Activates the terminal using the business credentials (MID and TID) and also creates the owner business user account with the given user name and passcode.

Parameters:

activateStoreDeviceRequest - ActivateStoreDeviceRequest

callback - IPoyntBusinessActivationListener

Throws:

android.os.RemoteException

discoverServices

void discoverServices(IPoyntDiscoveryListener callback)
               throws android.os.RemoteException

Discover various services available for this device

Parameters:

callback - IPoyntDiscoveryListener

Throws:

android.os.RemoteException

discoverTerminal

void discoverTerminal(IPoyntTerminalDiscoveryListener callback)
               throws android.os.RemoteException

Discover various terminals available for activation.

Parameters:

callback - IPoyntTerminalDiscoveryListener

Throws:

android.os.RemoteException

getActivationState

void getActivationState(IPoyntBusinessActivationListener callback)
                 throws android.os.RemoteException

Get activation state of this device on initial boot.

Parameters:

callback - IPoyntBusinessActivationListener

Throws:

android.os.RemoteException

createBusinessUser

void createBusinessUser(co.poynt.api.model.BusinessUser businessUser,
                        IPoyntBusinessCustomerListener callback)
                 throws android.os.RemoteException

Adds a new business user to the business/store the terminal is associated with.

Parameters:

businessUser - BusinessUser

callback - IPoyntBusinessCustomerListener

Throws:

android.os.RemoteException

updateBusinessUserCredential

void updateBusinessUserCredential(long businessUserId,
                                  co.poynt.api.model.UserCredentialRequest credential,
                                  IPoyntBusinessCustomerListener callback)
                           throws android.os.RemoteException

Updates the login credential for the given business user.

Parameters:

businessUserId - ID of the business user to update

callback - IPoyntBusinessCustomerListener

Throws:

android.os.RemoteException

recordBusinessAgreement

void recordBusinessAgreement(co.poynt.api.model.BusinessAgreement businessAgreement,
                             IPoyntBusinessAgreementListener callback)
                      throws android.os.RemoteException

Records the business agreement (Eg. EULA)

Parameters:

businessAgreement - BusinessAgreement

callback - IPoyntBusinessAgreementListener

Throws:

android.os.RemoteException

getBusinessById

void getBusinessById(java.lang.String businessId,
                     IPoyntBusinessReadListener callback)
              throws android.os.RemoteException

Retrieves a business Business with which the Poynt Terminal is associated with using the provided business id. If the business information is not available locally, it will be fetched from the Poynt Cloud. The specified businessId must be an id that the Poynt Terminal is activated against.

Parameters:

businessId - Id of the business to load

callback - IPoyntBusinessReadListener

Throws:

android.os.RemoteException

getAllBusinesses

void getAllBusinesses(IPoyntAllBusinessReadListener callback)
               throws android.os.RemoteException

Retrieves all the Business with which the current Poynt Terminal is associated with. If the business information is not available locally, it will be fetched from the Poynt Cloud.

Parameters:

callback - IPoyntBusinessReadListener

Throws:

android.os.RemoteException

getBusinessProcessorData

void getBusinessProcessorData(IPoyntBusinessProcessorDataListener callback)
                       throws android.os.RemoteException

Retrieves the curent selected Business including Processor data, with which the Poynt Terminal is associated. It will be fetched from the Poynt Cloud.

Parameters:

callback - IPoyntBusinessProcessorDataListener

Throws:

android.os.RemoteException