com.gemalto.idp.mobile.otp.dsformatting

Interface DsTransactionData

public interface DsTransactionData

An interface representing the transaction data for DS, in other words the list of primitives with associated values.

Since:

4.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	DsTransactionData.PrimitiveValue Holder class for a primitive with an associate value.

Method Summary

Modifier and Type	Method and Description
DsTransactionData	add(DsTransactionData.PrimitiveValue primitiveValue) Put the given primitive value holder to the end of the transaction data.
DsTransactionData	add(InputPrimitive primitive, SecureString data) Put the given primitive and associated data at the end of the transaction data.
DsTransactionData	add(MessageDialogPrimitive primitive) Put the given primitive at the end of the transaction data.
DsTransactionData	add(TextPrimitive primitive, SecureString data) Put the given primitive and associated data at the end of the transaction data.
java.util.List<DsTransactionData.PrimitiveValue>	getEntries() Get the list of primitive values added in the transaction data.
Template	getTemplate() Get the template that is associated with this transaction data.

Method Detail

getTemplate

Template getTemplate()

Get the template that is associated with this transaction data.

Returns:

the template that this transaction data is associated with

add

DsTransactionData add(DsTransactionData.PrimitiveValue primitiveValue)

Put the given primitive value holder to the end of the transaction data.

Parameters:

primitiveValue - the primitive value holder

Returns:

this transaction data (for method chaining)

add

DsTransactionData add(InputPrimitive primitive,
                      SecureString data)

Put the given primitive and associated data at the end of the transaction data.

Parameters:

primitive - the input primitive

data - the data to put

Returns:

this transaction data (for method chaining)

add

DsTransactionData add(TextPrimitive primitive,
                      SecureString data)

Put the given primitive and associated data at the end of the transaction data.

Parameters:

primitive - the text primitive

data - the data to put

Returns:

this transaction data (for method chaining)

Since:

4.0

add

DsTransactionData add(MessageDialogPrimitive primitive)

Put the given primitive at the end of the transaction data.

This method should only be used for primitives which don't accept input data, otherwise use one of the add methods.

Parameters:

primitive - the message dialog primitive

Returns:

this transaction data (for method chaining)

Throws:

java.lang.IllegalArgumentException - When primitive is an instance of InputPrimitive

getEntries

java.util.List<DsTransactionData.PrimitiveValue> getEntries()

Get the list of primitive values added in the transaction data.

Returns:

the list of added primitive value (List< PrimitiveValue>) in this transaction data, if none the empty list