CheckoutResponse (Broadleaf Cart Operation Services 1.6.0-GA API)

java.lang.Object
- com.broadleafcommerce.cartoperation.web.endpoint.domain.CheckoutResponse

All Implemented Interfaces:

Serializable
```
public class CheckoutResponse
extends Object
implements Serializable
```
DTO for communicating the results of a checkout submission

Author:

Chris Kittrell (ckittrell)

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

CheckoutResponse()

Constructors
Constructor and Description
`CheckoutResponse()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.broadleafcommerce.cart.client.domain.Cart`	`getCart()` The `Cart` related to the checkout submission.
`String`	`getFailureMessage()` Message intended to inform why the checkout submission failed if `isSuccess()` is false.
`String`	`getFailureType()` The type of checkout failure which can be used programmatically by the client application to react to the failure.
`Map<String,String>`	`getItemFailureMessages()` Line item error messages used to describe issues with individual fields, cart items, etc.
`Map<String,String>`	`getPayment3DSVerificationUrls()` Payment 3DS Verification URLs used to determine payments which require 3DS verification during the checkout workflow.
`String`	`getRequestId()` The id representing the customer's request to checkout
`boolean`	`isSuccess()` Whether or not the checkout submission was successful.
`void`	`setCart(com.broadleafcommerce.cart.client.domain.Cart cart)` The `Cart` related to the checkout submission.
`void`	`setFailureMessage(String failureMessage)` Message intended to inform why the checkout submission failed if `isSuccess()` is false.
`void`	`setFailureType(String failureType)` The type of checkout failure which can be used programmatically by the client application to react to the failure.
`void`	`setItemFailureMessages(Map<String,String> itemFailureMessages)` Line item error messages used to describe issues with individual fields, cart items, etc.
`void`	`setPayment3DSVerificationUrls(Map<String,String> payment3DSVerificationUrls)` Payment 3DS Verification URLs used to determine payments which require 3DS verification during the checkout workflow.
`void`	`setRequestId(String requestId)` The id representing the customer's request to checkout
`void`	`setSuccess(boolean success)` Whether or not the checkout submission was successful.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CheckoutResponse
```
public CheckoutResponse()
```
- Method Detail
  - getCart
```
public com.broadleafcommerce.cart.client.domain.Cart getCart()
```
    The Cart related to the checkout submission.
    
    Returns:
    
    The Cart related to the checkout submission.
  - isSuccess
```
public boolean isSuccess()
```
    Whether or not the checkout submission was successful.
    
    Returns:
    
    Whether or not the checkout submission was successful.
  - getFailureType
```
public String getFailureType()
```
    The type of checkout failure which can be used programmatically by the client application to react to the failure. Note: This should only be populated if isSuccess() is false.
    
    Returns:
    
    The type of checkout failure
    
    See Also:
    
    CheckoutFailureType
  - getFailureMessage
```
public String getFailureMessage()
```
    Message intended to inform why the checkout submission failed if isSuccess() is false.
    
    Returns:
    
    Message intended to inform why the checkout submission failed if isSuccess() is false.
  - getItemFailureMessages
```
public Map<String,String> getItemFailureMessages()
```
    Line item error messages used to describe issues with individual fields, cart items, etc. For example, this may consist of map entries where the key is a cart item id (or name) & the value is an explanation of why the item is misconfigured.
    
    Returns:
    
    Line item error messages used to describe issues with individual fields, cart items, etc.
  - getPayment3DSVerificationUrls
```
public Map<String,String> getPayment3DSVerificationUrls()
```
    Payment 3DS Verification URLs used to determine payments which require 3DS verification during the checkout workflow. For example, this would consist of map entries where the key is the payment id & the value is the redirect URL for 3DS verification of the payment.
    
    Returns:
    
    Payment 3DS Verification URLs used to determine payments which require 3DS verification
  - getRequestId
```
public String getRequestId()
```
    The id representing the customer's request to checkout
    
    Returns:
    
    The id representing the customer's request to checkout
  - setCart
```
public void setCart(com.broadleafcommerce.cart.client.domain.Cart cart)
```
    The Cart related to the checkout submission.
    
    Parameters:
    
    cart - The Cart related to the checkout submission.
  - setSuccess
```
public void setSuccess(boolean success)
```
    Whether or not the checkout submission was successful.
    
    Parameters:
    
    success - Whether or not the checkout submission was successful.
  - setFailureType
```
public void setFailureType(String failureType)
```
    The type of checkout failure which can be used programmatically by the client application to react to the failure. Note: This should only be populated if isSuccess() is false.
    
    Parameters:
    
    failureType - The type of checkout failure
    
    See Also:
    
    CheckoutFailureType
  - setFailureMessage
```
public void setFailureMessage(String failureMessage)
```
    Message intended to inform why the checkout submission failed if isSuccess() is false.
    
    Parameters:
    
    failureMessage - Message intended to inform why the checkout submission failed if isSuccess() is false.
  - setItemFailureMessages
```
public void setItemFailureMessages(Map<String,String> itemFailureMessages)
```
    Line item error messages used to describe issues with individual fields, cart items, etc. For example, this may consist of map entries where the key is a cart item id (or name) & the value is an explanation of why the item is misconfigured.
    
    Parameters:
    
    itemFailureMessages - Line item error messages used to describe issues with individual fields, cart items, etc.
  - setPayment3DSVerificationUrls
```
public void setPayment3DSVerificationUrls(Map<String,String> payment3DSVerificationUrls)
```
    Payment 3DS Verification URLs used to determine payments which require 3DS verification during the checkout workflow. For example, this would consist of map entries where the key is the payment id & the value is the redirect URL for 3DS verification of the payment.
    
    Parameters:
    
    payment3DSVerificationUrls - Payment 3DS Verification URLs used to determine payments which require 3DS verification during the checkout workflow
  - setRequestId
```
public void setRequestId(String requestId)
```
    The id representing the customer's request to checkout
    
    Parameters:
    
    requestId - The id representing the customer's request to checkout

Class CheckoutResponse

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CheckoutResponse

Method Detail

getCart

isSuccess

getFailureType

getFailureMessage

getItemFailureMessages

getPayment3DSVerificationUrls

getRequestId

setCart

setSuccess

setFailureType

setFailureMessage

setItemFailureMessages

setPayment3DSVerificationUrls

setRequestId