co.poynt.os.services.v1

Interface IPoyntStayService

All Superinterfaces:

android.os.IInterface

All Known Implementing Classes:

IPoyntStayService.Stub

public interface IPoyntStayService
extends android.os.IInterface

Provides necessary interfaces to create and manage Stays. All operations require network connectivity except for the 'get' operations, in which case, data from the local Poynt Stays content providerName is returned. Poynt Stay content providerName is updated whenever the stays are modified locally or on the cloud. All calls require the necessary permissions declared in the caller's Android Manifest file. Please refer to Poynt OS Permissions for more details.

Since:

1.0-beta2

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
void	cancelStay(java.lang.String stayId, java.lang.String requestId, IPoyntStayServiceListener callback) Cancels the given stay through Poynt Cloud and also updates the stay in local Poynt Stay content providerName.
void	captureStay(java.lang.String stayId, co.poynt.api.model.Stay stay, java.lang.String requestId, IPoyntStayServiceListener callback) Captures the payment transactions associated with the given stay through Poynt Cloud and also updates the stay in local Poynt Stay content providerName.
void	completeStay(java.lang.String stayId, co.poynt.api.model.Stay stay, java.lang.String requestId, IPoyntStayServiceListener callback) Captures the payment transactions associated with the given stay and marks the oder as Completed.
void	createStay(co.poynt.api.model.Stay stay, java.lang.String requestId, IPoyntStayServiceListener callback) Creates the stay in Poynt Cloud and also saves the created stay in Poynt Stay content providerName.
void	getStay(java.lang.String stayId, java.lang.String requestId, IPoyntStayServiceListener callback) Retrieves the given stay from the local Poynt Stay content providerName if available, otherwise fetches from the Poynt Cloud .
void	getStayFromCloud(java.lang.String stayId, java.lang.String requestId, IPoyntStayServiceListener callback) Retrieves the given stay from the Poynt Cloud.
void	processStay(co.poynt.api.model.Stay stay, java.lang.String requestId, IPoyntStayServiceListener callback) Processes the given stay through Poynt Cloud and also saves the processed stay in local Poynt Stay content providerName.
void	updateStay(java.lang.String stayId, co.poynt.api.model.Stay stay, java.lang.String requestId, IPoyntStayServiceListener callback) Updates the given stay in the Poynt Cloud and updates local Poynt Stay content providerName.

Methods inherited from interface android.os.IInterface

asBinder

Method Detail

createStay

void createStay(co.poynt.api.model.Stay stay,
                java.lang.String requestId,
                IPoyntStayServiceListener callback)
         throws android.os.RemoteException

Creates the stay in Poynt Cloud and also saves the created stay in Poynt Stay content providerName. This interface only creates the stay and does not process any payment transactions (if any) specified in the Stay object.

Parameters:

stay - co.poynt.api.Stay

requestId - RequestId for Idempotency enforcement

callback - IPoyntStayServiceListener

Throws:

android.os.RemoteException

processStay

void processStay(co.poynt.api.model.Stay stay,
                 java.lang.String requestId,
                 IPoyntStayServiceListener callback)
          throws android.os.RemoteException

Processes the given stay through Poynt Cloud and also saves the processed stay in local Poynt Stay content providerName. This interface processes any payment transactions specified in the Stay object.

Parameters:

stay - co.poynt.api.Stay

requestId - RequestId for Idempotency enforcement

callback - IPoyntStayServiceListener

Throws:

android.os.RemoteException

cancelStay

void cancelStay(java.lang.String stayId,
                java.lang.String requestId,
                IPoyntStayServiceListener callback)
         throws android.os.RemoteException

Cancels the given stay through Poynt Cloud and also updates the stay in local Poynt Stay content providerName. This interface refunds or voids any transactions that are part of the original Stay.

Parameters:

stay - co.poynt.api.Stay

requestId - RequestId for Idempotency enforcement

callback - IPoyntStayServiceListener

Throws:

android.os.RemoteException

captureStay

void captureStay(java.lang.String stayId,
                 co.poynt.api.model.Stay stay,
                 java.lang.String requestId,
                 IPoyntStayServiceListener callback)
          throws android.os.RemoteException

Captures the payment transactions associated with the given stay through Poynt Cloud and also updates the stay in local Poynt Stay content providerName. When partial payment captures are required, an stay object with the partial capture information can be passed as an argument. When only stayId is provided, the payments are captured completely.

Parameters:

stayId - ID of the stay to capture

stay - co.poynt.api.Stay

requestId - RequestId for Idempotency enforcement

callback - IPoyntStayServiceListener

Throws:

android.os.RemoteException

completeStay

void completeStay(java.lang.String stayId,
                  co.poynt.api.model.Stay stay,
                  java.lang.String requestId,
                  IPoyntStayServiceListener callback)
           throws android.os.RemoteException

Captures the payment transactions associated with the given stay and marks the oder as Completed. Stay is processed through Poynt Cloud and also updated in the local Poynt Stay content providerName. When partial payment captures are required, an stay object with the partial capture information can be passed as an argument. When only stayId is provided, the payments are captured completely.

Parameters:

stayId - ID of the stay to capture

stay - co.poynt.api.Stay

requestId - RequestId for Idempotency enforcement

callback - IPoyntStayServiceListener

Throws:

android.os.RemoteException

getStay

void getStay(java.lang.String stayId,
             java.lang.String requestId,
             IPoyntStayServiceListener callback)
      throws android.os.RemoteException

Retrieves the given stay from the local Poynt Stay content providerName if available, otherwise fetches from the Poynt Cloud .

Parameters:

stayId - ID of the stay to retrieve

requestId - RequestId for tracking the request

callback - IPoyntStayServiceListener

Throws:

android.os.RemoteException

updateStay

void updateStay(java.lang.String stayId,
                co.poynt.api.model.Stay stay,
                java.lang.String requestId,
                IPoyntStayServiceListener callback)
         throws android.os.RemoteException

Updates the given stay in the Poynt Cloud and updates local Poynt Stay content providerName.

Parameters:

stayId - ID of the stay to update

stay - Stay

requestId - RequestId for Idempotency enforcement

callback - IPoyntStayServiceListener

Throws:

android.os.RemoteException

getStayFromCloud

void getStayFromCloud(java.lang.String stayId,
                      java.lang.String requestId,
                      IPoyntStayServiceListener callback)
               throws android.os.RemoteException

Retrieves the given stay from the Poynt Cloud.

Parameters:

stayId - ID of the stay to retrieve

requestId - RequestId for tracking the request

callback - IPoyntStayServiceListener

Throws:

android.os.RemoteException