org.eclipse.jpt.core.context
Interface OwnableRelationshipReference

All Superinterfaces:
org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model, RelationshipReference
All Known Subinterfaces:
EclipseLinkOneToManyRelationshipReference, EclipseLinkOneToManyRelationshipReference2_0, JavaManyToManyRelationshipReference, JavaOneToManyRelationshipReference, JavaOneToManyRelationshipReference2_0, JavaOneToOneRelationshipReference, JavaOneToOneRelationshipReference2_0, JavaOwnableRelationshipReference, ManyToManyRelationshipReference, OneToManyRelationshipReference, OneToManyRelationshipReference2_0, OneToOneRelationshipReference, OneToOneRelationshipReference2_0, OrmManyToManyRelationshipReference, OrmOneToManyRelationshipReference, OrmOneToManyRelationshipReference2_0, OrmOneToOneRelationshipReference, OrmOneToOneRelationshipReference2_0, OrmOwnableRelationshipReference

public interface OwnableRelationshipReference
extends RelationshipReference

An OwnableRelationshipReference is a type of RelationshipReference that may be the owned side of the relationship. (i.e. It may use a "mappedBy" joining strategy.)

Provisional API: This interface is part of an interim API that is still under development and expected to change significantly before reaching stability. It is available at this early stage to solicit feedback from pioneering adopters on the understanding that any code that uses this API will almost certainly be broken (repeatedly) as the API evolves.

Since:
2.2
Version:
2.2
See Also:
RelationshipMapping, RelationshipReference

Field Summary
 
Fields inherited from interface org.eclipse.jpt.core.context.RelationshipReference
PREDOMINANT_JOINING_STRATEGY_PROPERTY
 
Method Summary
 MappedByJoiningStrategy getMappedByJoiningStrategy()
          Return the aggregate (never null) object used to configure the mapped by joining strategy
 boolean mayBeMappedBy(AttributeMapping mapping)
          Validates whether the given mapping may own the relationship
 void setMappedByJoiningStrategy()
          Set the mapped by joining strategy as the predominant joining strategy
 void unsetMappedByJoiningStrategy()
          Unset the mapped by joining strategy as the predominant joining strategy.
 boolean usesMappedByJoiningStrategy()
          Return whether the mapped by joining strategy is currently the predominant joining strategy
 
Methods inherited from interface org.eclipse.jpt.core.context.RelationshipReference
getEntity, getPredominantJoiningStrategy, getRelationshipMapping, getTypeMapping, isOverridableAssociation, isOwnedBy, isParentVirtual, isRelationshipOwner, isTargetForeignKeyRelationship
 
Methods inherited from interface org.eclipse.jpt.core.context.JpaContextNode
getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, postUpdate
 
Methods inherited from interface org.eclipse.jpt.core.JpaNode
getJpaProject, getParent
 
Methods inherited from interface org.eclipse.jpt.utility.model.Model
addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, addTreeChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener, removeTreeChangeListener
 
Methods inherited from interface org.eclipse.core.runtime.IAdaptable
getAdapter
 
Methods inherited from interface org.eclipse.jpt.core.IResourcePart
getResource
 

Method Detail

getMappedByJoiningStrategy

MappedByJoiningStrategy getMappedByJoiningStrategy()
Return the aggregate (never null) object used to configure the mapped by joining strategy


usesMappedByJoiningStrategy

boolean usesMappedByJoiningStrategy()
Return whether the mapped by joining strategy is currently the predominant joining strategy


setMappedByJoiningStrategy

void setMappedByJoiningStrategy()
Set the mapped by joining strategy as the predominant joining strategy


unsetMappedByJoiningStrategy

void unsetMappedByJoiningStrategy()
Unset the mapped by joining strategy as the predominant joining strategy. This will not set any other joining strategy as the predominant one, so whichever one is also being used (is specified) or the default strategy will apply at that point.


mayBeMappedBy

boolean mayBeMappedBy(AttributeMapping mapping)
Validates whether the given mapping may own the relationship