# Serialized Form

## Package com.logicaldoc.core

### Exception Class com.logicaldoc.core.PersistenceException

class PersistenceException extends SQLException implements Serializable

serialVersionUID:
  1L

### Class com.logicaldoc.core.PersistentObject

class PersistentObject extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### creation

    Date creation

##### deleted

    int deleted

##### id

    long id

##### lastModified

    Date lastModified

##### recordVersion

    long recordVersion

##### tenantId

    long tenantId

### Class com.logicaldoc.core.SqlRowSetWrapper

class SqlRowSetWrapper extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### rowSet

    org.springframework.jdbc.support.rowset.SqlRowSet rowSet

## Package com.logicaldoc.core.automation

### Class com.logicaldoc.core.automation.AutomationDateTool

class AutomationDateTool extends org.apache.velocity.tools.generic.DateTool implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### dateFormat

    String dateFormat

##### dateFormatLong

    String dateFormatLong

##### dateFormatShort

    String dateFormatShort

##### timeZone

    TimeZone timeZone

### Exception Class com.logicaldoc.core.automation.AutomationException

class AutomationException extends Exception implements Serializable

serialVersionUID:
  1L

### Class com.logicaldoc.core.automation.AutomationNumberTool

class AutomationNumberTool extends org.apache.velocity.tools.generic.NumberTool implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.automation.ForbiddenCodeException

class ForbiddenCodeException extends AutomationException implements Serializable

serialVersionUID:
  1L

### Class com.logicaldoc.core.automation.I18NTool

class I18NTool extends HashMap<String,String> implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.communication

### Class com.logicaldoc.core.communication.EMail

class EMail extends Message implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### accountId

    long accountId

The e-mail account used to fetch this message

##### attachments

    Map<Integer,EMailAttachment> attachments

##### attachmentsCount

    int attachmentsCount

##### authorAddress

    String authorAddress

##### emailId

    String emailId

Refers to the original email id

##### folder

    String folder

Name of the folder inside the mail server

##### from

    Recipient from

##### headers

    Map<String,String> headers

Optional headers to put in the email

##### historicyze

    boolean historicyze

If this message supports the historycization in case of ourgoing message

##### images

    Set<String> images

This images are added as part of the body, each image will be identified with 'image_i'. Use an URL to reference them.

##### recipientsBCC

    Set<Recipient> recipientsBCC

##### recipientsCC

    Set<Recipient> recipientsCC

##### replyTo

    Set<Recipient> replyTo

##### signed

    int signed

##### skip

    boolean skip

Indicates if the email must be discarded by the elaboration

##### targetFolder

    Folder targetFolder

Folder where the document representing this email will be saved in

##### username

    String username

### Class com.logicaldoc.core.communication.EMailAttachment

class EMailAttachment extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### contentEncoding

    String contentEncoding

Should be used to fill the Content-Transfer-Encoding header

##### contentType

    String contentType

Should be used to fill the Content-Type header

##### data

    byte[] data

##### disposition

    String disposition

Should be used to fill the Content-Disposition header

##### fileName

    String fileName

##### icon

    String icon

##### mimeType

    String mimeType

##### size

    long size

### Class com.logicaldoc.core.communication.Message

class Message extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### author

    String author

##### html

    boolean html

##### locale

    Locale locale

The locale in which the message is written

##### messageText

    String messageText

##### notify

    boolean notify

A flag that can be used to specify if the message has to be notified

##### receivedDate

    Date receivedDate

When the message was received

##### recipients

    Set<Recipient> recipients

##### sentDate

    Date sentDate

When the message was sent

##### subject

    String subject

##### type

    int type

### Class com.logicaldoc.core.communication.MessageTemplate

class MessageTemplate extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### body

    String body

##### description

    String description

##### language

    String language

##### name

    String name

##### subject

    String subject

##### type

    String type

### Class com.logicaldoc.core.communication.Recipient

class Recipient extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### address

    String address

##### mode

    String mode

##### name

    String name

##### read

    int read

##### type

    int type

### Class com.logicaldoc.core.communication.SystemMessage

class SystemMessage extends Message implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### confirmation

    int confirmation

##### dateScope

    int dateScope

##### lastNotified

    Date lastNotified

The date this message was last notified

##### prio

    int prio

A priority: 0 = low, 1 = medium, 2 = high

##### status

    int status

##### trials

    int trials

The number of notification trials

## Package com.logicaldoc.core.contact

### Class com.logicaldoc.core.contact.Contact

class Contact extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### address

    String address

##### company

    String company

##### email

    String email

##### firstName

    String firstName

##### lastName

    String lastName

##### mobile

    String mobile

##### phone

    String phone

##### userId

    Long userId

## Package com.logicaldoc.core.dashlet

### Class com.logicaldoc.core.dashlet.Dashlet

class Dashlet extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### columns

    String columns

##### content

    String content

##### max

    Integer max

##### name

    String name

##### query

    String query

##### title

    String title

##### type

    String type

##### unique

    boolean unique

To mark that it must display just unique records

### Class com.logicaldoc.core.dashlet.DashletContent

class DashletContent extends jakarta.servlet.http.HttpServlet implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.document

### Class com.logicaldoc.core.document.AbstractDocument

class AbstractDocument extends Fillable implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### barcoded

    boolean barcoded

##### barcodeTemplateId

    Long barcodeTemplateId

Identifier of the barcode template to use to process this document

##### color

    String color

##### comment

    String comment

##### creator

    String creator

##### creatorId

    long creatorId

##### customId

    String customId

##### date

    Date date

##### decodedPassword

    String decodedPassword

##### deleteUserId

    Long deleteUserId

##### digest

    String digest

##### docAttrs

    int docAttrs

Counter of extended attributes of type Document

##### documentTemplateId

    Long documentTemplateId

##### documentTemplateName

    String documentTemplateName

##### embeddingStatus

    EmbeddingStatus embeddingStatus

##### exportId

    Long exportId

##### exportName

    String exportName

##### exportStatus

    int exportStatus

##### exportVersion

    String exportVersion

##### extResId

    String extResId

Used for saving the external resource ID when editing online

##### fileName

    String fileName

##### fileSize

    long fileSize

##### fileVersion

    String fileVersion

##### formId

    Long formId

##### immutable

    boolean immutable

##### indexingStatus

    IndexingStatus indexingStatus

##### language

    String language

##### lastNote

    String lastNote

The text of the last note put on the document

##### links

    int links

##### lockUser

    String lockUser

##### lockUserId

    Long lockUserId

##### modified

    boolean modified

Not persistent flag used to indicate that the document was modified and should be saved back

##### nature

    int nature

##### ocrd

    boolean ocrd

Indicates if the document has been processed by the zonal OCR: 0 = to process, 1 = processed

##### ocrTemplateId

    Long ocrTemplateId

Identifier of the Zonal OCR template to use to process this document

##### pages

    int pages

##### password

    String password

##### previewPages

    int previewPages

##### published

    boolean published

##### publisher

    String publisher

##### publisherId

    long publisherId

##### revision

    String revision

##### signed

    boolean signed

##### stamped

    boolean stamped

##### startPublishing

    Date startPublishing

##### status

    DocumentStatus status

##### stopPublishing

    Date stopPublishing

##### tgs

    String tgs

##### transactionId

    String transactionId

##### type

    String type

##### version

    String version

##### workflowStatus

    String workflowStatus

##### workflowStatusDisplay

    String workflowStatusDisplay

### Class com.logicaldoc.core.document.AbstractDocumentHistory

class AbstractDocumentHistory extends History implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### docId

    Long docId

##### document

    AbstractDocument document

##### filename

    String filename

##### filenameOld

    String filenameOld

##### fileSize

    Long fileSize

##### fileVersion

    String fileVersion

##### folder

    Folder folder

##### folderId

    Long folderId

##### pathOld

    String pathOld

##### reason

    String reason

Something to better qualify the event

##### revision

    String revision

##### version

    String version

### Class com.logicaldoc.core.document.Bookmark

class Bookmark extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### description

    String description

##### fileType

    String fileType

##### position

    int position

##### targetId

    long targetId

##### title

    String title

##### type

    int type

##### userId

    long userId

### Class com.logicaldoc.core.document.Document

class Document extends AbstractDocument implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### accessControlList

    Set<DocumentAccessControlEntry> accessControlList

##### attributes

    Map<String,Attribute> attributes

##### deleteUser

    String deleteUser

##### docRef

    Long docRef

##### docRefType

    String docRefType

##### folder

    Folder folder

##### rating

    Integer rating

##### tags

    Set<Tag> tags

##### template

    Template template

### Class com.logicaldoc.core.document.DocumentAccessControlEntry

class DocumentAccessControlEntry extends ExtendedAccessControlEntry implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### ace

    ExtendedAccessControlEntry ace

### Class com.logicaldoc.core.document.DocumentHistory

class DocumentHistory extends AbstractDocumentHistory implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### color

    String color

##### isNew

    boolean isNew

### Class com.logicaldoc.core.document.DocumentLink

class DocumentLink extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### document1

    Document document1

##### document2

    Document document2

##### type

    String type

### Class com.logicaldoc.core.document.DocumentNote

class DocumentNote extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### accessControlList

    Set<NoteAccessControlEntry> accessControlList

##### color

    String color

##### date

    Date date

##### docId

    long docId

##### fileName

    String fileName

##### fileVersion

    String fileVersion

##### height

    double height

##### left

    double left

##### lineColor

    String lineColor

##### lineOpacity

    int lineOpacity

##### lineWidth

    int lineWidth

##### message

    String message

##### opacity

    int opacity

##### page

    int page

##### recipient

    String recipient

A reference to a recipient, it could be a username or the full name of a person, normally this field is not used

##### recipientEmail

    String recipientEmail

An email associated to the note, normally this field is not used

##### rotation

    double rotation

##### shape

    String shape

##### top

    double top

##### type

    String type

A type of note, for normal notes it is null

##### userId

    long userId

Unique identifier of the user that created this note

##### username

    String username

Unique username of the user that created this note

##### width

    double width

### Exception Class com.logicaldoc.core.document.DuplicateDocumentException

class DuplicateDocumentException extends Exception implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### customId

    String customId

### Class com.logicaldoc.core.document.FolderAccessControlEntry

class FolderAccessControlEntry extends ExtendedAccessControlEntry implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### ace

    ExtendedAccessControlEntry ace

##### add

    boolean add

##### export

    boolean export

##### iimport

    boolean iimport

##### store

    boolean store

### Class com.logicaldoc.core.document.NoteAccessControlEntry

class NoteAccessControlEntry extends AccessControlEntry implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### ace

    AccessControlEntry ace

##### delete

    boolean delete

##### security

    boolean security

### Class com.logicaldoc.core.document.Rating

class Rating extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### average

    Float average

##### count

    Integer count

##### docId

    long docId

##### userId

    long userId

##### username

    String username

##### vote

    int vote

### Class com.logicaldoc.core.document.Tag

class Tag extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### tagWord

    String tagWord

##### tenantId

    long tenantId

### Exception Class com.logicaldoc.core.document.TooManyDocumentsException

class TooManyDocumentsException extends PersistenceException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### folderId

    long folderId

### Class com.logicaldoc.core.document.Version

class Version extends AbstractDocument implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### attributes

    Map<String,Attribute> attributes

##### creator

    String creator

##### creatorId

    long creatorId

##### docId

    long docId

##### event

    String event

##### folderId

    long folderId

##### folderName

    String folderName

##### templateId

    Long templateId

##### templateName

    String templateName

##### userId

    long userId

##### username

    String username

##### versionDate

    Date versionDate

## Package com.logicaldoc.core.filler

### Class com.logicaldoc.core.filler.ChainFiller

class ChainFiller extends Filler implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### chain

    List<Filler> chain

### Class com.logicaldoc.core.filler.Fillable

class Fillable extends ExtensibleObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### fillerId

    Long fillerId

ID of the filler to use for autofill operations

### Class com.logicaldoc.core.filler.Filler

class Filler extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### checkin

    boolean checkin

Specifies if the document must be re-filled at checkin

##### description

    String description

##### label

    String label

##### name

    String name

##### overwrite

    boolean overwrite

Specifies if already filled properties must be overwrite

### Class com.logicaldoc.core.filler.MockFiller

class MockFiller extends Filler implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.folder

### Class com.logicaldoc.core.folder.Folder

class Folder extends Fillable implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### accessControlList

    Set<FolderAccessControlEntry> accessControlList

##### attributes

    Map<String,Attribute> attributes

##### barcodeTemplateId

    Long barcodeTemplateId

Identifier of the barcode template to use to process the documents inside this folder

##### color

    String color

##### creator

    String creator

##### creatorId

    Long creatorId

##### deleteUser

    String deleteUser

##### deleteUserId

    Long deleteUserId

##### description

    String description

##### foldRef

    Long foldRef

##### grid

    String grid

Description of the grid that displays the list of documents

##### hidden

    boolean hidden

##### maxVersions

    Integer maxVersions

##### name

    String name

##### ocrTemplateId

    Long ocrTemplateId

Identifier of the Zonal OCR template to use to process the documents inside this folder

##### parentId

    long parentId

##### path

    String path

Stores the absolute path of the folder composed by IDs like /5/4/12354

##### pathExtended

    String pathExtended

Transient attribute that stores a human readable path like /Default/invoices

##### position

    int position

##### quotaAlertRecipients

    String quotaAlertRecipients

##### quotaDocs

    Long quotaDocs

##### quotaSize

    Long quotaSize

##### quotaThreshold

    Integer quotaThreshold

##### securityRef

    Long securityRef

##### stores

    Map<String,Integer> stores

The default stores to use for this folder in the nodes(key: nodeId - value: storeId)

##### tags

    Set<Tag> tags

##### template

    Template template

##### templateLocked

    boolean templateLocked

If true, the users cannot change the template of the contained documents

##### tgs

    String tgs

Comma-separated tags, used for searching only

##### tile

    String tile

##### type

    int type

### Class com.logicaldoc.core.folder.FolderHistory

class FolderHistory extends AbstractDocumentHistory implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### color

    String color

## Package com.logicaldoc.core.generic

### Class com.logicaldoc.core.generic.Generic

class Generic extends ExtensibleObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### attributes

    Map<String,Attribute> attributes

##### date1

    Date date1

##### date2

    Date date2

##### double1

    Double double1

##### double2

    Double double2

##### integer1

    Long integer1

##### integer2

    Long integer2

##### integer3

    Long integer3

##### qualifier

    Long qualifier

##### string1

    String string1

##### string2

    String string2

##### string3

    String string3

##### string4

    String string4

##### string5

    String string5

##### string6

    String string6

##### string7

    String string7

##### string8

    String string8

##### subtype

    String subtype

##### text1

    String text1

##### type

    String type

## Package com.logicaldoc.core.history

### Class com.logicaldoc.core.history.History

class History extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### comment

    String comment

Comment left in regards of this event

##### date

    Date date

##### device

    String device

##### event

    String event

##### file

    File file

Some histories are strictly related to a local file

##### geolocation

    String geolocation

##### impersonator

    String impersonator

##### ip

    String ip

##### keyLabel

    String keyLabel

##### notified

    boolean notified

Used to mark this event notified by the auditing system

##### notifyEvent

    boolean notifyEvent

Marks if this event has to be notified by the events collector

##### overwrite

    Boolean overwrite

A generic indication to elaborators like fillers about how to handle overwrites

##### path

    String path

##### sessionId

    String sessionId

##### tenant

    String tenant

Note persistent, used as convenience to store the name of the tenant

##### user

    User user

##### userId

    Long userId

##### userLogin

    String userLogin

##### username

    String username

## Package com.logicaldoc.core.i18n

### Class com.logicaldoc.core.i18n.DateBean

class DateBean extends Date implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.imaging

### Class com.logicaldoc.core.imaging.ImageZone

class ImageZone extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### height

    Double height

Height of the zone (percentage of the height 0..1)

##### left

    Double left

Upper-left corner of the zone (percentage of the width 0..1)

##### top

    Double top

Upper-left corner of the zone (percentage of the height 0..1)

##### width

    Double width

Width of the zone (percentage of the width 0..1)

## Package com.logicaldoc.core.metadata

### Class com.logicaldoc.core.metadata.AbstractAttributeSet

class AbstractAttributeSet extends ExtensibleObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### description

    String description

##### label

    String label

##### name

    String name

##### readonly

    boolean readonly

##### type

    int type

### Class com.logicaldoc.core.metadata.Attribute

class Attribute extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### dateValue

    Date dateValue

##### dependsOn

    String dependsOn

Name of another attribute on which the value of this attribute also depends, used for managing linked presets

##### doubleValue

    Double doubleValue

##### editor

    int editor

##### hidden

    boolean hidden

##### initialization

    String initialization

Optional script that defines the initial value

##### intValue

    Long intValue

##### label

    String label

##### mandatory

    boolean mandatory

##### multiple

    boolean multiple

##### name

    String name

Not persistent

##### parent

    String parent

Name of a parent attribute, used for multiple values attributes

##### position

    int position

##### readonly

    boolean readonly

##### setId

    Long setId

Reference to the Attribute Set

##### stringValue

    String stringValue

String representation of the multiple string values

##### stringValues

    String stringValues

##### type

    int type

##### validation

    String validation

Optional validation script

### Class com.logicaldoc.core.metadata.AttributeOption

class AttributeOption extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### attribute

    String attribute

##### category

    String category

An category, just to organize the values in groups

##### label

    String label

##### position

    int position

##### setId

    long setId

##### value

    String value

The value of this option

### Class com.logicaldoc.core.metadata.AttributeSet

class AttributeSet extends AbstractAttributeSet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### templateAttributes

    Map<String,Attribute> templateAttributes

### Class com.logicaldoc.core.metadata.ExtensibleObject

class ExtensibleObject extends PersistentObject implements Serializable

serialVersionUID:
  1L

### Class com.logicaldoc.core.metadata.Template

class Template extends AbstractAttributeSet implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### accessControlList

    Set<AccessControlEntry> accessControlList

##### initialization

    String initialization

##### templateAttributes

    Map<String,Attribute> templateAttributes

##### validation

    String validation

## Package com.logicaldoc.core.metadata.validation

### Class com.logicaldoc.core.metadata.validation.ValidationError

class ValidationError extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### attribute

    String attribute

##### description

    String description

##### label

    String label

### Exception Class com.logicaldoc.core.metadata.validation.ValidationException

class ValidationException extends PersistenceException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### errors

    Map<String,ValidationError> errors

A map of error descriptions: key is the attribute's name, value is the error descriptor

## Package com.logicaldoc.core.parser

### Exception Class com.logicaldoc.core.parser.ParsingException

class ParsingException extends Exception implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.parser.ParsingTimeoutException

class ParsingTimeoutException extends ParsingException implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.runtime

### Exception Class com.logicaldoc.core.runtime.AspectDisabledException

class AspectDisabledException extends FeatureDisabledException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.runtime.FeatureDisabledException

class FeatureDisabledException extends Exception implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.searchengine

### Class com.logicaldoc.core.searchengine.FulltextSearchOptions

class FulltextSearchOptions extends SearchOptions implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### creationFrom

    Date creationFrom

##### creationTo

    Date creationTo

##### dateFrom

    Date dateFrom

##### dateTo

    Date dateTo

##### expressionLanguage

    String expressionLanguage

##### fields

    Set<String> fields

##### format

    String format

##### language

    String language

##### sizeMax

    Long sizeMax

##### sizeMin

    Long sizeMin

### Class com.logicaldoc.core.searchengine.Hit

class Hit extends Document implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### content

    String content

##### score

    int score

##### summary

    String summary

### Class com.logicaldoc.core.searchengine.Hits

class Hits extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### rsp

    org.apache.solr.client.solrj.response.QueryResponse rsp

### Exception Class com.logicaldoc.core.searchengine.IndexException

class IndexException extends Exception implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.searchengine.SearchException

class SearchException extends Exception implements Serializable

serialVersionUID:
  1L

### Class com.logicaldoc.core.searchengine.SearchOptions

class SearchOptions extends Object implements Serializable

serialVersionUID:
  2L

#### Serialized Fields

##### caseSensitive

    boolean caseSensitive

##### description

    String description

##### expression

    String expression

##### filterIds

    Set<Long> filterIds

Optional set of document ids. If specified only documents inside this set will be returned.

##### folderId

    Long folderId

##### maxHits

    int maxHits

##### name

    String name

##### page

    int page

##### retrieveAliases

    boolean retrieveAliases

##### searchInSubPath

    boolean searchInSubPath

##### template

    Long template

##### tenantId

    Long tenantId

##### topOperator

    String topOperator

##### transaction

    UserHistory transaction

##### type

    int type

##### userId

    long userId

### Class com.logicaldoc.core.searchengine.TagSearchOptions

class TagSearchOptions extends SearchOptions implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.searchengine.folder

### Class com.logicaldoc.core.searchengine.folder.FolderCriterion

class FolderCriterion extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### composition

    String composition

##### dateValue

    Date dateValue

##### doubleValue

    Double doubleValue

##### extendedAttribute

    boolean extendedAttribute

##### field

    String field

##### fieldName

    String fieldName

##### longValue

    Long longValue

##### operator

    String operator

##### parentPathDescr

    String parentPathDescr

##### showFolderSelector

    boolean showFolderSelector

##### stringValue

    String stringValue

##### type

    int type

### Class com.logicaldoc.core.searchengine.folder.FolderSearchOptions

class FolderSearchOptions extends SearchOptions implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### criteria

    List<FolderCriterion> criteria

##### order

    List<String> order

List of order criteria eg: lastmodified asc, title desc

## Package com.logicaldoc.core.searchengine.saved

### Class com.logicaldoc.core.searchengine.saved.SavedSearch

class SavedSearch extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### date

    Date date

##### description

    String description

##### name

    String name

##### options

    String options

##### type

    int type

##### userId

    long userId

## Package com.logicaldoc.core.security

### Class com.logicaldoc.core.security.AccessControlEntry

class AccessControlEntry extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### groupId

    long groupId

##### read

    boolean read

##### write

    boolean write

### Class com.logicaldoc.core.security.Client

class Client extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### address

    String address

##### device

    Device device

##### host

    String host

##### id

    String id

An optional Identifier of the client, you must guarantee that this is unique.

##### username

    String username

### Class com.logicaldoc.core.security.Device

class Device extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### browser

    String browser

Name of the browser

##### browserVersion

    String browserVersion

Version of the browser

##### deviceId

    String deviceId

A unique identifier of the device

##### ip

    String ip

IP of last login

##### label

    String label

Optional label assigned to the device

##### lastLogin

    Date lastLogin

Instant of last login

##### operativeSystem

    String operativeSystem

Name of the operative system

##### trusted

    boolean trusted

##### type

    String type

Type of device

##### userId

    long userId

##### username

    String username

### Class com.logicaldoc.core.security.ExtendedAccessControlEntry

class ExtendedAccessControlEntry extends AccessControlEntry implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### ace

    AccessControlEntry ace

##### archive

    boolean archive

##### automation

    boolean automation

##### calendar

    boolean calendar

##### customid

    boolean customid

##### delete

    boolean delete

##### download

    boolean download

##### email

    boolean email

##### immutable

    boolean immutable

##### move

    boolean move

##### password

    boolean password

##### preview

    boolean preview

##### print

    boolean print

##### readingreq

    boolean readingreq

##### rename

    boolean rename

##### revision

    boolean revision

##### security

    boolean security

##### sign

    boolean sign

##### subscription

    boolean subscription

##### workflow

    boolean workflow

### Class com.logicaldoc.core.security.Session

class Session extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### client

    Client client

##### decodedKey

    String decodedKey

##### finished

    Date finished

##### impersonator

    String impersonator

##### key

    String key

A third parameter(other than the username and password) given by the client at login time, or an API Key generated in LogicalDOC.

##### keyLabel

    String keyLabel

A human readable visualization of part of the key

##### lastRenew

    Date lastRenew

##### node

    String node

##### sid

    String sid

Represents the auto generated identifier of the session

##### status

    SessionStatus status

##### tenantId

    long tenantId

##### tenantName

    String tenantName

##### unprotectedDocs

    Map<Long,String> unprotectedDocs

##### user

    User user

##### username

    String username

### Class com.logicaldoc.core.security.SessionManager

class SessionManager extends ConcurrentHashMap<String,Session> implements Serializable

serialVersionUID:
  1L

### Class com.logicaldoc.core.security.Tenant

class Tenant extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### city

    String city

##### country

    String country

##### displayName

    String displayName

##### email

    String email

##### enabled

    boolean enabled

##### expire

    Date expire

##### maxApiCalls

    Long maxApiCalls

Maximum monthly API calls

##### maxDocuments

    Long maxDocuments

##### maxEmailAccounts

    Long maxEmailAccounts

##### maxForms

    Long maxForms

##### maxGuests

    Integer maxGuests

##### maxImportFolders

    Long maxImportFolders

##### maxReports

    Long maxReports

##### maxRepoSize

    Long maxRepoSize

Maximum repository size expressed in MB

##### maxSessions

    Integer maxSessions

##### maxStamps

    Long maxStamps

##### maxTickets

    Long maxTickets

##### maxUsers

    Integer maxUsers

##### maxWorkflows

    Long maxWorkflows

##### name

    String name

##### postalCode

    String postalCode

##### quotaAlertRecipients

    String quotaAlertRecipients

##### quotaThreshold

    Integer quotaThreshold

##### state

    String state

##### street

    String street

##### telephone

    String telephone

##### type

    int type

## Package com.logicaldoc.core.security.apikey

### Class com.logicaldoc.core.security.apikey.ApiKey

class ApiKey extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### decodedKey

    String decodedKey

##### key

    String key

##### label

    String label

##### lastUsed

    Date lastUsed

##### name

    String name

##### userId

    long userId

## Package com.logicaldoc.core.security.authentication

### Exception Class com.logicaldoc.core.security.authentication.AccountDisabledException

class AccountDisabledException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.AccountExpiredException

class AccountExpiredException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### date

    Date date

### Exception Class com.logicaldoc.core.security.authentication.AccountInactiveException

class AccountInactiveException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### days

    int days

### Exception Class com.logicaldoc.core.security.authentication.AccountNotFoundException

class AccountNotFoundException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.AccountTypeNotAllowedException

class AccountTypeNotAllowedException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.ApiKeyBlockedException

class ApiKeyBlockedException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.AuthenticationException

class AuthenticationException extends RuntimeException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.ForbiddenImpersonationException

class ForbiddenImpersonationException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.InvalidSessionException

class InvalidSessionException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### sid

    String sid

### Exception Class com.logicaldoc.core.security.authentication.IPBlockedException

class IPBlockedException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.OutsideWorkingTimeException

class OutsideWorkingTimeException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.PasswordAlreadyUsedException

class PasswordAlreadyUsedException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### date

    Date date

### Exception Class com.logicaldoc.core.security.authentication.PasswordExpiredException

class PasswordExpiredException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.PasswordWeakException

class PasswordWeakException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### messages

    List<String> messages

The reasons to explain the weakness

### Exception Class com.logicaldoc.core.security.authentication.UnconfirmedLegalsException

class UnconfirmedLegalsException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.UsernameBlockedException

class UsernameBlockedException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authentication.WrongPasswordException

class WrongPasswordException extends AuthenticationException implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.security.authorization

### Exception Class com.logicaldoc.core.security.authorization.AuthorizationException

class AuthorizationException extends Exception implements Serializable

serialVersionUID:
  1L

### Exception Class com.logicaldoc.core.security.authorization.PermissionException

class PermissionException extends AuthorizationException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### permission

    Permission permission

##### securityObject

    String securityObject

Identifier of the security object the permission refers to

##### username

    String username

### Exception Class com.logicaldoc.core.security.authorization.UnexistingResourceException

class UnexistingResourceException extends AuthorizationException implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### resource

    String resource

Identifier of the resource

##### username

    String username

## Package com.logicaldoc.core.security.menu

### Class com.logicaldoc.core.security.menu.Menu

class Menu extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### accessControlList

    Set<AccessControlEntry> accessControlList

##### automation

    String automation

Automation script to execute(in absence of routine specification)

##### description

    String description

##### enabled

    boolean enabled

##### icon

    String icon

##### name

    String name

##### parentId

    long parentId

##### position

    int position

##### routineId

    Long routineId

The declared routine to execute

##### type

    int type

## Package com.logicaldoc.core.security.spring

### Class com.logicaldoc.core.security.spring.LDAuthenticationDetails

class LDAuthenticationDetails extends org.springframework.security.web.authentication.WebAuthenticationDetails implements Serializable

serialVersionUID:
  620L

#### Serialized Fields

##### secretKey

    String secretKey

### Class com.logicaldoc.core.security.spring.LDAuthenticationToken

class LDAuthenticationToken extends org.springframework.security.authentication.UsernamePasswordAuthenticationToken implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### anonymous

    boolean anonymous

##### sid

    String sid

## Package com.logicaldoc.core.security.user

### Class com.logicaldoc.core.security.user.Group

class Group extends PersistentObject implements Serializable

serialVersionUID:
  2L

#### Serialized Fields

##### description

    String description

##### name

    String name

##### source

    String source

Specifies the source: 'local' indicates the group was created in the local database

##### type

    GroupType type

##### users

    Set<User> users

Not persistent

### Class com.logicaldoc.core.security.user.PasswordHistory

class PasswordHistory extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### date

    Date date

##### password

    String password

##### userId

    long userId

### Class com.logicaldoc.core.security.user.User

class User extends PersistentObject implements Serializable

serialVersionUID:
  8093874904302301982L

#### Serialized Fields

##### avatar

    String avatar

Base64 representation of the avatar image

##### building

    String building

##### certDN

    String certDN

The distinguished name of the certificate

##### certExpire

    Date certExpire

When the certificate expires

##### city

    String city

##### company

    String company

##### country

    String country

##### dateFormat

    String dateFormat

##### dateFormatLong

    String dateFormatLong

##### dateFormatShort

    String dateFormatShort

##### decodedPassword

    String decodedPassword

##### defaultWorkspace

    Long defaultWorkspace

##### department

    String department

##### docsGrid

    String docsGrid

Description of the grid that displays the list of documents

##### email

    String email

##### email2

    String email2

##### emailSignature

    String emailSignature

A simple text to be used as a signature in the footer of the outgoing emails

##### emailSignature2

    String emailSignature2

##### enabled

    boolean enabled

##### enforceWorkingTime

    boolean enforceWorkingTime

If the system must forbid the login outside the working time

##### evalFormEnabled

    boolean evalFormEnabled

If the user wants to enable the evaluation form

##### expire

    Date expire

When this account expires

##### firstName

    String firstName

##### groups

    Set<Group> groups

Groups this user belongs to

##### hitsGrid

    String hitsGrid

Description of the grid that shows the results of a search

##### impersonator

    String impersonator

A user currently impersonating this one

##### impersonators

    Set<String> impersonators

Other usernames allowed to impersonate this user

##### ipBlackList

    String ipBlackList

##### ipWhiteList

    String ipWhiteList

##### key

    String key

A key used by the second factor authenticator

##### language

    String language

##### lastEnabled

    Date lastEnabled

Last time this account has been activated

##### lastLogin

    Date lastLogin

Last time the user successfully logged in

##### legals

    boolean legals

If the users must confirm changes in the legals or not

##### maxInactivity

    Integer maxInactivity

Maximum number of inactivity days after which the account gets disabled. Possible values are:

- null: the general setting is used instead
- <=0: no checks will be done for this user
- >0: number of maximum inactivity days

##### name

    String name

##### organizationalUnit

    String organizationalUnit

##### password

    String password

##### passwordChanged

    Date passwordChanged

The last time the password was changed

##### passwordExpired

    boolean passwordExpired

If the password already expired

##### passwordExpires

    boolean passwordExpires

If the password expires or not

##### postalcode

    String postalcode

##### quota

    long quota

##### repass

    String repass

Only for GUI

##### searchPref

    String searchPref

Comma separated list of searches that defines the order they are displayed in the user interface

##### secondFactor

    String secondFactor

The second factor authenticator to use

##### sessionsQuota

    long sessionsQuota

##### source

    UserSource source

##### state

    String state

##### street

    String street

##### telephone

    String telephone

##### telephone2

    String telephone2

##### timeZone

    String timeZone

##### type

    UserType type

##### userGroups

    Set<UserGroup> userGroups

##### username

    String username

##### welcomeScreen

    Integer welcomeScreen

##### workingTimes

    Set<WorkingTime> workingTimes

Collection of all the admitted working times

### Class com.logicaldoc.core.security.user.UserGroup

class UserGroup extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### groupId

    long groupId

### Class com.logicaldoc.core.security.user.UserHistory

class UserHistory extends History implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### author

    String author

##### docId

    Long docId

##### filename

    String filename

##### fileSize

    Long fileSize

##### folderId

    Long folderId

### Class com.logicaldoc.core.security.user.WorkingTime

class WorkingTime extends Object implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### dayOfWeek

    int dayOfWeek

The day of week ranges from 1 (Sunday) to 7 (Saturday)

##### description

    String description

##### hourEnd

    int hourEnd

##### hourStart

    int hourStart

##### label

    String label

##### minuteEnd

    int minuteEnd

##### minuteStart

    int minuteStart

## Package com.logicaldoc.core.sequence

### Class com.logicaldoc.core.sequence.Sequence

class Sequence extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### lastReset

    Date lastReset

##### name

    String name

##### objectId

    long objectId

##### value

    long value

## Package com.logicaldoc.core.task

### Exception Class com.logicaldoc.core.task.TaskException

class TaskException extends Exception implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.threading

### Exception Class com.logicaldoc.core.threading.ThreadPoolNotAvailableException

class ThreadPoolNotAvailableException extends Exception implements Serializable

serialVersionUID:
  1L

## Package com.logicaldoc.core.ticket

### Class com.logicaldoc.core.ticket.Ticket

class Ticket extends PersistentObject implements Serializable

serialVersionUID:
  1L

#### Serialized Fields

##### count

    int count

##### decodedPassword

    String decodedPassword

##### docId

    long docId

##### enabled

    boolean enabled

##### expired

    Date expired

A date when this ticket expires

##### expireHours

    Integer expireHours

Not persistent field

##### maxCount

    Integer maxCount

Maximum number of downloads

##### maxViews

    Integer maxViews

Maximum number of views

##### password

    String password

##### suffix

    String suffix

##### ticketId

    String ticketId

##### type

    int type

##### url

    String url

Not persistent field

##### userId

    long userId

##### views

    int views