com.ibm.websphere.wdo
Interface DataObjectAccessBean

All Superinterfaces:

java.util.Map, java.io.Serializable

public interface DataObjectAccessBean

extends java.util.Map, java.io.Serializable

Websphere Data Objects - DataObjectAccessBean Implementation

This interface defines the interface to a DataObject.

DataObjectAccessBean has the following reponsibilities

• Allow a client to read the property values the DataObject
• Allow a client to update values in DataObjects. Changes to DataObjects are commited to the back end when commit is called

Assumptions:

• DataObjects are designed to be kept in HTTP sessions. This means that they must not consume significant memory. In particular:
  • A small amount of memory is used to remember the values in the sort columns of first/last DataObjects in each page that has been fetched
  • DataObject for relational database can be implemented using JDBC drivers that only support resultssets of type TYPE_FORWARD_ONLY

Nested Class Summary

Nested classes inherited from class java.util.Map

java.util.Map.Entry

Method Summary

void	autoGenerateKey() Populates the Primary key with values from the Key generator
void	close() Releases any resources, such as database cursors, being held by the DataList for the current page
void	commit() Commit the current Changes that have been made to the back-end
void	create() Inserts this DataObject in the back-end
void	emptyDataGraph() Creates new empty datagraph
void	find() executes the query to find one DataObject
void	find(java.util.Map params) executes the query to find one DataObject
java.lang.String	getAction() get the default action upon initialization of this data list (fill/empty/none)
DataListAccessBean	getDataListAccessBean(java.lang.String path) return the DataListAccessBean at the given path
java.lang.Long	getNextGeneratedKey() Get the next Key Value from the Auto Key Generator
java.util.Map	getParams() Return the current parameters that are used during execution
java.lang.Class	getType(java.lang.String key) Returns the type to which this map maps the specified key.
boolean	isReadOnly(java.lang.String key) Returns whether the object to which this map maps the specified key is read only.
void	remove() Removes the current DataObject from the back-end
void	setAction(java.lang.String action) Set the default action upon initialization of this data list (fill/empty/none)
void	setParams(java.util.Map map) Set the current parameters that are used during execution

Methods inherited from interface java.util.Map

clear, containsKey, containsValue, entrySet, equals, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Method Detail

close

public void close()
           throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Releases any resources, such as database cursors, being held by the DataList for the current page

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException

commit

public void commit()
            throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Commit the current Changes that have been made to the back-end

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException

create

public void create()
            throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Inserts this DataObject in the back-end

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException

remove

public void remove()

Removes the current DataObject from the back-end

emptyDataGraph

public void emptyDataGraph()
                    throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Creates new empty datagraph

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException

find

public void find()
          throws com.ibm.websphere.wdo.mediator.exception.MediatorException

executes the query to find one DataObject

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException

find

public void find(java.util.Map params)
          throws com.ibm.websphere.wdo.mediator.exception.MediatorException

executes the query to find one DataObject

Parameters:

params - takes a Map of input parameters to pass to the executing query

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException

getParams

public java.util.Map getParams()

Return the current parameters that are used during execution

Returns:

map of the current parameters that are used during execution

setParams

public void setParams(java.util.Map map)

Set the current parameters that are used during execution

Parameters:

map - of parameters to be used during execution

getDataListAccessBean

public DataListAccessBean getDataListAccessBean(java.lang.String path)
                                         throws java.lang.ClassCastException,
                                                com.ibm.websphere.wdo.mediator.exception.MediatorException

return the DataListAccessBean at the given path

Returns:

the DataListAccessBean at the following path

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException

java.lang.ClassCastException - if it is not a DataList at that path

getType

public java.lang.Class getType(java.lang.String key)
                        throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Returns the type to which this map maps the specified key. Returns null if the map contains no mapping for this key. A return value of null does not necessarily indicate that the map contains no mapping for the key; it's also possible that the map explicitly maps the key to null. The containsKey operation may be used to distinguish these two cases.

Parameters:

key - key whose associated value is to be returned.

Returns:

the type to which this map maps the specified key, or null if the map contains no mapping for this key.

Throws:

java.lang.ClassCastException - if the key is of an inappropriate type for this map.

java.lang.NullPointerException - key is null and this map does not not permit null keys.

com.ibm.websphere.wdo.mediator.exception.MediatorException

See Also:

Map.get(Object)

isReadOnly

public boolean isReadOnly(java.lang.String key)
                   throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Returns whether the object to which this map maps the specified key is read only.

Parameters:

key - key whose associated value is to be returned.

Returns:

whether the object to which this map maps the specified key is read only

Throws:

java.lang.ClassCastException - if the key is of an inappropriate type for this map.

java.lang.NullPointerException - key is null and this map does not not permit null keys.

com.ibm.websphere.wdo.mediator.exception.MediatorException

See Also:

Map.get(Object)

setAction

public void setAction(java.lang.String action)

Set the default action upon initialization of this data list (fill/empty/none)

Parameters:

action - the default action to perform upon initialization of this data list

getAction

public java.lang.String getAction()

get the default action upon initialization of this data list (fill/empty/none)

Returns:

default action upon initialization of this data list

autoGenerateKey

public void autoGenerateKey()
                     throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Populates the Primary key with values from the Key generator

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException

getNextGeneratedKey

public java.lang.Long getNextGeneratedKey()
                                   throws com.ibm.websphere.wdo.mediator.exception.MediatorException

Get the next Key Value from the Auto Key Generator

Returns:

the next key value from the auto key generator

Throws:

com.ibm.websphere.wdo.mediator.exception.MediatorException