.. java:import:: java.util List

.. java:import:: org.apache.shiro.authz Permission

.. java:import:: org.apache.shiro.subject Subject

.. java:import:: org.caosdb.server.database.proto SparseEntity

.. java:import:: org.caosdb.server.database.proto VerySparseEntity

.. java:import:: org.caosdb.server.datatype AbstractDatatype

.. java:import:: org.caosdb.server.datatype Value

.. java:import:: org.caosdb.server.entity.container ParentContainer

.. java:import:: org.caosdb.server.entity.container PropertyContainer

.. java:import:: org.caosdb.server.entity.wrapper Parent

.. java:import:: org.caosdb.server.entity.wrapper Property

.. java:import:: org.caosdb.server.entity.xml SerializeFieldStrategy

.. java:import:: org.caosdb.server.entity.xml ToElementable

.. java:import:: org.caosdb.server.jobs JobTarget

.. java:import:: org.caosdb.server.permissions EntityACL

.. java:import:: org.caosdb.server.utils Observable

.. java:import:: org.caosdb.server.utils TransactionLogMessage

.. java:import:: org.caosdb.unit Unit

.. java:import:: org.jdom2 Element

EntityInterface
===============

.. java:package:: org.caosdb.server.entity
   :noindex:

.. java:type:: public interface EntityInterface extends JobTarget, Observable, ToElementable, WriteEntity, TransactionEntity

Methods
-------
addParent
^^^^^^^^^

.. java:method:: public abstract void addParent(Parent parent)
   :outertype: EntityInterface

addProperty
^^^^^^^^^^^

.. java:method:: public abstract void addProperty(Property property)
   :outertype: EntityInterface

addProperty
^^^^^^^^^^^

.. java:method:: public abstract void addProperty(List<Property> properties)
   :outertype: EntityInterface

addToElement
^^^^^^^^^^^^

.. java:method:: public abstract void addToElement(Element element, SerializeFieldStrategy strategy)
   :outertype: EntityInterface

addTransactionLog
^^^^^^^^^^^^^^^^^

.. java:method:: public abstract void addTransactionLog(TransactionLogMessage transactionLogMessage)
   :outertype: EntityInterface

checkPermission
^^^^^^^^^^^^^^^

.. java:method:: public abstract void checkPermission(Subject subject, Permission permission)
   :outertype: EntityInterface

checkPermission
^^^^^^^^^^^^^^^

.. java:method:: public abstract void checkPermission(Permission permission)
   :outertype: EntityInterface

getDatatype
^^^^^^^^^^^

.. java:method:: public abstract AbstractDatatype getDatatype()
   :outertype: EntityInterface

getDescription
^^^^^^^^^^^^^^

.. java:method:: public abstract String getDescription()
   :outertype: EntityInterface

getDomain
^^^^^^^^^

.. java:method:: public abstract EntityID getDomain()
   :outertype: EntityInterface

getEntityACL
^^^^^^^^^^^^

.. java:method:: public abstract EntityACL getEntityACL()
   :outertype: EntityInterface

getFileProperties
^^^^^^^^^^^^^^^^^

.. java:method:: public abstract FileProperties getFileProperties()
   :outertype: EntityInterface

getId
^^^^^

.. java:method:: public abstract EntityID getId()
   :outertype: EntityInterface

getIdVersion
^^^^^^^^^^^^

.. java:method:: public abstract String getIdVersion()
   :outertype: EntityInterface

getName
^^^^^^^

.. java:method:: public abstract String getName()
   :outertype: EntityInterface

getParents
^^^^^^^^^^

.. java:method:: public abstract ParentContainer getParents()
   :outertype: EntityInterface

getProperties
^^^^^^^^^^^^^

.. java:method:: public abstract PropertyContainer getProperties()
   :outertype: EntityInterface

getQueryTemplateDefinition
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract String getQueryTemplateDefinition()
   :outertype: EntityInterface

getRole
^^^^^^^

.. java:method:: public abstract Role getRole()
   :outertype: EntityInterface

getSerializeFieldStrategy
^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract SerializeFieldStrategy getSerializeFieldStrategy()
   :outertype: EntityInterface

getSparseEntity
^^^^^^^^^^^^^^^

.. java:method:: public abstract SparseEntity getSparseEntity()
   :outertype: EntityInterface

getStatementStatus
^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract StatementStatusInterface getStatementStatus()
   :outertype: EntityInterface

getTransactionLogMessages
^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract List<TransactionLogMessage> getTransactionLogMessages()
   :outertype: EntityInterface

getUnit
^^^^^^^

.. java:method:: public abstract Unit getUnit()
   :outertype: EntityInterface

getValue
^^^^^^^^

.. java:method:: public abstract Value getValue()
   :outertype: EntityInterface

getVersion
^^^^^^^^^^

.. java:method:: public abstract Version getVersion()
   :outertype: EntityInterface

getVerySparseEntity
^^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract VerySparseEntity getVerySparseEntity()
   :outertype: EntityInterface

hasDatatype
^^^^^^^^^^^

.. java:method:: public abstract boolean hasDatatype()
   :outertype: EntityInterface

hasDescription
^^^^^^^^^^^^^^

.. java:method:: public abstract boolean hasDescription()
   :outertype: EntityInterface

hasEntityACL
^^^^^^^^^^^^

.. java:method:: public abstract boolean hasEntityACL()
   :outertype: EntityInterface

hasFileProperties
^^^^^^^^^^^^^^^^^

.. java:method:: public abstract boolean hasFileProperties()
   :outertype: EntityInterface

hasId
^^^^^

.. java:method:: public abstract boolean hasId()
   :outertype: EntityInterface

