com.commercetools.payment.actions

Class HandlingTask

java.lang.Object

com.commercetools.payment.actions.HandlingTask

public class HandlingTask
extends java.lang.Object

Describes the next action the shop has to do after the call has finished. Created by mgatz on 7/20/16.

Method Summary

Modifier and Type	Method and Description
HandlingTask	addData(java.lang.String key, java.lang.Object value) Add data to this handling tasks additionalData field.
ShopAction	getAction() Provides the action type of the task.
java.util.Map<java.lang.String,java.lang.Object>	getAdditionalData() Provides a key value store that provides more information possibly needed for the task.
java.util.Optional<java.lang.String>	getRedirectUrl() Provides a redirect URL of the task requires one.
static HandlingTask	of(ShopAction action) Create a new HandlingTask instance representing the passed action.
HandlingTask	redirectUrl(java.lang.String redirectUrl) Add a redirect URL to this instance

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

of

public static HandlingTask of(ShopAction action)

Create a new HandlingTask instance representing the passed action.

Parameters:

action - the ShopAction to be done

Returns:

new instance of HandlingTask

redirectUrl

public HandlingTask redirectUrl(java.lang.String redirectUrl)

Add a redirect URL to this instance

Parameters:

redirectUrl - the URL

Returns:

enriched self

addData

public HandlingTask addData(java.lang.String key,
                            java.lang.Object value)

Add data to this handling tasks additionalData field.

Parameters:

key - the identifier of the data object

value - the object to be stored

Returns:

enriched self

getAction

public ShopAction getAction()

Provides the action type of the task.

Returns:

action type

getRedirectUrl

public java.util.Optional<java.lang.String> getRedirectUrl()

Provides a redirect URL of the task requires one.

Returns:

the redirect URL

getAdditionalData

public java.util.Map<java.lang.String,java.lang.Object> getAdditionalData()

Provides a key value store that provides more information possibly needed for the task.

Returns:

value is guaranteed but map could be empty