TermsAndConditionsLogEntry (com.blockchyp:blockchyp-java 1.24.13 API)

java.lang.Object
- com.blockchyp.client.dto.TermsAndConditionsLogEntry

All Implemented Interfaces:: IAbstractAcknowledgement

public class TermsAndConditionsLogEntry
extends Object
implements IAbstractAcknowledgement

Models a Terms and Conditions log entry.

Constructor Summary

Constructors
Constructor and Description

TermsAndConditionsLogEntry()

Constructors
Constructor and Description
`TermsAndConditionsLogEntry()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAlias()` Gets alias of the terms and conditions template used for this entry, if any.
`String`	`getContent()` Gets full text of the document agreed to at the time of signature capture.
`String`	`getContentLeader()` Gets first 32 characters of the full text.
`String`	`getError()` Gets the error, if an error occurred.
`String`	`getId()` Gets internal id for a Terms and Conditions entry.
`String`	`getName()` Gets title of the document displayed on the terminal at the time of capture.
`String`	`getResponseDescription()` Gets a narrative description of the transaction result.
`SignatureFormat`	`getSigFormat()` Gets the image format to be used for returning signatures.
`String`	`getSignature()` Gets the base 64 encoded signature image if the format requested.
`String`	`getTerminalId()` Gets id of the terminal that captured this terms and conditions entry.
`String`	`getTerminalName()` Gets name of the terminal that captured this terms and conditions entry.
`String`	`getTimestamp()` Gets date and time the terms and conditions acceptance occurred.
`String`	`getTransactionId()` Gets optional transaction id if only log entries related to a transaction should be returned.
`String`	`getTransactionRef()` Gets optional transaction ref if the terms and conditions was associated with a transaction.
`boolean`	`isHasSignature()` Gets a flag that indicates whether or not a signature has been captured.
`boolean`	`isSuccess()` Gets whether or not the request succeeded.
`boolean`	`isTest()` Gets a flag indicating whether or not the terminal was a test terminal.
`void`	`setAlias(String value)` Sets alias of the terms and conditions template used for this entry, if any.
`void`	`setContent(String value)` Sets full text of the document agreed to at the time of signature capture.
`void`	`setContentLeader(String value)` Sets first 32 characters of the full text.
`void`	`setError(String value)` Sets the error, if an error occurred.
`void`	`setHasSignature(boolean value)` Sets a flag that indicates whether or not a signature has been captured.
`void`	`setId(String value)` Sets internal id for a Terms and Conditions entry.
`void`	`setName(String value)` Sets title of the document displayed on the terminal at the time of capture.
`void`	`setResponseDescription(String value)` Sets a narrative description of the transaction result.
`void`	`setSigFormat(SignatureFormat value)` Sets the image format to be used for returning signatures.
`void`	`setSignature(String value)` Sets the base 64 encoded signature image if the format requested.
`void`	`setSuccess(boolean value)` Sets whether or not the request succeeded.
`void`	`setTerminalId(String value)` Sets id of the terminal that captured this terms and conditions entry.
`void`	`setTerminalName(String value)` Sets name of the terminal that captured this terms and conditions entry.
`void`	`setTest(boolean value)` Sets a flag indicating whether or not the terminal was a test terminal.
`void`	`setTimestamp(String value)` Sets date and time the terms and conditions acceptance occurred.
`void`	`setTransactionId(String value)` Sets optional transaction id if only log entries related to a transaction should be returned.
`void`	`setTransactionRef(String value)` Sets optional transaction ref if the terms and conditions was associated with a transaction.

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

- Constructor Detail
  - TermsAndConditionsLogEntry
```
public TermsAndConditionsLogEntry()
```
- Method Detail
  - setSuccess
```
public void setSuccess(boolean value)
```
    Sets whether or not the request succeeded.
    
    Parameters:
    
    value - whether or not the request succeeded.
  - isSuccess
```
public boolean isSuccess()
```
    Gets whether or not the request succeeded.
    
    Specified by:
    
    isSuccess in interface IAbstractAcknowledgement
    
    Returns:
    
    whether or not the request succeeded.
  - setError
```
public void setError(String value)
```
    Sets the error, if an error occurred.
    
    Parameters:
    
    value - the error, if an error occurred.
  - getError
```
public String getError()
```
    Gets the error, if an error occurred.
    
    Specified by:
    
    getError in interface IAbstractAcknowledgement
    
    Returns:
    
    the error, if an error occurred.
  - setResponseDescription
```
public void setResponseDescription(String value)
```
    Sets a narrative description of the transaction result.
    
    Parameters:
    
    value - a narrative description of the transaction result.
  - getResponseDescription
```
public String getResponseDescription()
```
    Gets a narrative description of the transaction result.
    
    Specified by:
    
    getResponseDescription in interface IAbstractAcknowledgement
    
    Returns:
    
    a narrative description of the transaction result.
  - setId
```
public void setId(String value)
```
    Sets internal id for a Terms and Conditions entry.
    
    Parameters:
    
    value - internal id for a Terms and Conditions entry.
  - getId
```
public String getId()
```
    Gets internal id for a Terms and Conditions entry.
    
    Returns:
    
    internal id for a Terms and Conditions entry.
  - setTerminalId
```
public void setTerminalId(String value)
```
    Sets id of the terminal that captured this terms and conditions entry.
    
    Parameters:
    
    value - id of the terminal that captured this terms and conditions entry.
  - getTerminalId
