.. java:import:: java.util HashMap

.. java:import:: java.util LinkedList

.. java:import:: java.util List

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

.. java:import:: org.caosdb.server CaosDBServer

.. java:import:: org.caosdb.server.database.misc TransactionBenchmark

.. java:import:: org.caosdb.server.entity EntityInterface

.. java:import:: org.caosdb.server.entity FileProperties

.. java:import:: org.caosdb.server.entity Message

.. java:import:: org.caosdb.server.entity Message.MessageType

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

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

.. java:import:: org.caosdb.server.query Query

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

.. java:import:: org.jdom2 Element

TransactionContainer
====================

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

.. java:type:: public class TransactionContainer extends Container<EntityInterface> implements ToElementable, JobTarget

   Base class for transaction containers used by classes such as \ :java:ref:`RetrieveContainer`\  or \ :java:ref:`WritableContainer`\ .

   :author: Timm Fitschen

Constructors
------------
TransactionContainer
^^^^^^^^^^^^^^^^^^^^

.. java:constructor:: public TransactionContainer()
   :outertype: TransactionContainer

TransactionContainer
^^^^^^^^^^^^^^^^^^^^

.. java:constructor:: public TransactionContainer(Subject owner, Long timestamp, String requestId)
   :outertype: TransactionContainer

TransactionContainer
^^^^^^^^^^^^^^^^^^^^

.. java:constructor:: public TransactionContainer(Subject user, Long timestamp, String srid, HashMap<String, String> flags)
   :outertype: TransactionContainer

Methods
-------
addError
^^^^^^^^

.. java:method:: @Override public void addError(Message m)
   :outertype: TransactionContainer

addFile
^^^^^^^

.. java:method:: public void addFile(String name, FileProperties file)
   :outertype: TransactionContainer

addMessage
^^^^^^^^^^

.. java:method:: public void addMessage(ToElementable m)
   :outertype: TransactionContainer

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

.. java:method:: @Override public void addToElement(Element element)
   :outertype: TransactionContainer

   :param element:
   :return: Add List of Elements which represent the contained Entities to an predefined element.

getEntityByName
^^^^^^^^^^^^^^^

.. java:method:: public EntityInterface getEntityByName(String name)
   :outertype: TransactionContainer

   Get the first entity from this container which has this name.

   Return null if no matching is in this container.

   :param name:

getFiles
^^^^^^^^

.. java:method:: public HashMap<String, FileProperties> getFiles()
   :outertype: TransactionContainer

getFlags
^^^^^^^^

.. java:method:: public HashMap<String, String> getFlags()
   :outertype: TransactionContainer

getMessages
^^^^^^^^^^^

.. java:method:: public List<ToElementable> getMessages()
   :outertype: TransactionContainer

getOwner
^^^^^^^^

.. java:method:: public Subject getOwner()
   :outertype: TransactionContainer

getQuery
^^^^^^^^

.. java:method:: public Query getQuery()
   :outertype: TransactionContainer

getRequestId
^^^^^^^^^^^^

.. java:method:: public String getRequestId()
   :outertype: TransactionContainer

getStatus
^^^^^^^^^

.. java:method:: public EntityStatus getStatus()
   :outertype: TransactionContainer

getTimestamp
^^^^^^^^^^^^

.. java:method:: public Long getTimestamp()
   :outertype: TransactionContainer

getTransactionBenchmark
^^^^^^^^^^^^^^^^^^^^^^^

.. java:method:: public TransactionBenchmark getTransactionBenchmark()
   :outertype: TransactionContainer

setFiles
^^^^^^^^

.. java:method:: public void setFiles(HashMap<String, FileProperties> files)
   :outertype: TransactionContainer

setFlags
^^^^^^^^

.. java:method:: public void setFlags(HashMap<String, String> flags)
   :outertype: TransactionContainer

setQuery
^^^^^^^^

.. java:method:: public void setQuery(Query query)
   :outertype: TransactionContainer

setStatus
^^^^^^^^^

.. java:method:: public void setStatus(EntityStatus status)
   :outertype: TransactionContainer

skipJob
^^^^^^^

.. java:method:: @Override public boolean skipJob()
   :outertype: TransactionContainer