|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Websphere Data Objects - DataListAccessBean Implementation
This interface defines the interface to a DataList. A DataList is an
object that represents a view onto a collection of DataObjects. The DataObjects
themselves are described by a separate object, an IDataObject
.
DataListAccessBean has the following reponsibilities
Field Summary | |
static int |
ASCENDING
|
static int |
DESCENDING
|
static int |
UNSORTED
|
Method Summary | |
void |
addOrderBy(java.lang.String name,
int direction)
Adds an orderBy to order results by a property in a given direction Orderby is added to the front of the order-by list; If name previously existed in Order By List, it is moved to the front of the order-by list. |
void |
clearOrderBy()
Removes all orderBy clauses set through the addOrderBy API |
void |
close()
Releases any resources, such as database cursors, being held by the DataList for the current page |
void |
commit()
Commits any changes made by calls to put |
DataObjectAccessBean |
createNewDataObject()
Creates a new DataObjectAccessBean of the Type held by this Collection. |
void |
emptyDataGraph()
Creates new empty datagraph |
void |
execute()
executes the query and fills the DataList with the first Page of Data |
void |
execute(java.util.Map params)
Executes the query and fills the DataList with the first Page of Data |
void |
firstPage()
Moves to the first page of DataObjects |
java.lang.String |
getAction()
get the default action upon initialization of this data list (fill/empty/none) |
DataObjectAccessBean |
getDataObjectAccessBean(int index)
Returns the element at the specified position in this list. |
java.lang.Long |
getNextGeneratedKey()
Get the next Key Value from the Auto Key Generator |
boolean |
getPagination()
Returns whether or not this DataList is paginating the results |
java.util.Map |
getParams()
Return the current parameters that are used during execution |
int |
getTargetPageSize()
Return the desired number of DataObjects to return per page. |
void |
nextPage()
resets the position of the DataList so that on the next iteration, the next page of DataObjects will be returned. |
void |
previousPage()
resets the position of the DataList so that on the next iteration, the previous page of DataObjects will be returned. |
void |
removeOrderBy(java.lang.String name)
Removes an Order By added for a given property |
void |
setAction(java.lang.String action)
Set the default action upon initialization of this data list (fill/empty/none) |
void |
setPagination(boolean pagination)
Specify whether or not this DataList shoulds paginate results |
void |
setParams(java.util.Map map)
Set the current parameters that are used during execution |
void |
setTargetPageSize(int targetPagesize)
Specify the desired number of DataObjects per page. |
Methods inherited from interface java.util.List |
add, add, addAll, addAll, clear, contains, containsAll, equals, get, hashCode, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, retainAll, set, size, subList, toArray, toArray |
Field Detail |
public static final int UNSORTED
public static final int ASCENDING
public static final int DESCENDING
Method Detail |
public void addOrderBy(java.lang.String name, int direction) throws java.lang.UnsupportedOperationException, com.ibm.websphere.wdo.mediator.exception.MediatorException, java.io.IOException
name
- name of column to order by.direction
- directional order to sort by: DataListAccessBean.UNSORTED,
DataListAccessBean.ASCENDING, DataListAccessBean.DESCENDING
com.ibm.websphere.wdo.mediator.exception.MediatorException
java.lang.UnsupportedOperationException
java.io.IOException
public void clearOrderBy() throws java.lang.UnsupportedOperationException, com.ibm.websphere.wdo.mediator.exception.MediatorException, java.io.IOException
java.lang.UnsupportedOperationException
com.ibm.websphere.wdo.mediator.exception.MediatorException
java.io.IOException
public void close() throws com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
public void commit() throws com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
public DataObjectAccessBean createNewDataObject() throws com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
public void execute() throws com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
public void emptyDataGraph() throws com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
public void execute(java.util.Map params) throws com.ibm.websphere.wdo.mediator.exception.MediatorException
params
- takes a Map of input parameters to pass to the executing query
com.ibm.websphere.wdo.mediator.exception.MediatorException
public java.util.Map getParams()
public void setParams(java.util.Map map)
map
- of parameters to be used during executionpublic void firstPage() throws com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
public DataObjectAccessBean getDataObjectAccessBean(int index) throws java.lang.IndexOutOfBoundsException, com.ibm.websphere.wdo.mediator.exception.MediatorException
index
- index of element to return.
java.lang.IndexOutOfBoundsException
- - if the index is out of range (index < 0 || index >= size()).
com.ibm.websphere.wdo.mediator.exception.MediatorException
public boolean getPagination()
public int getTargetPageSize()
public void nextPage() throws com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
public void previousPage() throws com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
public void removeOrderBy(java.lang.String name) throws java.lang.UnsupportedOperationException, com.ibm.websphere.wdo.mediator.exception.MediatorException
name
- name of column to be removed from order-by list.
com.ibm.websphere.wdo.mediator.exception.MediatorException
java.lang.UnsupportedOperationException
public void setPagination(boolean pagination)
pagination
- set whether to paginate resultspublic void setTargetPageSize(int targetPagesize)
targetPagesize
- the desired number of DataObjects per pagepublic void setAction(java.lang.String action)
action
- the default action to perform upon initialization of this data listpublic java.lang.String getAction()
public java.lang.Long getNextGeneratedKey() throws com.ibm.websphere.wdo.mediator.exception.MediatorException
com.ibm.websphere.wdo.mediator.exception.MediatorException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |