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

All Superinterfaces:

IAdaptable, JpaContextNode, JpaNode, JptResourceTypeReference, Model

All Known Subinterfaces:

JavaOrderable2_0, Orderable2_0, 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

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String	CUSTOM_ORDERING_PROPERTY
static String	NO_ORDERING_PROPERTY
static String	PK_ORDERING_PROPERTY
static String	SPECIFIED_ORDER_BY_PROPERTY

Fields inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

RESOURCE_TYPE_TRANSFORMER

Method Summary

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

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

getCompletionProposals, getContextDefaultDbCatalog, getContextDefaultDbSchema, getContextDefaultDbSchemaContainer, getMappingFileRoot, getPersistenceUnit, getValidationTextRange, synchronizeWithResourceModel, update, validate

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

getJpaPlatform, getJpaProject, getJpaProjectManager, getResource, stateChanged

Methods inherited from interface org.eclipse.jpt.common.utility.model.Model

addChangeListener, addCollectionChangeListener, addListChangeListener, addPropertyChangeListener, addStateChangeListener, removeChangeListener, removeCollectionChangeListener, removeListChangeListener, removePropertyChangeListener, removeStateChangeListener

Methods inherited from interface org.eclipse.core.runtime.IAdaptable

getAdapter

Methods inherited from interface org.eclipse.jpt.common.core.JptResourceTypeReference

getResourceType

Field Detail

SPECIFIED_ORDER_BY_PROPERTY

static final String SPECIFIED_ORDER_BY_PROPERTY

See Also:

Constant Field Values

NO_ORDERING_PROPERTY

static final String NO_ORDERING_PROPERTY

See Also:

Constant Field Values

PK_ORDERING_PROPERTY

static final String PK_ORDERING_PROPERTY

See Also:

Constant Field Values

CUSTOM_ORDERING_PROPERTY

static final 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 JpaContextNode

Specified by:

getParent in interface JpaNode

getSpecifiedOrderBy

String getSpecifiedOrderBy()

setSpecifiedOrderBy

void setSpecifiedOrderBy(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)