Mura CMS 6.1

mura.iterator
Class queryIterator

railo-context.Component
        extended by mura.cfobject
            extended by mura.iterator.queryIterator
Direct Known Subclasses:
beanIterator , categoryIterator , contentCommentIterator , contentIterator , favoriteIterator , extendObjectIterator , trashIterator , addressIterator , userIterator

public class queryIterator
extends cfobject

I am a Iterator object.


Constructor Summary
init()
 
Method Summary
 any clearPageQueries()
 numeric currentIndex()
 numeric currentRow()
 any end()
 any getArray()
 numeric getFirstRecordOnPageIndex()
 any getIteratorID()
 numeric getLastRecordOnPageIndex()
 any getNextN()
 any getPageIDList()
 numeric getPageIndex()
 any getPageQuery(string queryName)
 any getQuery()
 numeric getRecordCount()
 any getRecordIdField()
 numeric getRecordIndex()
 boolean hasNext()
 boolean hasPrevious()
 any next()
 any packageRecord([any recordIndex='[runtime expression]'])
 numeric pageCount()
 any peek()
 any previous()
 struct queryRowToStruct(query qry)
 numeric recordCount()
          For Railo compatibility use getRecordCount()
 any reset()
 any setArray(any array, [numeric maxRecordsPerPage])
 any setNextN([any nextN])
 any setPage(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, deleteMethod, getAsJSON, getAsStruct, getBean, getConfigBean, getCurrentUser, getEventManager, getPlugin, getPluginManager, getServiceFactory, getValue, initTracePoint, injectMethod, invokeMethod, removeValue, setValue, valueExists
 
Methods inherited from class railo-context.Component
 

Constructor Detail

init

public init()

Method Detail

clearPageQueries

public any clearPageQueries()


currentIndex

public numeric currentIndex()


currentRow

public numeric currentRow()


end

public any end()


getArray

public any getArray()


getFirstRecordOnPageIndex

public numeric getFirstRecordOnPageIndex()


getIteratorID

public any getIteratorID()


getLastRecordOnPageIndex

public numeric getLastRecordOnPageIndex()


getNextN

public any getNextN()


getPageIDList

public any getPageIDList()


getPageIndex

public numeric getPageIndex()


getPageQuery

public any getPageQuery(string queryName)

Parameters:
queryName

getQuery

public any getQuery()


getRecordCount

public numeric getRecordCount()


getRecordIdField

public any getRecordIdField()


getRecordIndex

public numeric getRecordIndex()


hasNext

public boolean hasNext()


hasPrevious

public boolean hasPrevious()


next

public any next()


packageRecord

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

Parameters:
recordIndex

pageCount

public numeric pageCount()


peek

public any peek()


previous

public any previous()


queryRowToStruct

public struct queryRowToStruct(query qry)

Parameters:
qry

recordCount

public numeric recordCount()
For Railo compatibility use getRecordCount()


reset

public any reset()


setArray

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

Parameters:
array
maxRecordsPerPage

setNextN

public any setNextN([any nextN])

Parameters:
nextN

setPage

public any setPage(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

Mura CMS 6.1