host.anzo.eossdk.eos.sdk.ecom

Class EOS_Ecom_Transaction

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.ecom.EOS_Ecom_Transaction

All Implemented Interfaces:

com.sun.jna.NativeMapped, java.lang.AutoCloseable

Direct Known Subclasses:

EOS_Ecom_Transaction.ByReference, EOS_Ecom_Transaction.ByValue

public class EOS_Ecom_Transaction
extends com.sun.jna.PointerType
implements java.lang.AutoCloseable

This handle is copied when EOS_Ecom_CopyTransactionById or EOS_Ecom_CopyTransactionByIndex is called. A EOS_Ecom_CheckoutCallbackInfo provides the ID for the copy. After being copied, EOS_Ecom_Transaction_Release must be called.

Since:

8/20/2023

See Also:

EOS_Ecom_CheckoutCallbackInfo, EOS_Ecom_Interface.copyTransactionById(EOS_Ecom_CopyTransactionByIdOptions), EOS_Ecom_Interface.copyTransactionByIndex(EOS_Ecom_CopyTransactionByIndexOptions), release()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EOS_Ecom_Transaction.ByReference
static class	EOS_Ecom_Transaction.ByValue

Constructor Summary

Constructors

Constructor and Description
EOS_Ecom_Transaction()
EOS_Ecom_Transaction(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
void	close()
EOS_Ecom_Entitlement	copyEntitlementByIndex(EOS_Ecom_Transaction_CopyEntitlementByIndexOptions options) Fetches an entitlement from a given index.
int	getEntitlementsCount(EOS_Ecom_Transaction_GetEntitlementsCountOptions options) Fetch the number of entitlements that are part of this transaction.
EOS_EResult	getTransactionId(java.nio.ByteBuffer outBuffer, java.nio.IntBuffer inOutBufferLength) The Ecom Transaction Interface exposes getters for accessing information about a completed transaction.
void	release() Release the memory associated with an EOS_Ecom_HTransaction.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_Ecom_Transaction

public EOS_Ecom_Transaction(com.sun.jna.Pointer address)

EOS_Ecom_Transaction

public EOS_Ecom_Transaction()

Method Detail

getTransactionId

public EOS_EResult getTransactionId(java.nio.ByteBuffer outBuffer,
                                    java.nio.IntBuffer inOutBufferLength)

The Ecom Transaction Interface exposes getters for accessing information about a completed transaction. All Ecom Transaction Interface calls take a handle of type EOS_Ecom_HTransaction as the first parameter. An EOS_Ecom_HTransaction handle is originally returned as part of the EOS_Ecom_CheckoutCallbackInfo struct. An EOS_Ecom_HTransaction handle can also be retrieved from an EOSEcom handle using EOS_Ecom_CopyTransactionByIndex. It is expected that after a transaction that EOS_Ecom_Transaction_Release is called. When EOS_Platform_Release is called any remaining transactions will also be released.

Parameters:

outBuffer - A buffer to receive the transaction ID string

inOutBufferLength - On input, the size of the out buffer.

See Also:

EOS_Ecom_CheckoutCallbackInfo, EOS_Ecom_Interface.getTransactionCount(EOS_Ecom_GetTransactionCountOptions), EOS_Ecom_Interface.copyTransactionByIndex(EOS_Ecom_CopyTransactionByIndexOptions)

getEntitlementsCount

public int getEntitlementsCount(EOS_Ecom_Transaction_GetEntitlementsCountOptions options)

Fetch the number of entitlements that are part of this transaction.

Parameters:

options - structure containing the Epic Account ID being accessed

Returns:

the number of entitlements found.

See Also:

copyEntitlementByIndex(EOS_Ecom_Transaction_CopyEntitlementByIndexOptions)

copyEntitlementByIndex

public EOS_Ecom_Entitlement copyEntitlementByIndex(EOS_Ecom_Transaction_CopyEntitlementByIndexOptions options)
                                            throws EOSException

Fetches an entitlement from a given index.

Parameters:

options - structure containing the index being accessed

Returns:

the entitlement for the given index, if it exists and is valid, use EOS_Ecom_Entitlement_Release when finished

Throws:

EOSEcomEntitlementStaleException - if the entitlement information is stale and passed out in OutEntitlement

EOSInvalidParametersException - if you pass a null pointer for the out parameter

EOSNotFoundException - if the entitlement is not found

EOSException

See Also:

EOS_Ecom_Entitlement.release()

release

public void release()

Release the memory associated with an EOS_Ecom_HTransaction. Is expected to be called after being received from a EOS_Ecom_CheckoutCallbackInfo.

See Also:

EOS_Ecom_CheckoutCallbackInfo, EOS_Ecom_Interface.getTransactionCount(EOS_Ecom_GetTransactionCountOptions), EOS_Ecom_Interface.copyTransactionByIndex(EOS_Ecom_CopyTransactionByIndexOptions)

close

public void close()
           throws java.lang.Exception

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.lang.Exception