org.neo4j.ogm.session

Interface Session

All Superinterfaces:

Capability.Delete, Capability.ExecuteQueries, Capability.GraphId, Capability.LoadByIds, Capability.LoadByInstances, Capability.LoadByType, Capability.LoadOne, Capability.Save, Capability.Transactions, Observer

All Known Implementing Classes:

Neo4jSession

public interface Session
extends Observer, Capability.LoadOne, Capability.LoadByIds, Capability.LoadByInstances, Capability.LoadByType, Capability.Save, Capability.Delete, Capability.Transactions, Capability.ExecuteQueries, Capability.GraphId

A Session serves as the main point of integration for the Neo4j OGM. All the publicly-available capabilities of the framework are defined by this interface.

Author:

Vince Bickers, Luanne Misquitta, Mark Angrish

See Also:

SessionFactory

Method Summary

Methods

Modifier and Type	Method and Description
String	getLastBookmark() Retrieves the last bookmark used in this session when used in a Neo4j Causal Cluster.
void	withBookmark(String bookmark) Sets the bookmark to use on this session.

Methods inherited from interface org.neo4j.ogm.session.event.Observer

dispose, eventsEnabled, notifyListeners, register

Methods inherited from interface org.neo4j.ogm.session.Capability.LoadOne

load, load

Methods inherited from interface org.neo4j.ogm.session.Capability.LoadByIds

loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll

Methods inherited from interface org.neo4j.ogm.session.Capability.LoadByInstances

loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll

Methods inherited from interface org.neo4j.ogm.session.Capability.LoadByType

loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll, loadAll

Methods inherited from interface org.neo4j.ogm.session.Capability.Save

save, save

Methods inherited from interface org.neo4j.ogm.session.Capability.Delete

clear, delete, delete, deleteAll, purgeDatabase

Methods inherited from interface org.neo4j.ogm.session.Capability.Transactions

beginTransaction, beginTransaction, doInTransaction, getTransaction

Methods inherited from interface org.neo4j.ogm.session.Capability.ExecuteQueries

count, countEntitiesOfType, query, query, query, queryForObject

Methods inherited from interface org.neo4j.ogm.session.Capability.GraphId

detachNodeEntity, detachRelationshipEntity, resolveGraphIdFor

Method Detail

getLastBookmark

String getLastBookmark()

Retrieves the last bookmark used in this session when used in a Neo4j Causal Cluster. This bookmark can be used to ensure the cluster is consistent before performing a read/write.

Returns:

The last used bookmark String on this session.

withBookmark

void withBookmark(String bookmark)

Sets the bookmark to use on this session. Useful when resuming a user session with a causal cluster.

Parameters:

bookmark - The last used bookmark String that this session should start from.