org.eclipse.jpt.jpa.core.context
Interface Orderable

All Superinterfaces:

org.eclipse.core.runtime.IAdaptable, IResourcePart, JpaContextNode, JpaNode, Model

All Known Subinterfaces:

JavaOrderable, JavaOrderable2_0, Orderable2_0, OrmOrderable, OrmOrderable2_0

public interface Orderable
extends JpaContextNode

Multi-valued (1:m, m:m) relationship mappings support ordering.

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.3

Version:

2.3

Field Summary

static java.lang.String	CUSTOM_ORDERING_PROPERTY
static java.lang.String	NO_ORDERING_PROPERTY
static java.lang.String	PK_ORDERING_PROPERTY
static java.lang.String	SPECIFIED_ORDER_BY_PROPERTY

Method Summary

AttributeMapping	getParent() Return the JPA node's parent.
java.lang.String	getSpecifiedOrderBy()
boolean	isCustomOrdering()
boolean	isNoOrdering()
boolean	isPkOrdering()
void	setCustomOrdering(boolean customOrdering)
void	setNoOrdering(boolean noOrdering)
void	setPkOrdering(boolean pkOrdering)
void	setSpecifiedOrderBy(java.lang.String orderBy)

Methods inherited from interface org.eclipse.jpt.jpa.core.context.JpaContextNode

getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getResourceType, synchronizeWithResourceModel, update

Methods inherited from interface org.eclipse.jpt.jpa.core.JpaNode

getJpaProject, stateChanged

Methods inherited from interface org.eclipse.jpt.common.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.common.core.IResourcePart

getResource

Field Detail

SPECIFIED_ORDER_BY_PROPERTY

static final java.lang.String SPECIFIED_ORDER_BY_PROPERTY

See Also:

Constant Field Values

NO_ORDERING_PROPERTY

static final java.lang.String NO_ORDERING_PROPERTY

See Also:

Constant Field Values

PK_ORDERING_PROPERTY

static final java.lang.String PK_ORDERING_PROPERTY

See Also:

Constant Field Values

CUSTOM_ORDERING_PROPERTY

static final java.lang.String CUSTOM_ORDERING_PROPERTY

See Also:

Constant Field Values

Method Detail

getParent

AttributeMapping getParent()

Description copied from interface: JpaNode

Return the JPA node's parent. The JPA project will not have a parent.

Specified by:

getParent in interface JpaNode

getSpecifiedOrderBy

java.lang.String getSpecifiedOrderBy()

setSpecifiedOrderBy

void setSpecifiedOrderBy(java.lang.String orderBy)

isNoOrdering

boolean isNoOrdering()

setNoOrdering

void setNoOrdering(boolean noOrdering)

isPkOrdering

boolean isPkOrdering()

setPkOrdering

void setPkOrdering(boolean pkOrdering)

isCustomOrdering

boolean isCustomOrdering()

setCustomOrdering

void setCustomOrdering(boolean customOrdering)