Document (sdk 11.50 API)

java.lang.Object
- com.silanis.esl.api.model.Model
- - com.silanis.esl.api.model.Entity
  - - com.silanis.esl.api.model.Document

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

SignedDocument
```
public class Document
extends Entity
implements Serializable
```
See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected List<Approval>`	`_approvals`
`protected String`	`_description`
`protected External`	`_external`
`protected Boolean`	`_externalSigned`
`protected Boolean`	`_extract`
`protected Set<String>`	`_extractionTypes`
`protected List<Field>`	`_fields`
`protected Integer`	`_index`
`protected List<Page>`	`_pages`
`protected String`	`_signedHash`
`protected String`	`_signerVerificationToken`
`protected Integer`	`_size`
`protected Boolean`	`_tagged`
`static String`	`FIELD_APPROVALS`
`static String`	`FIELD_DATA`
`static String`	`FIELD_DESCRIPTION`
`static String`	`FIELD_EXTERNAL`
`static String`	`FIELD_EXTERNAL_SIGNED`
`static String`	`FIELD_EXTRACT`
`static String`	`FIELD_EXTRACTION_TYPES`
`static String`	`FIELD_FIELDS`
`static String`	`FIELD_ID`
`static String`	`FIELD_INDEX`
`static String`	`FIELD_NAME`
`static String`	`FIELD_PAGES`
`static String`	`FIELD_SIGNED_HASH`
`static String`	`FIELD_SIGNER_VERIFICATION_TOKEN`
`static String`	`FIELD_SIZE`
`static String`	`FIELD_STATUS`
`static String`	`FIELD_TAGGED`

Fields inherited from class com.silanis.esl.api.model.Entity
_data, _id, _name

Constructor Summary

Constructors
Constructor and Description

Document()

Constructors
Constructor and Description
`Document()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Document`	`addApproval(Approval value)`
`Document`	`addField(Field value)`
`Document`	`addPage(Page value)`
`boolean`	`evalExtract()`
`boolean`	`evalTagged()`
`List<Approval>`	`getApprovals()`
`String`	`getDescription()`
`External`	`getExternal()`
`Boolean`	`getExtract()`
`Set<String>`	`getExtractionTypes()`
`List<Field>`	`getFields()`
`Integer`	`getIndex()`
`List<Page>`	`getPages()`
`String`	`getSignedHash()`
`String`	`getSignerVerificationToken()`
`Integer`	`getSize()`
`String`	`getStatus()`
`Boolean`	`getTagged()`
`Boolean`	`isExternalSigned()`
`Document`	`safeSetApprovals(List<Approval> value)`
`Document`	`safeSetData(Map<String,Object> value)`
`Document`	`safeSetDescription(String value)`
`Document`	`safeSetExternal(External value)`
`Document`	`safeSetExternalSigned(Boolean externalSigned)`
`Document`	`safeSetExtract(Boolean value)`
`Document`	`safeSetExtractionTypes(Set<String> value)`
`Document`	`safeSetFields(List<Field> value)`
`Document`	`safeSetId(String value)`
`Document`	`safeSetIndex(Integer value)`
`Document`	`safeSetName(String value)`
`Document`	`safeSetPages(List<Page> value)`
`Document`	`safeSetSignedHash(String value)`
`Document`	`safeSetSignerVerificationToken(String value)`
`Document`	`safeSetSize(Integer value)`
`Document`	`safeSetTagged(Boolean value)`
`Document`	`setApprovals(List<Approval> value)`
`Document`	`setData(Map<String,Object> value)`
`Document`	`setDescription(String value)`
`Document`	`setExternal(External value)`
`Document`	`setExternalSigned(Boolean externalSigned)`
`Document`	`setExtract(Boolean value)`
`Document`	`setExtractionTypes(Set<String> value)`
`Document`	`setFields(List<Field> value)`
`Document`	`setId(String value)`
`Document`	`setIndex(Integer value)`
`Document`	`setName(String value)`
`Document`	`setPages(List<Page> value)`
`Document`	`setSignedHash(String value)`
`Document`	`setSignerVerificationToken(String value)`
`Document`	`setSize(Integer value)`
`Document`	`setStatus(String value)`
`Document`	`setTagged(Boolean value)`

Methods inherited from class com.silanis.esl.api.model.Entity
getData, getId, getName

Methods inherited from class com.silanis.esl.api.model.Model
clean, getDirtyFields, isDirty, setDirty

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

Field Detail

FIELD_APPROVALS

public static final String FIELD_APPROVALS

See Also:: Constant Field Values

FIELD_DATA
```
public static final String FIELD_DATA
```
See Also:

Constant Field Values

FIELD_DESCRIPTION

public static final String FIELD_DESCRIPTION

See Also:: Constant Field Values

FIELD_EXTERNAL

public static final String FIELD_EXTERNAL

See Also:: Constant Field Values

FIELD_EXTRACT

public static final String FIELD_EXTRACT

See Also:: Constant Field Values

FIELD_EXTRACTION_TYPES

public static final String FIELD_EXTRACTION_TYPES

See Also:: Constant Field Values

FIELD_FIELDS

public static final String FIELD_FIELDS

See Also:: Constant Field Values

FIELD_ID
```
public static final String FIELD_ID
```
See Also:

Constant Field Values

FIELD_INDEX
```
public static final String FIELD_INDEX
```
See Also:

Constant Field Values

FIELD_NAME
```
public static final String FIELD_NAME
```
See Also:

Constant Field Values

FIELD_PAGES
```
public static final String FIELD_PAGES
```
See Also:

Constant Field Values

FIELD_SIZE
```
public static final String FIELD_SIZE
```
See Also:

Constant Field Values

FIELD_STATUS

public static final String FIELD_STATUS

See Also:: Constant Field Values

FIELD_SIGNED_HASH

public static final String FIELD_SIGNED_HASH

See Also:: Constant Field Values

FIELD_SIGNER_VERIFICATION_TOKEN

public static final String FIELD_SIGNER_VERIFICATION_TOKEN

See Also:: Constant Field Values

FIELD_TAGGED

public static final String FIELD_TAGGED

See Also:: Constant Field Values

FIELD_EXTERNAL_SIGNED

public static final String FIELD_EXTERNAL_SIGNED

See Also:: Constant Field Values

_approvals
```
protected List<Approval> _approvals
```

_description
```
protected String _description
```

_external
```
protected External _external
```

_extract
```
protected Boolean _extract
```

_extractionTypes
```
protected Set<String> _extractionTypes
```

_fields
```
protected List<Field> _fields
```

_index
```
protected Integer _index
```

_pages
```
protected List<Page> _pages
```

_size
```
protected Integer _size
```

_signedHash
```
protected String _signedHash
```

_signerVerificationToken

protected String _signerVerificationToken

_tagged
```
protected Boolean _tagged
```

_externalSigned
```
protected Boolean _externalSigned
```

Constructor Detail
- Document
```
public Document()
```

Method Detail

setStatus

public Document setStatus(String value)

getStatus
```
public String getStatus()
```

setApprovals

public Document setApprovals(List<Approval> value)

safeSetApprovals

public Document safeSetApprovals(List<Approval> value)

getApprovals
```
public List<Approval> getApprovals()
```

addApproval

public Document addApproval(Approval value)

setData

public Document setData(Map<String,Object> value)

Overrides:: setData in class Entity

safeSetData

public Document safeSetData(Map<String,Object> value)

Overrides:: safeSetData in class Entity

setDescription

public Document setDescription(String value)

safeSetDescription

public Document safeSetDescription(String value)

getDescription
```
public String getDescription()
```

setExternal

public Document setExternal(External value)

safeSetExternal

public Document safeSetExternal(External value)

getExternal
```
public External getExternal()
```

setExtract

public Document setExtract(Boolean value)

safeSetExtract

public Document safeSetExtract(Boolean value)

getExtract
```
public Boolean getExtract()
```

evalExtract
```
public boolean evalExtract()
```

setExtractionTypes

public Document setExtractionTypes(Set<String> value)

safeSetExtractionTypes

public Document safeSetExtractionTypes(Set<String> value)

getExtractionTypes

public Set<String> getExtractionTypes()

setFields

public Document setFields(List<Field> value)

safeSetFields

public Document safeSetFields(List<Field> value)

getFields
```
public List<Field> getFields()
```

addField

public Document addField(Field value)

setId
```
public Document setId(String value)
```
Overrides:

setId in class Entity

safeSetId

public Document safeSetId(String value)

Overrides:: safeSetId in class Entity

setIndex

public Document setIndex(Integer value)

safeSetIndex

public Document safeSetIndex(Integer value)

getIndex
```
public Integer getIndex()
```

setName

public Document setName(String value)

Overrides:: setName in class Entity

safeSetName

public Document safeSetName(String value)

Overrides:: safeSetName in class Entity

setPages

public Document setPages(List<Page> value)

safeSetPages

public Document safeSetPages(List<Page> value)

getPages
```
public List<Page> getPages()
```

addPage
```
public Document addPage(Page value)
```

setSize

public Document setSize(Integer value)

safeSetSize

public Document safeSetSize(Integer value)

getSize
```
public Integer getSize()
```

setSignedHash

public Document setSignedHash(String value)

safeSetSignedHash

public Document safeSetSignedHash(String value)

getSignedHash
```
public String getSignedHash()
```

setSignerVerificationToken

public Document setSignerVerificationToken(String value)

safeSetSignerVerificationToken

public Document safeSetSignerVerificationToken(String value)

getSignerVerificationToken

public String getSignerVerificationToken()

setTagged

public Document setTagged(Boolean value)

safeSetTagged

public Document safeSetTagged(Boolean value)

getTagged
```
public Boolean getTagged()
```

evalTagged
```
public boolean evalTagged()
```

isExternalSigned
```
public Boolean isExternalSigned()
```

setExternalSigned

public Document setExternalSigned(Boolean externalSigned)

safeSetExternalSigned

public Document safeSetExternalSigned(Boolean externalSigned)

Class Document

Field Summary

Fields inherited from class com.silanis.esl.api.model.Entity

Constructor Summary

Method Summary

Methods inherited from class com.silanis.esl.api.model.Entity

Methods inherited from class com.silanis.esl.api.model.Model

Methods inherited from class java.lang.Object

Field Detail

FIELD_APPROVALS

FIELD_DATA

FIELD_DESCRIPTION

FIELD_EXTERNAL

FIELD_EXTRACT

FIELD_EXTRACTION_TYPES

FIELD_FIELDS

FIELD_ID

FIELD_INDEX

FIELD_NAME

FIELD_PAGES

FIELD_SIZE

FIELD_STATUS

FIELD_SIGNED_HASH

FIELD_SIGNER_VERIFICATION_TOKEN

FIELD_TAGGED

FIELD_EXTERNAL_SIGNED

_approvals

_description

_external

_extract

_extractionTypes

_fields

_index

_pages

_size

_signedHash

_signerVerificationToken

_tagged

_externalSigned

Constructor Detail

Document

Method Detail

setStatus

getStatus

setApprovals

safeSetApprovals

getApprovals

addApproval

setData

safeSetData

setDescription

safeSetDescription

getDescription

setExternal

safeSetExternal

getExternal

setExtract

safeSetExtract

getExtract

evalExtract

setExtractionTypes

safeSetExtractionTypes

getExtractionTypes

setFields

safeSetFields

getFields

addField

setId

safeSetId

setIndex

safeSetIndex

getIndex

setName

safeSetName

setPages

safeSetPages

getPages

addPage

setSize

safeSetSize