com.simplify.payments.domain

Class TransactionReview

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<K,V>

java.util.LinkedHashMap<java.lang.String,java.lang.Object>

com.simplify.payments.PaymentsMap

com.simplify.payments.PaymentsObject

com.simplify.payments.domain.TransactionReview

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public class TransactionReview
extends PaymentsObject

A TransactionReview object.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Field Summary

Fields inherited from class com.simplify.payments.PaymentsObject

authentication

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TransactionReview()
protected	TransactionReview(java.util.Map m)
protected	TransactionReview(PaymentsObject o)

Method Summary

Modifier and Type	Method and Description
static TransactionReview	create(Authentication auth, java.util.Map map) Creates an TransactionReview object
static TransactionReview	create(java.util.Map map) Creates an TransactionReview object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static TransactionReview	create(java.lang.String publicKey, java.lang.String privateKey, java.util.Map map) Deprecated. As of release 1.1, replaced by create(Authentication, Map)
TransactionReview	delete() Deletes an TransactionReview object.
static TransactionReview	find(Authentication auth, java.lang.String id) Retrieve a TransactionReview object.
static TransactionReview	find(java.lang.String id) Retrieve a TransactionReview object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static TransactionReview	find(java.lang.String publicKey, java.lang.String privateKey, java.lang.String id) Deprecated. As of release 1.1, replaced by find(Authentication, String)
protected java.lang.String	getObjectType()
static ResourceList<TransactionReview>	list() Retrieve TransactionReview objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<TransactionReview>	list(Authentication auth) Retrieve TransactionReview objects using the default criteria (max 20, offset 0, default sorting and no filtering).
static ResourceList<TransactionReview>	list(Authentication auth, java.util.Map criteria) Retrieve TransactionReview objects using the specified criteria.
static ResourceList<TransactionReview>	list(java.util.Map criteria) Retrieve TransactionReview objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.
static ResourceList<TransactionReview>	list(java.lang.String publicKey, java.lang.String privateKey) Deprecated. As of release 1.1, replaced by list(Authentication)
static ResourceList<TransactionReview>	list(java.lang.String publicKey, java.lang.String privateKey, java.util.Map criteria) Deprecated. As of release 1.1, replaced by list(Authentication, Map)
TransactionReview	update() Updates an TransactionReview object.

Methods inherited from class com.simplify.payments.PaymentsObject

createObject, deleteObject, findObject, getAuthentication, listObjects, listObjects, updateObject

Methods inherited from class com.simplify.payments.PaymentsMap

containsKey, get, normalize, put, remove, set

Methods inherited from class java.util.LinkedHashMap

clear, containsValue, entrySet, forEach, getOrDefault, keySet, removeEldestEntry, replaceAll, values

Methods inherited from class java.util.HashMap

clone, compute, computeIfAbsent, computeIfPresent, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, hashCode, isEmpty, merge, putAll, putIfAbsent, remove, replace, replace, size

Constructor Detail

TransactionReview

protected TransactionReview()

TransactionReview

protected TransactionReview(PaymentsObject o)

TransactionReview

protected TransactionReview(java.util.Map m)

Method Detail

getObjectType

protected java.lang.String getObjectType()

Specified by:

getObjectType in class PaymentsObject

create

public static TransactionReview create(java.util.Map map)
                                throws ApiCommunicationException,
                                       AuthenticationException,
                                       InvalidRequestException,
                                       NotAllowedException,
                                       SystemException

Creates an TransactionReview object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

map - a map of parameters, valid keys and types:

Returns:

a TransactionReview object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

@Deprecated
public static TransactionReview create(java.lang.String publicKey,
                                                   java.lang.String privateKey,
                                                   java.util.Map map)
                                            throws ApiCommunicationException,
                                                   AuthenticationException,
                                                   InvalidRequestException,
                                                   NotAllowedException,
                                                   SystemException

Deprecated. As of release 1.1, replaced by create(Authentication, Map)

Creates an TransactionReview object

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

Returns:

a TransactionReview object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

create

public static TransactionReview create(Authentication auth,
                                       java.util.Map map)
                                throws ApiCommunicationException,
                                       AuthenticationException,
                                       InvalidRequestException,
                                       NotAllowedException,
                                       SystemException

Creates an TransactionReview object

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

map - a map of parameters, valid keys and types:

Returns:

a TransactionReview object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

delete

public TransactionReview delete()
                         throws ApiCommunicationException,
                                AuthenticationException,
                                InvalidRequestException,
                                ObjectNotFoundException,
                                NotAllowedException,
                                SystemException

Deletes an TransactionReview object.

Returns:

a TransactionReview object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

list

public static ResourceList<TransactionReview> list()
                                            throws ApiCommunicationException,
                                                   AuthenticationException,
                                                   InvalidRequestException,
                                                   NotAllowedException,
                                                   SystemException