```
public String getTerminalId()
```
    Gets id of the terminal that captured this terms and conditions entry.
    
    Returns:
    
    id of the terminal that captured this terms and conditions entry.
  - setTerminalName
```
public void setTerminalName(String value)
```
    Sets name of the terminal that captured this terms and conditions entry.
    
    Parameters:
    
    value - name of the terminal that captured this terms and conditions entry.
  - getTerminalName
```
public String getTerminalName()
```
    Gets name of the terminal that captured this terms and conditions entry.
    
    Returns:
    
    name of the terminal that captured this terms and conditions entry.
  - setTest
```
public void setTest(boolean value)
```
    Sets a flag indicating whether or not the terminal was a test terminal.
    
    Parameters:
    
    value - a flag indicating whether or not the terminal was a test terminal.
  - isTest
```
public boolean isTest()
```
    Gets a flag indicating whether or not the terminal was a test terminal.
    
    Returns:
    
    a flag indicating whether or not the terminal was a test terminal.
  - setTimestamp
```
public void setTimestamp(String value)
```
    Sets date and time the terms and conditions acceptance occurred.
    
    Parameters:
    
    value - date and time the terms and conditions acceptance occurred.
  - getTimestamp
```
public String getTimestamp()
```
    Gets date and time the terms and conditions acceptance occurred.
    
    Returns:
    
    date and time the terms and conditions acceptance occurred.
  - setTransactionRef
```
public void setTransactionRef(String value)
```
    Sets optional transaction ref if the terms and conditions was associated with a transaction.
    
    Parameters:
    
    value - optional transaction ref if the terms and conditions was associated with a transaction.
  - getTransactionRef
```
public String getTransactionRef()
```
    Gets optional transaction ref if the terms and conditions was associated with a transaction.
    
    Returns:
    
    optional transaction ref if the terms and conditions was associated with a transaction.
  - setTransactionId
```
public void setTransactionId(String value)
```
    Sets optional transaction id if only log entries related to a transaction should be returned.
    
    Parameters:
    
    value - optional transaction id if only log entries related to a transaction should be returned.
  - getTransactionId
```
public String getTransactionId()
```
    Gets optional transaction id if only log entries related to a transaction should be returned.
    
    Returns:
    
    optional transaction id if only log entries related to a transaction should be returned.
  - setAlias
```
public void setAlias(String value)
```
    Sets alias of the terms and conditions template used for this entry, if any.
    
    Parameters:
    
    value - alias of the terms and conditions template used for this entry, if any.
  - getAlias
```
public String getAlias()
```
    Gets alias of the terms and conditions template used for this entry, if any.
    
    Returns:
    
    alias of the terms and conditions template used for this entry, if any.
  - setName
```
public void setName(String value)
```
    Sets title of the document displayed on the terminal at the time of capture.
    
    Parameters:
    
    value - title of the document displayed on the terminal at the time of capture.
  - getName
```
public String getName()
```
    Gets title of the document displayed on the terminal at the time of capture.
    
    Returns:
    
    title of the document displayed on the terminal at the time of capture.
  - setContent
```
public void setContent(String value)
```
    Sets full text of the document agreed to at the time of signature capture.
    
    Parameters:
    
    value - full text of the document agreed to at the time of signature capture.
  - getContent
```
public String getContent()
```
    Gets full text of the document agreed to at the time of signature capture.
    
    Returns:
    
    full text of the document agreed to at the time of signature capture.
  - setContentLeader
```
public void setContentLeader(String value)
```
    Sets first 32 characters of the full text.
    
    Parameters:
    
    value - first 32 characters of the full text. Used to support user interfaces that show summaries.
  - getContentLeader
```
public String getContentLeader()
```
    Gets first 32 characters of the full text.
    
    Returns:
    
    first 32 characters of the full text. Used to support user interfaces that show summaries.
  - setHasSignature
```
public void setHasSignature(boolean value)
```
    Sets a flag that indicates whether or not a signature has been captured.
    
    Parameters:
    
    value - a flag that indicates whether or not a signature has been captured.
  - isHasSignature
```
public boolean isHasSignature()
```
    Gets a flag that indicates whether or not a signature has been captured.
    
    Returns:
    
    a flag that indicates whether or not a signature has been captured.
  - setSigFormat
```
public void setSigFormat(SignatureFormat value)
```
    Sets the image format to be used for returning signatures.
    
    Parameters:
    
    value - the image format to be used for returning signatures.
  - getSigFormat
```
public SignatureFormat getSigFormat()
```
    Gets the image format to be used for returning signatures.
    
    Returns:
    
    the image format to be used for returning signatures.
  - setSignature
```
public void setSignature(String value)
```
    Sets the base 64 encoded signature image if the format requested.
    
    Parameters:
    
    value - the base 64 encoded signature image if the format requested.
  - getSignature
```
public String getSignature()
```
    Gets the base 64 encoded signature image if the format requested.
    
    Returns:
    
    the base 64 encoded signature image if the format requested.

Class TermsAndConditionsLogEntry

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TermsAndConditionsLogEntry

Method Detail

setSuccess

isSuccess

setError

getError

setResponseDescription

getResponseDescription

setId

getId

setTerminalId

getTerminalId

setTerminalName

getTerminalName

setTest

isTest

setTimestamp

getTimestamp

setTransactionRef

getTransactionRef

setTransactionId

getTransactionId

setAlias

getAlias

setName

getName

setContent

getContent

setContentLeader

getContentLeader

setHasSignature

isHasSignature

setSigFormat

getSigFormat

setSignature

getSignature