java.lang.Object
- com.adyen.model.legalentitymanagement.DocumentReference

public class DocumentReference
extends Object

DocumentReference

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`JSON_PROPERTY_ACTIVE`
`static String`	`JSON_PROPERTY_DESCRIPTION`
`static String`	`JSON_PROPERTY_FILE_NAME`
`static String`	`JSON_PROPERTY_ID`
`static String`	`JSON_PROPERTY_MODIFICATION_DATE`
`static String`	`JSON_PROPERTY_PAGES`
`static String`	`JSON_PROPERTY_TYPE`

Constructor Summary

Constructors
Constructor Description

DocumentReference()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DocumentReference`	`active(Boolean active)`	Identifies whether the document is active and used for checks.
`DocumentReference`	`addPagesItem(DocumentPage pagesItem)`
`DocumentReference`	`description(String description)`	Your description for the document.
`boolean`	`equals(Object o)`	Return true if this DocumentReference object is equal to o.
`DocumentReference`	`fileName(String fileName)`	Document name.
`static DocumentReference`	`fromJson(String jsonString)`	Create an instance of DocumentReference given an JSON string
`Boolean`	`getActive()`	Identifies whether the document is active and used for checks.
`String`	`getDescription()`	Your description for the document.
`Map<String,Object>`	`getExplicitNulls()`	Returns a map of properties to be merged into the JSON payload as explicit null values.
`String`	`getFileName()`	Document name.
`String`	`getId()`	The unique identifier of the resource.
`OffsetDateTime`	`getModificationDate()`	The modification date of the document.
`List<DocumentPage>`	`getPages()`	List of document pages
`String`	`getType()`	Type of document, used when providing an ID number or uploading a document.
`int`	`hashCode()`
`DocumentReference`	`id(String id)`	The unique identifier of the resource.
`DocumentReference`	`includeNullValues(boolean includeNullValues)`	Configures whether null values are explicitly serialized in the JSON payload.
`boolean`	`isIncludeNullValues()`	Returns whether null values are explicitly serialized in the JSON payload.
`DocumentReference`	`modificationDate(OffsetDateTime modificationDate)`	The modification date of the document.
`DocumentReference`	`pages(List<DocumentPage> pages)`	List of document pages
`void`	`setActive(Boolean active)`	Identifies whether the document is active and used for checks.
`void`	`setDescription(String description)`	Your description for the document.
`void`	`setFileName(String fileName)`	Document name.
`void`	`setId(String id)`	The unique identifier of the resource.
`void`	`setIncludeNullValues(boolean includeNullValues)`	Sets whether null values should be explicitly serialized in the JSON payload.
`void`	`setModificationDate(OffsetDateTime modificationDate)`	The modification date of the document.
`void`	`setPages(List<DocumentPage> pages)`	List of document pages
`void`	`setType(String type)`	Type of document, used when providing an ID number or uploading a document.
`String`	`toJson()`	Convert an instance of DocumentReference to an JSON string
`String`	`toString()`
`DocumentReference`	`type(String type)`	Type of document, used when providing an ID number or uploading a document.

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

- Field Detail
  - JSON_PROPERTY_ACTIVE
```
public static final String JSON_PROPERTY_ACTIVE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_DESCRIPTION
```
public static final String JSON_PROPERTY_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_FILE_NAME
```
public static final String JSON_PROPERTY_FILE_NAME
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_ID
```
public static final String JSON_PROPERTY_ID
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_MODIFICATION_DATE
```
public static final String JSON_PROPERTY_MODIFICATION_DATE
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_PAGES
```
public static final String JSON_PROPERTY_PAGES
```
    See Also:
    
    Constant Field Values
  - JSON_PROPERTY_TYPE
