org.datanucleus.store.scostore
Interface PersistableRelationStore

All Superinterfaces:

Store

public interface PersistableRelationStore
extends Store

Representation of the relation between two persistable objects. Provides the connectivity to the datastore allowing the relation to be managed separately. In an RDBMS sense, this is for an N-1 unidirectional join table relation, and represents the join table entry.

Method Summary

boolean	add(ObjectProvider sm1, ObjectProvider sm2) Method to add the relation between the provided objects.
boolean	remove(ObjectProvider sm1) Method to remove the relation from the provided object.
boolean	update(ObjectProvider sm1, ObjectProvider sm2) Method to update the relation for the first object to relate to the second object.

Methods inherited from interface org.datanucleus.store.scostore.Store

getStoreManager

Method Detail

add

boolean add(ObjectProvider sm1,
            ObjectProvider sm2)

Method to add the relation between the provided objects.

Parameters:

sm1 - Object 1 provider

sm2 - Object 2 provider

Returns:

Whether the relation was added

remove

boolean remove(ObjectProvider sm1)

Method to remove the relation from the provided object.

Parameters:

sm1 - Object 1 provider

Returns:

Whether the relation was removed

update

boolean update(ObjectProvider sm1,
               ObjectProvider sm2)

Method to update the relation for the first object to relate to the second object. This removes any previous relation from this object and replaces it with the new relation.

Parameters:

sm1 - Object 1 provider

sm2 - Object 2 provider

Returns:

Whether the relation was replaced