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

All Superinterfaces:

IAdaptable, JpaContextModel, JpaModel, JptResourceTypeReference, Model

public interface OrderBy
extends JpaContextModel

For primary key or specified other key 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:

3.4

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jpt.jpa.core.JpaModel

JpaModel.JpaVersionIsCompatibleWith

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

JptResourceTypeReference.ResourceTypeIsKindOf, JptResourceTypeReference.ResourceTypeTransformer

Field Summary

static String

KEY_PROPERTY String associated with changes to the "key" property

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

TRANSFORMER

Method Summary

String	getKey() A value of null indicates that ordering is by primary key (see isByPrimaryKey())
boolean	isByPrimaryKey() Return if ordering is by primary key.
void	setKey(String newKey) Set to null to indicate ordering by primary key

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

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

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

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

KEY_PROPERTY

static final String KEY_PROPERTY

String associated with changes to the "key" property

See Also:

Constant Field Values

Method Detail

getKey

String getKey()

A value of null indicates that ordering is by primary key (see isByPrimaryKey())

setKey

void setKey(String newKey)

Set to null to indicate ordering by primary key

isByPrimaryKey

boolean isByPrimaryKey()

Return if ordering is by primary key. (see getKey()