ERecSortKey(String relRankModule)
Create a new relevance rank key that specifies a sort using
a relevance ranking module.

ERecSortKey(String propertyName,
boolean isAscending)
Create a new alpha-numeric sort key that specifies a sort
on a property and the order with which to sort with regard
to that property.

ERecSortKey(String propertyName,
boolean isAscending,
double latitude,
double longitude)
Create a new geocode sort key that specifies a sort on a
geocode property, the reference geocode and the order with
which to sort with regard to that property.

isActive()Deprecated.This method may not be supported in future
versions of the MDEX Engine API. The best way to
determine whether a sort key is in use is to determine if
it is in the sort criteria list returned by
Navigation.getActiveSortKeys().

ERecSortKey

Create a new relevance rank key that specifies a sort using
a relevance ranking module. Only modules that are independent
of a text search may be used. Parameters may be given by following
the name with '(', then comma separated parameters, then ')'.
Relevance rank modules used in sort keys must be prefixed by
"Endeca.", so this text will be added by this constructor if it
is missing.

getName

getType

public int getType()

Indicates the type of the sort key.

Returns:

name of the sort key type.

isActive

public boolean isActive()

Deprecated.This method may not be supported in future
versions of the MDEX Engine API. The best way to
determine whether a sort key is in use is to determine if
it is in the sort criteria list returned by
Navigation.getActiveSortKeys().

Returns whether the key is active. Returns whether this sort key
is being applied.

Returns:

returns true if the key is being applied to
records, and false if it is not.

getOrder

public int getOrder()

Gets the direction the sort key has been applied to record set if
the sort key has been applied, is active.

Returns:

returns ASCENDING if the sort key hsa been
applied in ascending order and DESCENDING if
the sort key has been applied in descending order.
Returns NOT_ACTIVE if the sort key is not
being applied.

getReferenceLatitude

public double getReferenceLatitude()

Gets the latitude of the point relative to which this sort
specifies a distance sort.