Retrieve TransactionReview objects using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively and the default criteria (max 20, offset 0, default sorting and no filtering).

Returns:

a ResourceList object which holds the list of TransactionReview objects and the total number of TransactionReview objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

@Deprecated
public static ResourceList<TransactionReview> list(java.lang.String publicKey,
                                                               java.lang.String privateKey)
                                                        throws ApiCommunicationException,
                                                               AuthenticationException,
                                                               InvalidRequestException,
                                                               NotAllowedException,
                                                               SystemException

Deprecated. As of release 1.1, replaced by list(Authentication)

Retrieve TransactionReview objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of TransactionReview objects and the total number of TransactionReview objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<TransactionReview> list(Authentication auth)
                                            throws ApiCommunicationException,
                                                   AuthenticationException,
                                                   InvalidRequestException,
                                                   NotAllowedException,
                                                   SystemException

Retrieve TransactionReview objects using the default criteria (max 20, offset 0, default sorting and no filtering).

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

Returns:

a ResourceList object which holds the list of TransactionReview objects and the total number of TransactionReview objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<TransactionReview> list(java.util.Map criteria)
                                            throws ApiCommunicationException,
                                                   AuthenticationException,
                                                   InvalidRequestException,
                                                   NotAllowedException,
                                                   SystemException

Retrieve TransactionReview objects using the specified criteria and using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

criteria - a map of parameters; valid keys and types are:

Returns:

a ResourceList object which holds the list of TransactionReview objects and the total number of TransactionReview objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<TransactionReview> list(java.lang.String publicKey,
                                                   java.lang.String privateKey,
                                                   java.util.Map criteria)
                                            throws ApiCommunicationException,
                                                   AuthenticationException,
                                                   InvalidRequestException,
                                                   NotAllowedException,
                                                   SystemException

Deprecated. As of release 1.1, replaced by list(Authentication, Map)

Retrieve TransactionReview objects using the specified criteria.

Parameters:

criteria - a map of parameters; valid keys and types are:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

Returns:

a ResourceList object which holds the list of TransactionReview objects and the total number of TransactionReview objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

list

public static ResourceList<TransactionReview> list(Authentication auth,
                                                   java.util.Map criteria)
                                            throws ApiCommunicationException,
                                                   AuthenticationException,
                                                   InvalidRequestException,
                                                   NotAllowedException,
                                                   SystemException

Retrieve TransactionReview objects using the specified criteria.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

criteria - a map of parameters; valid keys and types are:

Returns:

a ResourceList object which holds the list of TransactionReview objects and the total number of TransactionReview objects available.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

NotAllowedException

SystemException

See Also:

ResourceList

find

public static TransactionReview find(java.lang.String id)
                              throws ApiCommunicationException,
                                     AuthenticationException,
                                     InvalidRequestException,
                                     ObjectNotFoundException,
                                     NotAllowedException,
                                     SystemException

Retrieve a TransactionReview object using the static properties PaymentsApi.PUBLIC_KEY and PaymentsApi.PRIVATE_KEY as the default public and private API keys respectively.

Parameters:

id - the id of the TransactionReview object to retrieve

Returns:

a TransactionReview object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

@Deprecated
public static TransactionReview find(java.lang.String publicKey,
                                                 java.lang.String privateKey,
                                                 java.lang.String id)
                                          throws ApiCommunicationException,
                                                 AuthenticationException,
                                                 InvalidRequestException,
                                                 ObjectNotFoundException,
                                                 NotAllowedException,
                                                 SystemException

Deprecated. As of release 1.1, replaced by find(Authentication, String)

Retrieve a TransactionReview object.

Parameters:

publicKey - Public API key. If null, the value of static PaymentsApi.PUBLIC_KEY will be used

privateKey - Private API key. If null, the value of static PaymentsApi.PRIVATE_KEY will be used

id - the id of the TransactionReview object to retrieve

Returns:

a TransactionReview object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

find

public static TransactionReview find(Authentication auth,
                                     java.lang.String id)
                              throws ApiCommunicationException,
                                     AuthenticationException,
                                     InvalidRequestException,
                                     ObjectNotFoundException,
                                     NotAllowedException,
                                     SystemException

Retrieve a TransactionReview object.

Parameters:

auth - Authentication object representing overrides for PaymentsApi.PRIVATE_KEY and PaymentsApi.PUBLIC_KEY and/or passing an access token in for operations using OAuth.

id - the id of the TransactionReview object to retrieve

Returns:

a TransactionReview object

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException

update

public TransactionReview update()
                         throws ApiCommunicationException,
                                AuthenticationException,
                                InvalidRequestException,
                                ObjectNotFoundException,
                                NotAllowedException,
                                SystemException

Updates an TransactionReview object. The properties that can be updated:

Returns:

a TransactionReview object.

Throws:

ApiCommunicationException

AuthenticationException

InvalidRequestException

ObjectNotFoundException

NotAllowedException

SystemException