ENEQuery naming convention

Each ENEQuery setter and getter method in Java, and property in .NET follow a naming convention that provides a quick way to determine the type of results the ENEQuery object will yield.

For example, setNavRecordFilter() in Java and NavRecordFilter in .NET are modifiers for a navigation request, and navigation requests return Navigation objects.

The table describes methods an properties, their corresponding returned object types and examples of usage in Java and .NET.

Note: See the Endeca API Javadocs and Endeca API Guide for .NET for complete information on all Presentation API classes, method (Java), and properties (.NET).
Method (Java) or property (.NET) convention Returned object (type) Examples

Java: setERec...()

.NET: ERec...

ERec

Java: setERecs(), setERecSpec()

.NET: ERecs, ERecSpec

Java: setNav...()

.NET: Nav...

Navigation

Java: setNavNumERecs()

.NET: NavNumERecs

Java: setDimSearch...()

.NET: DimSearch...

DimensionSearchResult

Note: This object has been deprecated.

Java: setDimSearchTerms()

.NET: DimSearchTerms

Java: setAggrERec...()

.NET: AggrERec...

AggrERec

Java: setAggrERecRollupKey()

.NET: AggrERecRollupKey