TRIM.SDK.TrimAggregateResultIterator Class Reference

Public Member Functions
TrimAggregateResult	Current ()
	Returns the current aggregate result where this iterator is position. You need to have got a successful result from the most recent MoveNext() or MoveToStart() before calling this. More...
bool	MoveNext ()
	Moves the iterator forward through the result set. More...
void	Reset ()
	Resets the iterator back to the initial state More...
void	Reset (bool reissueQuery)
	Resets the iterator back to the initial state, however you can optionally work with the current aggregated query results More...
TrimMainObjectSearch	ShowResultsForKey (string keyValue)
	gets a TrimMainObjectSearch that shows all the results for a single key value. More...
TrimMainObjectSearch	ShowResultsForManyKeys (StringArray keyValues)
	gets a TrimMainObjectSearch that shows all the results for one or more key values. More...

Properties
long	KeyCount [get]
	gets the number of distinct key values in the selection, which also corresponds to the number of items the iterator will return. More...
long	TotalHits [get]
	gets the total of all the counts for the different key values returned by this iterator. More...
long	RemovedKeyCount [get]
	gets the number of distinct key values that were removed from the selection because of the limitation imposed by the MaxKeyValues setting. These key values are aggregated into the the result called "Other". More...
long	MaxKeyValues [get, set]
	This method allows you to remove any results which have a low number of hits by restricting the list to a maximum number of items. Using this method you can then display only the most relevant key values (i.e. those with a higher number of hits) and group the remainder into a section called "other". The function returns a count of the total number of hits removed. Will automatically reset the iterator. More...
DateAggregationType	DateAggregationMethod [get, set]
AggregationSortOrder	AggregationSortOrder [get, set]
PropertyOrFieldDef	AggregateBy [get, set]
	gets or sets a ApiPropertyOrFieldDef object to indicate the property that is being used for the aggregation. More...

Member Function Documentation

Current()

TrimAggregateResult TRIM.SDK.TrimAggregateResultIterator.Current

(

)

Returns the current aggregate result where this iterator is position. You need to have got a successful result from the most recent MoveNext() or MoveToStart() before calling this.

MoveNext()

bool TRIM.SDK.TrimAggregateResultIterator.MoveNext

(

)

Moves the iterator forward through the result set.

Reset() [1/2]

void TRIM.SDK.TrimAggregateResultIterator.Reset

(

)

Resets the iterator back to the initial state

Reset() [2/2]

void TRIM.SDK.TrimAggregateResultIterator.Reset

(

bool

reissueQuery

)

Resets the iterator back to the initial state, however you can optionally work with the current aggregated query results

ShowResultsForKey()

TrimMainObjectSearch TRIM.SDK.TrimAggregateResultIterator.ShowResultsForKey

(

string

keyValue

)

gets a TrimMainObjectSearch that shows all the results for a single key value.

ShowResultsForManyKeys()

TrimMainObjectSearch TRIM.SDK.TrimAggregateResultIterator.ShowResultsForManyKeys

(

StringArray

keyValues

)

gets a TrimMainObjectSearch that shows all the results for one or more key values.

Property Documentation

AggregateBy

PropertyOrFieldDef TRIM.SDK.TrimAggregateResultIterator.AggregateBy

getset

gets or sets a ApiPropertyOrFieldDef object to indicate the property that is being used for the aggregation.

AggregationSortOrder

AggregationSortOrder TRIM.SDK.TrimAggregateResultIterator.AggregationSortOrder

getset

DateAggregationMethod

DateAggregationType TRIM.SDK.TrimAggregateResultIterator.DateAggregationMethod

getset

KeyCount

long TRIM.SDK.TrimAggregateResultIterator.KeyCount

get

gets the number of distinct key values in the selection, which also corresponds to the number of items the iterator will return.

MaxKeyValues

long TRIM.SDK.TrimAggregateResultIterator.MaxKeyValues

getset

This method allows you to remove any results which have a low number of hits by restricting the list to a maximum number of items. Using this method you can then display only the most relevant key values (i.e. those with a higher number of hits) and group the remainder into a section called "other". The function returns a count of the total number of hits removed. Will automatically reset the iterator.

RemovedKeyCount

long TRIM.SDK.TrimAggregateResultIterator.RemovedKeyCount

get

gets the number of distinct key values that were removed from the selection because of the limitation imposed by the MaxKeyValues setting. These key values are aggregated into the the result called "Other".

TotalHits

long TRIM.SDK.TrimAggregateResultIterator.TotalHits

get

gets the total of all the counts for the different key values returned by this iterator.