Session (GORM for MongoDB

org.grails.datastore.mapping.query.QueryCreator

All Superinterfaces:

QueryCreator
```
@java.lang.SuppressWarnings("rawtypes")
public interface Session
extends QueryCreator
```
The Session represents the active interaction with a datastore.
Authors:
Graeme Rocher
Guillaume Laforge
Since:
1.0

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public void`	`attach(java.lang.Object o)` Attaches an object the current session
	`public Transaction`	`beginTransaction()` Starts a transaction
	`public Transaction`	`beginTransaction(org.springframework.transaction.TransactionDefinition definition)` Starts a transaction
	`public void`	`clear()` Clears any pending changes to the datastore
	`public void`	`clear(java.lang.Object o)` Clear a specific object
	`public java.lang.Object`	`clearSessionProperty(java.lang.String property)` Clear a property in a session.
	`public boolean`	`contains(java.lang.Object o)` Whether the object is contained within the first level cache
	`public Query`	`createQuery(java.lang.Class type)` Creates a query instance for the give type
	`public void`	`delete(java.lang.Iterable objects)` Deletes one or many objects
	`public void`	`delete(java.lang.Object obj)` Deletes a single object
	`public long`	`deleteAll(QueryableCriteria criteria)` Deletes all objects matching the given criteria
	`public void`	`disconnect()` Disconnects from the datastore.
	`public void`	`flush()` Flushes any pending changes to the datastore
	`public java.lang.Object`	`getAttribute(java.lang.Object entity, java.lang.String attributeName)` Obtains an attribute for the given entity
	`public Datastore`	`getDatastore()` The Datastore that created this Session
	`public javax.persistence.FlushModeType`	`getFlushMode()` Obtains the current FlushModeType
	`public MappingContext`	`getMappingContext()` Obtains the MappingContext instance
	`public java.lang.Object`	`getNativeInterface()` Returns: The native interface to the datastore
	`public java.io.Serializable`	`getObjectIdentifier(java.lang.Object instance)` Obtains the identifier for the instance
	`public Persister`	`getPersister(java.lang.Object o)` The persister for the given object
	`public java.lang.Object`	`getSessionProperty(java.lang.String property)` Get the value of a property of the session.
	`public Transaction`	`getTransaction()` Obtains the current transaction instance
	`public boolean`	`hasTransaction()` Returns: Whether the current session has an active transaction
	`public java.io.Serializable`	`insert(java.lang.Object o)` Forces an insert
	`public boolean`	`isConnected()` Returns: `true` if connected to the datastore
	`public boolean`	`isDirty(java.lang.Object instance)` Check if the instance has been modified since loading.
	`public void`	`lock(java.lang.Object o)` Obtains a write lock on the given object
`<T>`	`public T`	`lock(java.lang.Class<T> type, java.io.Serializable key)` Retrieves an individual object, using a write lock to prevent loss of updates
	`public java.io.Serializable`	`persist(java.lang.Object o)` Stores and object and returns its key
	`public java.util.List<java.io.Serializable>`	`persist(java.lang.Iterable objects)` Persists several objects returning their identifiers in the order specified by the Iterable
`<T>`	`public T`	`proxy(java.lang.Class<T> type, java.io.Serializable key)` Retrieves a proxy for the given key
	`public void`	`refresh(java.lang.Object o)` Refreshes the given objects state
`<T>`	`public T`	`retrieve(java.lang.Class<T> type, java.io.Serializable key)` Retrieves an individual object
	`public java.util.List`	`retrieveAll(java.lang.Class type, java.lang.Iterable keys)` Retrieves several objects for the specified keys
	`public java.util.List`	`retrieveAll(java.lang.Class type, java.io.Serializable keys)` Retrieves several objects for the specified keys
	`public void`	`setAttribute(java.lang.Object entity, java.lang.String attributeName, java.lang.Object value)` Associates an attribute with the given persistent entity.
	`public void`	`setFlushMode(javax.persistence.FlushModeType flushMode)` The flush mode, defaults to FlushModeType.COMMIT
	`public java.lang.Object`	`setSessionProperty(java.lang.String property, java.lang.Object value)` Set a property on this session.
	`public void`	`setSynchronizedWithTransaction(boolean synchronizedWithTransaction)` Whether the session is synchronized with a transaction
	`public void`	`unlock(java.lang.Object o)` Releases a lock, if not called all locked objects should be released by disconnect()
	`public long`	`updateAll(QueryableCriteria criteria, java.util.Map<java.lang.String, java.lang.Object> properties)` Updates all objects matching the given criteria and property values

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`interface QueryCreator`	`createQuery, isSchemaless`

- Method Detail
  - public void attach(java.lang.Object o)
    
    Attaches an object the current session
    Parameters:
    o - The object to attach
  - public Transaction beginTransaction()
    
    Starts a transaction
    Returns:
    The transaction
  - public Transaction beginTransaction(org.springframework.transaction.TransactionDefinition definition)
    
    Starts a transaction
    Returns:
    The transaction
  - public void clear()
    
    Clears any pending changes to the datastore
  - public void clear(java.lang.Object o)
    
    Clear a specific object
    Parameters:
    o - The object to clear
  - public java.lang.Object clearSessionProperty(java.lang.String property)
    
    Clear a property in a session.
    Parameters:
    property - The property name.
    Returns:
    The property value, if there was one (or null).
  - public boolean contains(java.lang.Object o)
    
    Whether the object is contained within the first level cache
    Parameters:
    o - The object to check
    Returns:
    true if it is
  - public Query createQuery(java.lang.Class type)
    
    Creates a query instance for the give type
    Parameters:
    type - The type
    Returns:
    The query
  - public void delete(java.lang.Iterable objects)
    
    Deletes one or many objects
    Parameters:
    objects - The objects to delete
  - public void delete(java.lang.Object obj)
    
    Deletes a single object
    Parameters:
    obj - The object to delete
  - public long deleteAll(QueryableCriteria criteria)
    
    Deletes all objects matching the given criteria
    Parameters:
    criteria - The criteria
    Returns:
    The total number of records deleted
  - public void disconnect()
    
    Disconnects from the datastore.
  - public void flush()
    
    Flushes any pending changes to the datastore
  - public java.lang.Object getAttribute(java.lang.Object entity, java.lang.String attributeName)
    
    Obtains an attribute for the given entity
    Parameters:
    entity - The entity
    attributeName - The attribute
    Returns:
    The attribute value
  - public Datastore getDatastore()
    
    The Datastore that created this Session
    Returns:
    The Datastore instance
  - public javax.persistence.FlushModeType getFlushMode()
    
    Obtains the current FlushModeType
    Returns:
    The FlushModeType instance
  - public MappingContext getMappingContext()
    
    Obtains the MappingContext instance
    Returns:
    The MappingContext
  - public java.lang.Object getNativeInterface()
    
    Returns:
    The native interface to the datastore
  - public java.io.Serializable getObjectIdentifier(java.lang.Object instance)
    
    Obtains the identifier for the instance
    Parameters:
    instance - The instance
    Returns:
    The identifier or null if it cannot be established
  - public Persister getPersister(java.lang.Object o)
    
    The persister for the given object
    Parameters:
    o - The object
    Returns:
    The persister
  - public java.lang.Object getSessionProperty(java.lang.String property)
    
    Get the value of a property of the session.
    Parameters:
    property - The name of the property.
    Returns:
    The value.
  - public Transaction getTransaction()
    
    Obtains the current transaction instance
    Returns:
    The Transaction instance
  - public boolean hasTransaction()
    
    Returns:
    Whether the current session has an active transaction
  - public java.io.Serializable insert(java.lang.Object o)
    
    Forces an insert
    Parameters:
    o - The object
    Returns:
    The id
  - public boolean isConnected()
    
    Returns:
    true if connected to the datastore
  - public boolean isDirty(java.lang.Object instance)
    
    Check if the instance has been modified since loading.
    Parameters:
    instance - the instance
    Returns:
    true if one or more fields have changed
  - public void lock(java.lang.Object o)
    
    Obtains a write lock on the given object
    Parameters:
    o - The object to lock
  - <T> public T lock(java.lang.Class<T> type, java.io.Serializable key)
    
    Retrieves an individual object, using a write lock to prevent loss of updates
    Parameters:
    type - The type
    key - The key
    Returns:
    The object
  - public java.io.Serializable persist(java.lang.Object o)
    
    Stores and object and returns its key
    Parameters:
    o - The object
    Returns:
    The the generated key
  - public java.util.List<java.io.Serializable> persist(java.lang.Iterable objects)
    
    Persists several objects returning their identifiers in the order specified by the Iterable
    Parameters:
    objects - The Objects
    Returns:
    The identifiers
  - <T> public T proxy(java.lang.Class<T> type, java.io.Serializable key)
    
    Retrieves a proxy for the given key
    Parameters:
    type - The type
    key - The key
    Returns:
    The object
  - public void refresh(java.lang.Object o)
    
    Refreshes the given objects state
    Parameters:
    o - The object to refresh
  - <T> public T retrieve(java.lang.Class<T> type, java.io.Serializable key)
    
    Retrieves an individual object
    Parameters:
    type - The type
    key - The key
    Returns:
    The object
  - public java.util.List retrieveAll(java.lang.Class type, java.lang.Iterable keys)
    
    Retrieves several objects for the specified keys
    Parameters:
    type - The type
    keys - The keys
    Returns:
    A list of objects
  - public java.util.List retrieveAll(java.lang.Class type, java.io.Serializable keys)
    
    Retrieves several objects for the specified keys
    Parameters:
    type - The type
    keys - The keys
    Returns:
    A list of objects
  - public void setAttribute(java.lang.Object entity, java.lang.String attributeName, java.lang.Object value)
    
    Associates an attribute with the given persistent entity. Attributes will be cleared out when the Session is closed or cleared.
    Parameters:
    entity - The persistent instance (must be associated with this Session)
    attributeName - The attribute name
    value - The value
  - public void setFlushMode(javax.persistence.FlushModeType flushMode)
    
    The flush mode, defaults to FlushModeType.COMMIT
    Parameters:
    flushMode - The FlushModeType
  - public java.lang.Object setSessionProperty(java.lang.String property, java.lang.Object value)
    
    Set a property on this session. Note that properties are not cleared out when a session is cleared.
    Parameters:
    property - The property name.
    value - The property value.
    Returns:
    The previous property value, if there was one (or null).
  - public void setSynchronizedWithTransaction(boolean synchronizedWithTransaction)
    
    Whether the session is synchronized with a transaction
    Parameters:
    synchronizedWithTransaction - True if it is
  - public void unlock(java.lang.Object o)
    
    Releases a lock, if not called all locked objects should be released by disconnect()
    Parameters:
    o - The object to unlock
  - public long updateAll(QueryableCriteria criteria, java.util.Map<java.lang.String, java.lang.Object> properties)
    
    Updates all objects matching the given criteria and property values
    Parameters:
    criteria - The criteria
    properties - The properties
    Returns:
    The total number of records updated

Summary:
Method

| Detail:
Method

Groovy Documentation

[Java] Interface Session

Methods Summary

Inherited Methods Summary

Method Detail

public void attach(java.lang.Object o)

public Transaction beginTransaction()

public Transaction beginTransaction(org.springframework.transaction.TransactionDefinition definition)

public void clear()

public void clear(java.lang.Object o)

public java.lang.Object clearSessionProperty(java.lang.String property)

public boolean contains(java.lang.Object o)

public Query createQuery(java.lang.Class type)

public void delete(java.lang.Iterable objects)

public void delete(java.lang.Object obj)

public long deleteAll(QueryableCriteria criteria)

public void disconnect()

public void flush()

public java.lang.Object getAttribute(java.lang.Object entity, java.lang.String attributeName)

public Datastore getDatastore()

public javax.persistence.FlushModeType getFlushMode()

public MappingContext getMappingContext()

public java.lang.Object getNativeInterface()

public java.io.Serializable getObjectIdentifier(java.lang.Object instance)

public Persister getPersister(java.lang.Object o)

public java.lang.Object getSessionProperty(java.lang.String property)

public Transaction getTransaction()

public boolean hasTransaction()

public java.io.Serializable insert(java.lang.Object o)

public boolean isConnected()

public boolean isDirty(java.lang.Object instance)

public void lock(java.lang.Object o)

<T> public T lock(java.lang.Class<T> type, java.io.Serializable key)

public java.io.Serializable persist(java.lang.Object o)

public java.util.List<java.io.Serializable> persist(java.lang.Iterable objects)

<T> public T proxy(java.lang.Class<T> type, java.io.Serializable key)

public void refresh(java.lang.Object o)

<T> public T retrieve(java.lang.Class<T> type, java.io.Serializable key)

public java.util.List retrieveAll(java.lang.Class type, java.lang.Iterable keys)

public java.util.List retrieveAll(java.lang.Class type, java.io.Serializable keys)

public void setAttribute(java.lang.Object entity, java.lang.String attributeName, java.lang.Object value)

public void setFlushMode(javax.persistence.FlushModeType flushMode)

public java.lang.Object setSessionProperty(java.lang.String property, java.lang.Object value)

public void setSynchronizedWithTransaction(boolean synchronizedWithTransaction)

public void unlock(java.lang.Object o)

public long updateAll(QueryableCriteria criteria, java.util.Map<java.lang.String, java.lang.Object> properties)