java.lang.Object

com.avoka.tm.util.TxnUrlBuilder

public class TxnUrlBuilder extends Object

Provides a transaction form and PDF receipt URL builder class.

Examples

Open Form URL

A open form URL generation example.

 import com.avoka.tm.util.*

 String formUrl = new TxnUrlBuilder()
    .setTxn(txn)
    .setSpaceName("Work Space")
    .buildFormUrl()

PDF Receipt URL

A PDF receipt URL generation example.

 import com.avoka.tm.util.*

 String receiptUrl = new TxnUrlBuilder()
    .setTxn(txn)
    .setSpaceName("Work Space")
    .buildReceiptUrl()

Since:: 5.0.0

Constructor Summary

Constructors

Constructor

Description

TxnUrlBuilder()
Method Summary

Modifier and Type

Method

Description

String

buildFormUrl()

Return the open form URL.

String

buildReceiptUrl()

Return the open PDF receipt URL.

TxnUrlBuilder

setSecured(Boolean secured)

Set explicitly if the url should be secured (authorized or anonymous).

TxnUrlBuilder

setSpaceName(String spaceName)

Set the space name property.

TxnUrlBuilder

setTxn(Txn txn)

Set the transaction property.

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

Constructor Details
- TxnUrlBuilder
  
  public TxnUrlBuilder()
Method Details
- setTxn
  
  public TxnUrlBuilder setTxn(Txn txn)
  
  Set the transaction property.
  
  Parameters:
  
  txn - the transaction property
  
  Returns:
  
  the transaction URL builder
- setSpaceName
  
  public TxnUrlBuilder setSpaceName(String spaceName)
  
  Set the space name property.
  
  Parameters:
  
  spaceName - the space name property
  
  Returns:
  
  the transaction URL builder
- setSecured
  
  public TxnUrlBuilder setSecured(Boolean secured)
  
  Set explicitly if the url should be secured (authorized or anonymous).
  
  Parameters:
  
  secured - the secured
  
  Returns:
  
  the transaction URL builder
  
  Since:
  
  21.5.0
- buildFormUrl
  
  public String buildFormUrl()
  
  Return the open form URL.
  
  Returns:
  
  the open form URL
- buildReceiptUrl
  
  public String buildReceiptUrl()
  
  Return the open PDF receipt URL.
  
  Returns:
  
  the open PDF receipt URL