```
public static final String JSON_PROPERTY_TYPE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DocumentReference
```
public DocumentReference()
```
- Method Detail
  - active
```
public DocumentReference active(Boolean active)
```
    Identifies whether the document is active and used for checks.
    
    Parameters:
    
    active - Identifies whether the document is active and used for checks.
    
    Returns:
    
    the current DocumentReference instance, allowing for method chaining
  - getActive
```
public Boolean getActive()
```
    Identifies whether the document is active and used for checks.
    
    Returns:
    
    active Identifies whether the document is active and used for checks.
  - setActive
```
public void setActive(Boolean active)
```
    Identifies whether the document is active and used for checks.
    
    Parameters:
    
    active - Identifies whether the document is active and used for checks.
  - description
```
public DocumentReference description(String description)
```
    Your description for the document.
    
    Parameters:
    
    description - Your description for the document.
    
    Returns:
    
    the current DocumentReference instance, allowing for method chaining
  - getDescription
```
public String getDescription()
```
    Your description for the document.
    
    Returns:
    
    description Your description for the document.
  - setDescription
```
public void setDescription(String description)
```
    Your description for the document.
    
    Parameters:
    
    description - Your description for the document.
  - fileName
```
public DocumentReference fileName(String fileName)
```
    Document name.
    
    Parameters:
    
    fileName - Document name.
    
    Returns:
    
    the current DocumentReference instance, allowing for method chaining
  - getFileName
```
public String getFileName()
```
    Document name.
    
    Returns:
    
    fileName Document name.
  - setFileName
```
public void setFileName(String fileName)
```
    Document name.
    
    Parameters:
    
    fileName - Document name.
  - id
```
public DocumentReference id(String id)
```
    The unique identifier of the resource.
    
    Parameters:
    
    id - The unique identifier of the resource.
    
    Returns:
    
    the current DocumentReference instance, allowing for method chaining
  - getId
```
public String getId()
```
    The unique identifier of the resource.
    
    Returns:
    
    id The unique identifier of the resource.
  - setId
```
public void setId(String id)
```
    The unique identifier of the resource.
    
    Parameters:
    
    id - The unique identifier of the resource.
  - modificationDate
```
public DocumentReference modificationDate(OffsetDateTime modificationDate)
```
    The modification date of the document.
    
    Parameters:
    
    modificationDate - The modification date of the document.
    
    Returns:
    
    the current DocumentReference instance, allowing for method chaining
  - getModificationDate
```
public OffsetDateTime getModificationDate()
```
    The modification date of the document.
    
    Returns:
    
    modificationDate The modification date of the document.
  - setModificationDate
```
public void setModificationDate(OffsetDateTime modificationDate)
```
    The modification date of the document.
    
    Parameters:
    
    modificationDate - The modification date of the document.
  - pages
```
public DocumentReference pages(List<DocumentPage> pages)
```
    List of document pages
    
    Parameters:
    
    pages - List of document pages
    
    Returns:
    
    the current DocumentReference instance, allowing for method chaining
  - addPagesItem
```
public DocumentReference addPagesItem(DocumentPage pagesItem)
```
  - getPages
```
public List<DocumentPage> getPages()
```
    List of document pages
    
    Returns:
    
    pages List of document pages
  - setPages
```
public void setPages(List<DocumentPage> pages)
```
    List of document pages
    
    Parameters:
    
    pages - List of document pages
  - type
```
public DocumentReference type(String type)
```
    Type of document, used when providing an ID number or uploading a document.
    
    Parameters:
    
    type - Type of document, used when providing an ID number or uploading a document.
    
    Returns:
    
    the current DocumentReference instance, allowing for method chaining
  - getType
```
public String getType()
```
    Type of document, used when providing an ID number or uploading a document.
    
    Returns:
    
    type Type of document, used when providing an ID number or uploading a document.
  - setType
```
public void setType(String type)
```
    Type of document, used when providing an ID number or uploading a document.
    
    Parameters:
    
    type - Type of document, used when providing an ID number or uploading a document.
  - includeNullValues
```
public DocumentReference includeNullValues(boolean includeNullValues)
```
    Configures whether null values are explicitly serialized in the JSON payload. Default is false.
  - isIncludeNullValues
```
public boolean isIncludeNullValues()
```
    Returns whether null values are explicitly serialized in the JSON payload.
  - setIncludeNullValues
```
public void setIncludeNullValues(boolean includeNullValues)
```
    Sets whether null values should be explicitly serialized in the JSON payload. Default is false.
  - equals
```
public boolean equals(Object o)
```
    Return true if this DocumentReference object is equal to o.
    
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getExplicitNulls
```
public Map<String,Object> getExplicitNulls()
```
    Returns a map of properties to be merged into the JSON payload as explicit null values.
  - fromJson
```
public static DocumentReference fromJson(String jsonString)
                                  throws com.fasterxml.jackson.core.JsonProcessingException
```
    Create an instance of DocumentReference given an JSON string
    
    Parameters:
    
    jsonString - JSON string
    
    Returns:
    
    An instance of DocumentReference
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException - if the JSON string is invalid with respect to DocumentReference
  - toJson
```
public String toJson()
              throws com.fasterxml.jackson.core.JsonProcessingException
```
    Convert an instance of DocumentReference to an JSON string
    
    Returns:
    
    JSON string
    
    Throws:
    
    com.fasterxml.jackson.core.JsonProcessingException

Class DocumentReference

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

JSON_PROPERTY_ACTIVE

JSON_PROPERTY_DESCRIPTION

JSON_PROPERTY_FILE_NAME

JSON_PROPERTY_ID

JSON_PROPERTY_MODIFICATION_DATE

JSON_PROPERTY_PAGES

JSON_PROPERTY_TYPE

Constructor Detail

DocumentReference

Method Detail

active

getActive

setActive

description

getDescription

setDescription

fileName

getFileName

setFileName

id

getId

setId

modificationDate

getModificationDate

setModificationDate

pages

addPagesItem

getPages

setPages

type

getType

setType

includeNullValues

isIncludeNullValues

setIncludeNullValues

equals

hashCode

toString

getExplicitNulls

fromJson

toJson