.. java:import:: java.util HashMap

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

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

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

RetrieveContainer
=================

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

.. java:type:: public class RetrieveContainer extends TransactionContainer

   A container of entities which are about to be retrieved.

   A suitable name would also be `ReadOnlyEntitiesContainer` because entities in this container will only be retrieved, not changed, inserted or deleted.

   Because all entities are expected to be existing, all entities can theoretically be identified via their (valid) entity id (plus version id, if applicable).

   However, sometimes, entities are being retrieved via the name instead of the id. Then the id has to be resolved first. This happens during the init stage of the owning transaction.

   The container also holds the flags of the current transaction (e.g. cache=false, ACL=true, ...).

   :author: Timm Fitschen

Constructors
------------
RetrieveContainer
^^^^^^^^^^^^^^^^^

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

Methods
-------
add
^^^

.. java:method:: public void add(EntityID id, String version)
   :outertype: RetrieveContainer

add
^^^

.. java:method:: public void add(EntityID id, String name, String version)
   :outertype: RetrieveContainer