SharedDocument (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
        
        org.cyclos.entities.contentmanagement.SharedDocument

All Implemented Interfaces:

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

Direct Known Subclasses:

DynamicDocument, StaticDocument
```
@Entity
public abstract class SharedDocument
extends Document
implements IInternalNamedEntity
```
A Document of type Static

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

Field Summary
- Fields inherited from class org.cyclos.entities.contentmanagement.Document
  file

Constructor Summary

Constructors
Constructor Description

SharedDocument()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`DocumentCategory`	`getCategory()`
`DataTranslationType`	`getDataTranslationType()`	If this entity allows data translation, should return the translation type
`String`	`getInternalName()`
`void`	`setCategory(DocumentCategory category)`
`void`	`setInternalName(String internalName)`

Methods inherited from class org.cyclos.entities.contentmanagement.Document
getDescription, getDiscriminator, getNature, getNetwork, isEnable, isHasFile, setDescription, setEnable, setNetwork

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

Methods inherited from class org.cyclos.entities.BaseEntity
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.model.IInternalNamedEntity
matches

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

- Constructor Detail
  - SharedDocument
```
public SharedDocument()
```
- Method Detail
  - getCategory
```
public DocumentCategory getCategory()
```
  - getDataTranslationType
```
public DataTranslationType getDataTranslationType()
```
    Description copied from class: BaseEntity
    
    If this entity allows data translation, should return the translation type
    
    Overrides:
    
    getDataTranslationType in class BaseEntity
  - getInternalName
```
public String getInternalName()
```
    Specified by:
    
    getInternalName in interface IInternalNamedEntity
    
    Returns:
    
    the internal name.
  - setCategory
```
public void setCategory(DocumentCategory category)
```
  - setInternalName
```
public void setInternalName(String internalName)
```
    Specified by:
    
    setInternalName in interface IInternalNamedEntity
    
    Parameters:
    
    internalName - the internal name to be set.