queryIterator

Class queryIterator

WEB-INF.cftags.component
    mura.cfobject
      mura.iterator.queryIterator

Direct Known Subclasses:

beanIterator , contentCommentIterator , contentIterator , favoriteIterator , extendObjectIterator , trashIterator , userIterator

This provide core iterating functionality

Class Attributes:

displayname : Iterator

output : false

Constructor Summary
init()

Method Summary
`any`	clearPageQueries()
`any`	currentIndex()
`any`	currentRow()
`any`	end()
`any`	getArray()
`any`	getCurrentIndex()
`any`	getFeed()
`any`	getFirstRecordOnPageIndex()
`any`	getItemsPerPage()
`any`	getIteratorID()
`any`	getLastRecordOnPageIndex()
`any`	getNextN()
`any`	getPageCount()
`any`	getPageIDList()
`any`	getPageIndex()
`any`	getPageQuery(string queryName)
`any`	getQuery()
`any`	getRecordCount()
`any`	getRecordIdField()
`any`	getRecordIndex()
`any`	hasFeed()
`boolean`	hasNext()
`boolean`	hasPrevious()
`any`	next()
`any`	packageRecord([any recordIndex='[runtime expression]'])
`any`	pageCount()
`any`	peek()
`any`	previous()
`struct`	queryRowToStruct(query qry)
`any`	recordCount() For Lucee compatibility use getRecordCount().
`any`	reset()
`any`	setArray(any array, [numeric maxRecordsPerPage])
`any`	setCurrentIndex([any currentIndex])
`any`	setFeed([any feed])
`any`	setItemsPerPage([any itemsPerPage])
`any`	setNextN([any nextN])
`any`	setPage([any pageIndex])
`any`	setPageIndex(numeric pageIndex)
`any`	setPageQuery(string queryName, [any queryObject=''])
`any`	setQuery(query rs, [numeric maxRecordsPerPage])
`any`	setStartRow([any startRow])

Methods inherited from class `mura.cfobject`
commitTracePoint, convertTimezone, deleteMethod, get, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEntity, getEventManager, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getQueryAttrs, getQueryService, getServiceFactory, getSession, getValue, hasCustomDatasource, initTracePoint, inject, injectMethod, invokeMethod, mixin, parseDateArg, removeValue, set, setValue, valueExists

Methods inherited from class mura.cfobject

commitTracePoint, convertTimezone, deleteMethod, get, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEntity, getEventManager, getHTTPAttrs, getHTTPService, getJavaTimezone, getPlugin, getPluginManager, getQueryAttrs, getQueryService, getServiceFactory, getSession, getValue, hasCustomDatasource, initTracePoint, inject, injectMethod, invokeMethod, mixin, parseDateArg, removeValue, set, setValue, valueExists

Methods inherited from class `WEB-INF.cftags.component`
None

Constructor Detail

init

public init()

Method Detail

clearPageQueries

public any clearPageQueries()

currentIndex

public any currentIndex()

currentRow

public any currentRow()

end

public any end()

getArray

public any getArray()

getCurrentIndex

public any getCurrentIndex()

getFeed

public any getFeed()

Overrides:: getFeed in class cfobject

getFirstRecordOnPageIndex

public any getFirstRecordOnPageIndex()

getItemsPerPage

public any getItemsPerPage()

getIteratorID

public any getIteratorID()

getLastRecordOnPageIndex

public any getLastRecordOnPageIndex()

getNextN

public any getNextN()

getPageCount

public any getPageCount()

getPageIDList

public any getPageIDList()

getPageIndex

public any getPageIndex()

getPageQuery

public any getPageQuery(string queryName)

Parameters:: queryName

getQuery

public any getQuery()

getRecordCount

public any getRecordCount()

getRecordIdField

public any getRecordIdField()

getRecordIndex

public any getRecordIndex()

hasFeed

public any hasFeed()

hasNext

public boolean hasNext()

hasPrevious

public boolean hasPrevious()

public any next()

packageRecord

public any packageRecord([any recordIndex='[runtime expression]'])

Parameters:: recordIndex

pageCount

public any pageCount()

peek

public any peek()

public any previous()

queryRowToStruct

public struct queryRowToStruct(query qry)

Parameters:: qry

recordCount

public any recordCount()

For Lucee compatibility use getRecordCount()

reset

public any reset()

setArray

public any setArray(any array, [numeric maxRecordsPerPage])

Parameters:: array; maxRecordsPerPage

setCurrentIndex

public any setCurrentIndex([any currentIndex])

Parameters:: currentIndex

setFeed

public any setFeed([any feed])

Parameters:: feed

setItemsPerPage

public any setItemsPerPage([any itemsPerPage])

Parameters:: itemsPerPage

setNextN

public any setNextN([any nextN])

Parameters:: nextN

setPage

public any setPage([any pageIndex])

Parameters:: pageIndex

setPageIndex

public any setPageIndex(numeric pageIndex)

Parameters:: pageIndex

setPageQuery

public any setPageQuery(string queryName, [any queryObject=''])

Parameters:: queryName; queryObject

setQuery

public any setQuery(query rs, [numeric maxRecordsPerPage])

Parameters:: rs; maxRecordsPerPage

setStartRow

public any setStartRow([any startRow])

Parameters:: startRow