hasName
^^^^^^^

.. java:method:: public abstract boolean hasName()
   :outertype: EntityInterface

hasParents
^^^^^^^^^^

.. java:method:: public abstract boolean hasParents()
   :outertype: EntityInterface

hasPermission
^^^^^^^^^^^^^

.. java:method:: public abstract boolean hasPermission(Permission permission)
   :outertype: EntityInterface

   Return true iff the current thread's subject has a permission.

hasPermission
^^^^^^^^^^^^^

.. java:method:: public abstract boolean hasPermission(Subject subject, Permission permission)
   :outertype: EntityInterface

   Return true iff the given subject has a permission.

hasProperties
^^^^^^^^^^^^^

.. java:method:: public abstract boolean hasProperties()
   :outertype: EntityInterface

hasRole
^^^^^^^

.. java:method:: public abstract boolean hasRole()
   :outertype: EntityInterface

hasStatementStatus
^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract boolean hasStatementStatus()
   :outertype: EntityInterface

hasTransactionLogMessages
^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract boolean hasTransactionLogMessages()
   :outertype: EntityInterface

hasUnit
^^^^^^^

.. java:method:: public abstract boolean hasUnit()
   :outertype: EntityInterface

hasValue
^^^^^^^^

.. java:method:: public abstract boolean hasValue()
   :outertype: EntityInterface

hasVersion
^^^^^^^^^^

.. java:method:: public abstract boolean hasVersion()
   :outertype: EntityInterface

isDatatypeOverride
^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract boolean isDatatypeOverride()
   :outertype: EntityInterface

isDescOverride
^^^^^^^^^^^^^^

.. java:method:: public abstract boolean isDescOverride()
   :outertype: EntityInterface

isNameOverride
^^^^^^^^^^^^^^

.. java:method:: public abstract boolean isNameOverride()
   :outertype: EntityInterface

isReference
^^^^^^^^^^^

.. java:method:: public abstract boolean isReference()
   :outertype: EntityInterface

   Return true iff the data type is present and is an instance of ReferenceDatatype.

isReferenceList
^^^^^^^^^^^^^^^

.. java:method:: public abstract boolean isReferenceList()
   :outertype: EntityInterface

   Return true iff the data type is present, an instance of AbstractCollectionDatatype and the AbstractCollectionDatatype's elements' data type is an instance of ReferenceDatatype.

linkIdToEntity
^^^^^^^^^^^^^^

.. java:method:: public abstract EntityInterface linkIdToEntity(EntityInterface link)
   :outertype: EntityInterface

parseSparseEntity
^^^^^^^^^^^^^^^^^

.. java:method:: public abstract EntityInterface parseSparseEntity(SparseEntity spe)
   :outertype: EntityInterface

parseValue
^^^^^^^^^^

.. java:method:: public abstract void parseValue() throws Message
   :outertype: EntityInterface

setDatatype
^^^^^^^^^^^

.. java:method:: public abstract void setDatatype(AbstractDatatype datatype)
   :outertype: EntityInterface

setDatatype
^^^^^^^^^^^

.. java:method:: public abstract void setDatatype(String datatype)
   :outertype: EntityInterface

setDatatypeOverride
^^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract EntityInterface setDatatypeOverride(boolean b)
   :outertype: EntityInterface

setDescOverride
^^^^^^^^^^^^^^^

.. java:method:: public abstract EntityInterface setDescOverride(boolean b)
   :outertype: EntityInterface

setDescription
^^^^^^^^^^^^^^

.. java:method:: public abstract void setDescription(String description)
   :outertype: EntityInterface

setEntityACL
^^^^^^^^^^^^

.. java:method:: public abstract void setEntityACL(EntityACL acl)
   :outertype: EntityInterface

setFileProperties
^^^^^^^^^^^^^^^^^

.. java:method:: public abstract void setFileProperties(FileProperties fileProperties)
   :outertype: EntityInterface

setId
^^^^^

.. java:method:: public abstract void setId(EntityID id)
   :outertype: EntityInterface

setId
^^^^^

.. java:method:: public void setId(String id)
   :outertype: EntityInterface

setName
^^^^^^^

.. java:method:: public abstract void setName(String name)
   :outertype: EntityInterface

setNameOverride
^^^^^^^^^^^^^^^

.. java:method:: public abstract EntityInterface setNameOverride(boolean b)
   :outertype: EntityInterface

setProperties
^^^^^^^^^^^^^

.. java:method:: public abstract void setProperties(PropertyContainer properties)
   :outertype: EntityInterface

setQueryTemplateDefinition
^^^^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract void setQueryTemplateDefinition(String query)
   :outertype: EntityInterface

setRole
^^^^^^^

.. java:method:: public abstract void setRole(Role role)
   :outertype: EntityInterface

setRole
^^^^^^^

.. java:method:: public abstract void setRole(String role) throws IllegalArgumentException
   :outertype: EntityInterface

setStatementStatus
^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract void setStatementStatus(StatementStatusInterface statementStatus)
   :outertype: EntityInterface

setStatementStatus
^^^^^^^^^^^^^^^^^^

.. java:method:: public abstract void setStatementStatus(String statementStatus)
   :outertype: EntityInterface

setUnit
^^^^^^^

.. java:method:: public abstract void setUnit(Unit unit)
   :outertype: EntityInterface

setValue
^^^^^^^^

.. java:method:: public abstract void setValue(Value value)
   :outertype: EntityInterface

setVersion
^^^^^^^^^^

.. java:method:: public abstract void setVersion(Version version)
   :outertype: EntityInterface

toString
^^^^^^^^

.. java:method:: @Override public abstract String toString()
   :outertype: EntityInterface