com.corrspt.xeo.framework
Interface ObjectList

All Known Implementing Classes:

XeoObjectList

public interface ObjectList

Represents a list of objects and associated properties and metadata

Method Summary

void	beforeFirst()
boolean	first()
void	firstPage()
netgest.bo.def.boDefHandler	getBoDef()
java.lang.String	getBOQL()
java.lang.Object[]	getBOQLArgs()
long	getCurrentBoui()
netgest.bo.runtime.EboContext	getEboContext()
java.lang.String	getFilter()
byte	getFormat()
java.lang.String	getFullTextSearch()
java.lang.String	getName()
netgest.bo.runtime.boObject	getObject()
netgest.bo.runtime.boObject	getObject(long boui)
java.lang.String	getOrderBy()
int	getPage()
int	getPages()
int	getPageSize()
java.lang.String	getParameter(java.lang.String parametername)
java.lang.String[]	getParametersNames()
java.lang.String[]	getParametersValues()
netgest.bo.ql.QLParser	getQLParser()
long	getRecordCount() Retrieves the number of records returned by the select query
int	getRow()
int	getRowCount() Returns the number of rows in the current page
netgest.bo.data.DataResultSet	getRslt()
netgest.bo.runtime.boObjectList.SqlField[]	getSqlFields()
java.lang.String	getUserQuery()
java.lang.Object[]	getUserQueryArgs()
boolean	haveBoui(long boui) Whether or not the list contains a given identifier
boolean	haveMorePages()
boolean	isEmpty() Checks whether the list empty or not
boolean	last()
void	lastPage()
void	moveRowTo(int row)
boolean	moveTo(int recno)
boolean	next()
void	nextPage()
boolean	previous()
void	previousPage()
void	refreshData()
void	removeCurrent()
void	setEboContext(netgest.bo.runtime.EboContext oEboContext)
void	setFullTextSearch(java.lang.String arrangeFulltext)
void	setQueryOrderBy(java.lang.String string)
void	setSqlFields(netgest.bo.runtime.boObjectList.SqlField[] object)
void	setUserQuery(java.lang.String userQuery, java.lang.Object[] userQueryParam)

Method Detail

getFormat

byte getFormat()

getBoDef

netgest.bo.def.boDefHandler getBoDef()
                                     throws netgest.bo.runtime.boRuntimeException

Throws:

netgest.bo.runtime.boRuntimeException

getName

java.lang.String getName()

getCurrentBoui

long getCurrentBoui()

haveBoui

boolean haveBoui(long boui)

Whether or not the list contains a given identifier

Parameters:

boui - The identifier

Returns:

True if the identifier is in the list and false otherwise

getBOQL

java.lang.String getBOQL()

getBOQLArgs

java.lang.Object[] getBOQLArgs()

haveMorePages

boolean haveMorePages()

refreshData

void refreshData()

isEmpty

boolean isEmpty()

Checks whether the list empty or not

Returns:

getFilter

java.lang.String getFilter()

getObject

netgest.bo.runtime.boObject getObject(long boui)
                                      throws netgest.bo.runtime.boRuntimeException

Throws:

netgest.bo.runtime.boRuntimeException

getObject

netgest.bo.runtime.boObject getObject()
                                      throws netgest.bo.runtime.boRuntimeException

Throws:

netgest.bo.runtime.boRuntimeException

getRowCount

int getRowCount()

Returns the number of rows in the current page

Returns:

The number of rows in the current page

getRecordCount

long getRecordCount()

Retrieves the number of records returned by the select query

Returns:

The total number of records in the query

getPages

int getPages()

getPageSize

int getPageSize()

getPage

int getPage()

next

boolean next()

moveTo

boolean moveTo(int recno)

nextPage

void nextPage()

previousPage

void previousPage()

firstPage

void firstPage()

lastPage

void lastPage()

previous

boolean previous()

beforeFirst

void beforeFirst()

first

boolean first()

last

boolean last()

getOrderBy

java.lang.String getOrderBy()

getParametersNames

java.lang.String[] getParametersNames()

getParametersValues

java.lang.String[] getParametersValues()

getParameter

java.lang.String getParameter(java.lang.String parametername)

removeCurrent

void removeCurrent()
                   throws netgest.bo.runtime.boRuntimeException

Throws:

netgest.bo.runtime.boRuntimeException

moveRowTo

void moveRowTo(int row)
               throws netgest.bo.runtime.boRuntimeException

Throws:

netgest.bo.runtime.boRuntimeException

getFullTextSearch

java.lang.String getFullTextSearch()

getQLParser

netgest.bo.ql.QLParser getQLParser()

setSqlFields

void setSqlFields(netgest.bo.runtime.boObjectList.SqlField[] object)

getSqlFields

netgest.bo.runtime.boObjectList.SqlField[] getSqlFields()

getEboContext

netgest.bo.runtime.EboContext getEboContext()

setEboContext

void setEboContext(netgest.bo.runtime.EboContext oEboContext)

setQueryOrderBy

void setQueryOrderBy(java.lang.String string)

setUserQuery

void setUserQuery(java.lang.String userQuery,
                  java.lang.Object[] userQueryParam)

getRslt

netgest.bo.data.DataResultSet getRslt()

setFullTextSearch

void setFullTextSearch(java.lang.String arrangeFulltext)

getRow

int getRow()

getUserQuery

java.lang.String getUserQuery()

getUserQueryArgs

java.lang.Object[] getUserQueryArgs()