|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface CpoAdapterRemote
CpoAdapter is an interface for a set of routines that are responsible for Creating, Retrieving, Updating, and Deleting (CRUD) value objects within a datasource. CpoAdapter is an interface that acts as a common facade for different datasources. It is conceivable that an CpoAdapter can be implemented for JDBC, CSV, XML, LDAP, and more datasources producing classes such as JdbcCpoAdapter, CsvCpoAdapter, XmlCpoAdapter, LdapCpoAdapter, etc.
Field Summary | |
---|---|
static int |
CREATE
|
static int |
DELETE
|
static int |
EXECUTE
|
static int |
EXIST
|
static int |
INSERT
|
static int |
LIST
|
static int |
PERSIST
|
static int |
RETRIEVE
|
static int |
UPDATE
|
Method Summary | ||
---|---|---|
void |
clearMetaClass()
Clears the metadata for all classes. |
|
void |
clearMetaClass(java.lang.Object obj)
Clears the metadata for the specified object. |
|
void |
clearMetaClass(java.lang.String className)
Clears the metadata for the specified fully qualifed class name. |
|
|
deleteObject(java.lang.String name,
T obj)
Removes the Object from the datasource. |
|
|
deleteObject(T obj)
Removes the Object from the datasource. |
|
|
deleteObjects(java.util.Collection<T> coll)
Removes the Objects contained in the collection from the datasource. |
|
|
deleteObjects(java.lang.String name,
java.util.Collection<T> coll)
Removes the Objects contained in the collection from the datasource. |
|
|
executeObject(java.lang.String name,
C criteria,
T result)
Executes an Object that represents an executable object within the datasource. |
|
|
executeObject(java.lang.String name,
T object)
Executes an Object whose MetaData contains a stored procedure. |
|
|
executeObject(T obj)
Executes an Object that represents an executable object within the datasource. |
|
|
existsObject(java.lang.String name,
T obj)
The CpoAdapter will check to see if this object exists in the datasource. |
|
|
existsObject(T obj)
The CpoAdapter will check to see if this object exists in the datasource. |
|
|
insertObject(java.lang.String name,
T obj)
Creates the Object in the datasource. |
|
|
insertObject(T obj)
Creates the Object in the datasource. |
|
|
insertObjects(java.util.Collection<T> coll)
Iterates through a collection of Objects, creates and stores them in the datasource. |
|
|
insertObjects(java.lang.String name,
java.util.Collection<T> coll)
Iterates through a collection of Objects, creates and stores them in the datasource. |
|
CpoOrderBy |
newOrderBy(java.lang.String attribute,
boolean ascending)
DOCUMENT ME! |
|
|
newOrderBy(java.lang.String attribute,
boolean ascending,
java.lang.String function)
DOCUMENT ME! |
|
CpoWhere |
newWhere()
DOCUMENT ME! |
|
|
newWhere(int logical,
java.lang.String attr,
int comp,
T value)
DOCUMENT ME! |
|
|
newWhere(int logical,
java.lang.String attr,
int comp,
T value,
boolean not)
DOCUMENT ME! |
|
|
persistObject(java.lang.String name,
T obj)
Persists the Object into the datasource. |
|
|
persistObject(T obj)
Persists the Object into the datasource. |
|
|
persistObjects(java.util.Collection<T> coll)
Persists a collection of Objects into the datasource. |
|
|
persistObjects(java.lang.String name,
java.util.Collection<T> coll)
Persists a collection of Objects into the datasource. |
|
|
retrieveObject(java.lang.String name,
C criteria,
T result,
CpoWhere where,
java.util.Collection<? extends CpoOrderBy> orderBy)
Retrieves the Object from the datasource. |
|
|
retrieveObject(java.lang.String name,
T obj)
Retrieves the Object from the datasource. |
|
|
retrieveObject(T obj)
Retrieves the Object from the datasource. |
|
|
retrieveObjects(java.lang.String name,
C criteria,
T result,
CpoWhere where,
java.util.Collection<? extends CpoOrderBy> orderBy)
Retrieves the Object from the datasource. |
|
|
transactObjects(java.util.Collection<CpoObject<T>> coll)
Deprecated. |
|
|
updateObject(java.lang.String name,
T obj)
Update the Object in the datasource. |
|
|
updateObject(T obj)
Update the Object in the datasource. |
|
|
updateObjects(java.util.Collection<T> coll)
Updates a collection of Objects in the datasource. |
|
|
updateObjects(java.lang.String name,
java.util.Collection<T> coll)
Updates a collection of Objects in the datasource. |
Field Detail |
---|
static final int CREATE
static final int INSERT
static final int UPDATE
static final int DELETE
static final int RETRIEVE
static final int LIST
static final int PERSIST
static final int EXIST
static final int EXECUTE
Method Detail |
---|
void clearMetaClass(java.lang.Object obj) throws CpoException, java.rmi.RemoteException
obj
- The object whose metadata must be cleared
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.void clearMetaClass(java.lang.String className) throws CpoException, java.rmi.RemoteException
className
- The fully qualified class name for the class that needs its
metadata cleared.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.void clearMetaClass() throws CpoException, java.rmi.RemoteException
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long insertObject(T obj) throws CpoException, java.rmi.RemoteException
obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long insertObject(java.lang.String name, T obj) throws CpoException, java.rmi.RemoteException
name
- The String
name of the CREATE Query group that will be used to create the object
in the datasource. null
signifies that the default rules will be used.obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long insertObjects(java.util.Collection<T> coll) throws CpoException, java.rmi.RemoteException
coll
- This is a collection of objects that have been defined within the metadata of
the datasource. If the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long insertObjects(java.lang.String name, java.util.Collection<T> coll) throws CpoException, java.rmi.RemoteException
name
- The String
name of the CREATE Query group that will be used to create the object
in the datasource. null
signifies that the default rules will be used.coll
- This is a collection of objects that have been defined within the metadata of
the datasource. If the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long deleteObject(T obj) throws CpoException, java.rmi.RemoteException
obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown. If the object does not exist
in the datasource an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long deleteObject(java.lang.String name, T obj) throws CpoException, java.rmi.RemoteException
name
- The String
name of the DELETE Query group that will be used to create the object
in the datasource. null
signifies that the default rules will be used.obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown. If the object does not exist
in the datasource an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long deleteObjects(java.util.Collection<T> coll) throws CpoException, java.rmi.RemoteException
coll
- This is a collection of objects that have been defined within the metadata of
the datasource. If the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long deleteObjects(java.lang.String name, java.util.Collection<T> coll) throws CpoException, java.rmi.RemoteException
name
- The String
name of the DELETE Query group that will be used to create the object
in the datasource. null
signifies that the default rules will be used.coll
- This is a collection of objects that have been defined within the metadata of
the datasource. If the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> T executeObject(T obj) throws CpoException, java.rmi.RemoteException
obj
- This is an Object
that has been defined within the metadata of the
datasource. If the class is not defined an exception will be thrown. If the object
does not exist in the datasource, an exception will be thrown. This object is used
to populate the IN parameters used to executed the datasource object.
An object of this type will be created and filled with the returned data from the value_object.
This newly created object will be returned from this method.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> T executeObject(java.lang.String name, T object) throws CpoException, java.rmi.RemoteException
name
- The filter name which tells the datasource which objects should be returned. The
name also signifies what data in the object will be populated.object
- This is an object that has been defined within the metadata of the
datasource. If the class is not defined an exception will be thrown. If the object
does not exist in the datasource, an exception will be thrown. This object is used
to populate the IN parameters used to retrieve the collection of objects.
This object defines the object type that will be returned in the collection and
contain the result set data or the OUT Parameters.
CpoException
- DOCUMENT ME!
java.rmi.RemoteException
<T,C> T executeObject(java.lang.String name, C criteria, T result) throws CpoException, java.rmi.RemoteException
name
- The String
name of the EXECUTE Query group that will be used to create the object
in the datasource. null
signifies that the default rules will be used.criteria
- This is an object that has been defined within the metadata of the
datasource. If the class is not defined an exception will be thrown. If the object
does not exist in the datasource, an exception will be thrown. This object is used
to populate the IN parameters used to retrieve the collection of objects.result
- This is an object that has been defined within the metadata of the datasource.
If the class is not defined an exception will be thrown. If the object does not
exist in the datasource, an exception will be thrown. This object defines the
object type that will be created, filled with the return data and returned from this
method.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long existsObject(T obj) throws CpoException, java.rmi.RemoteException
obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown. This object will be searched for inside the
datasource.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long existsObject(java.lang.String name, T obj) throws CpoException, java.rmi.RemoteException
name
- The String
name of the EXISTS Query group that will be used to create the object
in the datasource. null
signifies that the default rules will be used.obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown. This object will be searched for inside the
datasource.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.CpoOrderBy newOrderBy(java.lang.String attribute, boolean ascending) throws CpoException, java.rmi.RemoteException
attribute
- DOCUMENT ME!ascending
- DOCUMENT ME!
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> CpoOrderBy newOrderBy(java.lang.String attribute, boolean ascending, java.lang.String function) throws CpoException, java.rmi.RemoteException
attribute
- DOCUMENT ME!ascending
- DOCUMENT ME!function
- DOCUMENT ME!
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.CpoWhere newWhere() throws CpoException, java.rmi.RemoteException
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> CpoWhere newWhere(int logical, java.lang.String attr, int comp, T value) throws CpoException, java.rmi.RemoteException
logical
- DOCUMENT ME!attr
- DOCUMENT ME!comp
- DOCUMENT ME!value
- DOCUMENT ME!
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> CpoWhere newWhere(int logical, java.lang.String attr, int comp, T value, boolean not) throws CpoException, java.rmi.RemoteException
logical
- DOCUMENT ME!attr
- DOCUMENT ME!comp
- DOCUMENT ME!value
- DOCUMENT ME!not
- DOCUMENT ME!
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long persistObject(T obj) throws CpoException, java.rmi.RemoteException
obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.existsObject(T)
,
insertObject(T)
,
updateObject(T)
<T> long persistObject(java.lang.String name, T obj) throws CpoException, java.rmi.RemoteException
name
- The name which identifies which EXISTS, INSERT, and UPDATE Query groups to
execute to persist the object.obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.existsObject(T)
,
insertObject(T)
,
updateObject(T)
<T> long persistObjects(java.util.Collection<T> coll) throws CpoException, java.rmi.RemoteException
coll
- This is a collection of objects that have been defined within the metadata of
the datasource. If the class is not defined an exception will be thrown.name
- The name which identifies which EXISTS, INSERT, and UPDATE Query groups to
execute to persist the object.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.existsObject(T)
,
insertObject(T)
,
updateObject(T)
<T> long persistObjects(java.lang.String name, java.util.Collection<T> coll) throws CpoException, java.rmi.RemoteException
name
- The name which identifies which EXISTS, INSERT, and UPDATE Query groups to
execute to persist the object.coll
- This is a collection of objects that have been defined within the metadata of
the datasource. If the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.existsObject(T)
,
insertObject(T)
,
updateObject(T)
<T> T retrieveObject(T obj) throws CpoException, java.rmi.RemoteException
obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown. If the object does not exist
in the datasource, an exception will be thrown. The input object is used to specify
the search criteria, the output object is populated with the results of the query.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> T retrieveObject(java.lang.String name, T obj) throws CpoException, java.rmi.RemoteException
name
- DOCUMENT ME!obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown. If the object does not exist
in the datasource, an exception will be thrown. The input object is used to specify
the search criteria, the output object is populated with the results of the query.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T,C> T retrieveObject(java.lang.String name, C criteria, T result, CpoWhere where, java.util.Collection<? extends CpoOrderBy> orderBy) throws CpoException, java.rmi.RemoteException
name
- DOCUMENT ME!obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown. If the object does not exist
in the datasource, an exception will be thrown. The input object is used to specify
the search criteria, the output object is populated with the results of the query.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T,C> T retrieveObjects(java.lang.String name, C criteria, T result, CpoWhere where, java.util.Collection<? extends CpoOrderBy> orderBy) throws CpoException, java.rmi.RemoteException
name
- The filter name which tells the datasource which objects should be returned. The
name also signifies what data in the object will be populated.criteria
- This is an object that has been defined within the metadata of the
datasource. If the class is not defined an exception will be thrown. If the object
does not exist in the datasource, an exception will be thrown. This object is used
to specify the parameters used to retrieve the collection of objects.result
- This is an object that has been defined within the metadata of the datasource.
If the class is not defined an exception will be thrown. If the object does not
exist in the datasource, an exception will be thrown. This object is used to specify
the object type that will be returned in the collection.where
- DOCUMENT ME!orderBy
- DOCUMENT ME!
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.@Deprecated <T> long transactObjects(java.util.Collection<CpoObject<T>> coll) throws CpoException, java.rmi.RemoteException
coll
- DOCUMENT ME!
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long updateObject(T obj) throws CpoException, java.rmi.RemoteException
obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long updateObject(java.lang.String name, T obj) throws CpoException, java.rmi.RemoteException
name
- The String
name of the UPDATE Query group that will be used to create the object
in the datasource. null
signifies that the default rules will be used.obj
- This is an object that has been defined within the metadata of the datasource. If
the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long updateObjects(java.util.Collection<T> coll) throws CpoException, java.rmi.RemoteException
coll
- This is a collection of objects that have been defined within the metadata of
the datasource. If the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.<T> long updateObjects(java.lang.String name, java.util.Collection<T> coll) throws CpoException, java.rmi.RemoteException
name
- The String
name of the UPDATE Query group that will be used to create the object
in the datasource. null
signifies that the default rules will be used.coll
- This is a collection of objects that have been defined within the metadata of
the datasource. If the class is not defined an exception will be thrown.
CpoException
- Thrown if there are errors accessing the datasource
java.rmi.RemoteException
- Thrown if using dataPersist as an EJB and an Error
occurs.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |