Document (Cyclos 4.16.19 Scripting API Documentation)

java.lang.Object
- org.cyclos.entities.SimpleEntity
- - org.cyclos.entities.NetworkedEntity
  - - org.cyclos.entities.BaseEntity
    - - org.cyclos.entities.NamedEntity
      - org.cyclos.entities.contentmanagement.Document

All Implemented Interfaces:

Cloneable, Comparable<NamedEntity>, HasNetwork, ProcessableForProxying, DefinesNetwork, IEntity, INamedEntity

Direct Known Subclasses:

SharedDocument, UserDocument
```
@Entity
public abstract class Document
extends NamedEntity
implements DefinesNetwork
```

Nested Class Summary
- Nested classes/interfaces inherited from class org.cyclos.entities.SimpleEntity
  SimpleEntity.EntityLoadNotifier

Field Summary

Fields
Modifier and Type	Field	Description
`protected DocumentFile`	`file`	This really belongs to `StaticDocument` and `UserDocument` subclasses (getter and setter are there), but we put here to avoid an error in `DocumentFile` that need to reference the root `Document` class.

Constructor Summary

Constructors
Constructor Description

Document()

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`getDescription()`
`DocumentNature`	`getDiscriminator()`
`abstract DocumentNature`	`getNature()`
`Network`	`getNetwork()`	Returns the network this entity belongs to
`boolean`	`isEnable()`
`abstract boolean`	`isHasFile()`
`void`	`setDescription(String description)`
`void`	`setEnable(boolean enable)`
`void`	`setNetwork(Network network)`

Methods inherited from class org.cyclos.entities.NamedEntity
compareTo, getName, getNames, setName, toShortString, toString

Methods inherited from class org.cyclos.entities.BaseEntity
getDataTranslationType, getVersion

Methods inherited from class org.cyclos.entities.NetworkedEntity
isGlobal

Methods inherited from class org.cyclos.entities.SimpleEntity
equals, getId, hashCode, id, ids, isPersistent, isTransient, register, setId, uniqueIds, uniqueIds

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

Methods inherited from interface org.cyclos.model.IEntity
getId, matches

Methods inherited from interface org.cyclos.entities.ProcessableForProxying
getProxyClass

- Field Detail
  - file
```
protected DocumentFile file
```
    This really belongs to StaticDocument and UserDocument subclasses (getter and setter are there), but we put here to avoid an error in DocumentFile that need to reference the root Document class.
- Constructor Detail
  - Document
```
public Document()
```
- Method Detail
  - getDescription
```
public String getDescription()
```
  - getDiscriminator
```
public DocumentNature getDiscriminator()
```
  - getNature
```
public abstract DocumentNature getNature()
```
  - getNetwork
```
public Network getNetwork()
```
    Description copied from interface: HasNetwork
    
    Returns the network this entity belongs to
    
    Specified by:
    
    getNetwork in interface HasNetwork
  - isEnable
```
public boolean isEnable()
```
  - isHasFile
```
public abstract boolean isHasFile()
```
  - setDescription
```
public void setDescription(String description)
```
  - setEnable
```
public void setEnable(boolean enable)
```
  - setNetwork
```
public void setNetwork(Network network)
```
    Specified by:
    
    setNetwork in interface DefinesNetwork