Packagecom.endeca.tools.pagebuilder.model.content
Interfacepublic interface INavQuery extends IQuery, IContentModelObject, flash.events.IEventDispatcher, IEquatable, flash.utils.IExternalizable

Information describing a navigation query.

See also

IQuery
IRecordQuery
IRecordListProperty


Public Properties
 PropertyDefined by
  augment : Boolean
Whether the navigation state of the query should be augmented.
INavQuery
  augmentRecordFilter : Boolean
Whether the record filter of the query should be augmented.
INavQuery
  dimensionValues : IContentModelList
A list of dimension values which define the navigation state for this query.
INavQuery
  maxRecords : uint
The maximum number of records the query should return.
INavQuery
 InheritedreadOnly : Boolean
Indicates whether the content model is in read-only mode.
IContentModelObject
  sort : IRecordSort
How the results of the query are to be sorted.
INavQuery
Public Methods
 MethodDefined by
 Inherited
equals(obj:Object):Boolean
Tests whether this object is equal to the given object.
IEquatable
Events
 EventSummaryDefined by
 Inherited Dispatched when the content model has been updated in some way.IContentModelObject
Property detail
augmentproperty
augment:Boolean  [read-write]

Whether the navigation state of the query should be augmented.

This property can be used as the source for data binding.

Implementation
    public function get augment():Boolean
    public function set augment(value:Boolean):void
augmentRecordFilterproperty 
augmentRecordFilter:Boolean  [read-write]

Whether the record filter of the query should be augmented.

This property can be used as the source for data binding.

Implementation
    public function get augmentRecordFilter():Boolean
    public function set augmentRecordFilter(value:Boolean):void
dimensionValuesproperty 
dimensionValues:IContentModelList  [read-write]

A list of dimension values which define the navigation state for this query. This list may only contain IDimensionValue objects.

This property can be used as the source for data binding.

Implementation
    public function get dimensionValues():IContentModelList
    public function set dimensionValues(value:IContentModelList):void

See also

maxRecordsproperty 
maxRecords:uint  [read-write]

The maximum number of records the query should return.

This property can be used as the source for data binding.

Implementation
    public function get maxRecords():uint
    public function set maxRecords(value:uint):void
sortproperty 
sort:IRecordSort  [read-write]

How the results of the query are to be sorted.

This property can be used as the source for data binding.

Implementation
    public function get sort():IRecordSort
    public function set sort(value:IRecordSort):void