| com.ivata.mask.persistence.QueryPersistenceManager
| QueryPersistenceManager | | public interface QueryPersistenceManager extends PersistenceManager(Code) | | Extends the ivata masks persistence manager to include
facilities to execute queries against the persistence store, and adds
listeners.
author:
Colin MacLeod
author:
colin.macleod@ivata.com
since:
ivata masks 1.0 (2004-03-27)
version:
$Revision: 1.2 $ |
| Method Summary | |
| void | addAddListener(Class dOClass, AddPersistenceListener listener)
Add an add listener to this persistence manager. | | void | addAmendListener(Class dOClass, AmendPersistenceListener listener)
Add an amend listener to this persistence manager. | | void | addFilter(PersistenceFilter filter)
Add a persitence to the system. | | void | addRemoveListener(Class dOClass, RemovePersistenceListener listener)
Add an remove listener to this persistence manager. | | List | find(PersistenceSession session, String queryName, Object[] queryArguments)
Find a list of value objects, with the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. | | List | find(PersistenceSession session, String queryName, Object[] queryArguments, Integer pageSize, Integer pageNumber)
Find a list of value objects, with the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. | | ValueObject | findInstance(PersistenceSession session, String queryName, Object[] queryArguments)
Find a single value object, using the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. | | Integer | findInteger(PersistenceSession session, String queryName, Object[] queryArguments)
Find a integer property value, using the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. | | String | findString(PersistenceSession session, String queryName, Object[] queryArguments)
Find a string property value, using the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. | | void | remove(PersistenceSession session, ValueObject valueObject)
Remove a single value object from the system.
Parameters:
session - A valid persistence session. | | void | removeAll(PersistenceSession session, String queryName, Object[] queryArguments)
Remove all value objects matching the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. |
| addAddListener | | void addAddListener(Class dOClass, AddPersistenceListener listener)(Code) | | Add an add listener to this persistence manager. This listener will be
invoked whenever a value object of the given type is added to the system.
Parameters:
dOClass - Class to listen for. Whenever a value object of this class(or a subclass of this class) is added, then the listener will beinvoked.
Parameters:
listener - The listener to add. |
| addAmendListener | | void addAmendListener(Class dOClass, AmendPersistenceListener listener)(Code) | | Add an amend listener to this persistence manager. This listener will be
invoked whenever a value object of the given type is amended in the
system.
Parameters:
dOClass - Class to listen for. Whenever a value object of this class(or a subclass of this class) is amended, then the listener will beinvoked.
Parameters:
listener - The listener to add. |
| addFilter | | void addFilter(PersistenceFilter filter)(Code) | | Add a persitence to the system. This filter will be called every time
a value object is read from the persistence store for viewing by a
client.
Parameters:
filter - The filter to be added. |
| addRemoveListener | | void addRemoveListener(Class dOClass, RemovePersistenceListener listener)(Code) | | Add an remove listener to this persistence manager. This listener will be
invoked whenever a value object of the given type is removed from the
system.
Parameters:
dOClass - Class to listen for. Whenever a value object of this class(or a subclass of this class) is removed, then the listener will beinvoked.
Parameters:
listener - The listener to add. |
| find | | List find(PersistenceSession session, String queryName, Object[] queryArguments) throws PersistenceException(Code) | |
Find a list of value objects, with the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. SeePersistenceManager.openSession openSession.
Parameters:
queryName - The name of the query to execute. The actual definitionof the query with this name depends on the implementation of thepersistence manager.
Parameters:
queryArguments - All query arguments in the order in which theyappear in the query text. List of ValueObject instances, matchingthe results of this query.
throws:
PersistenceException - Thrown if the query cannot be performed forany reason. |
| find | | List find(PersistenceSession session, String queryName, Object[] queryArguments, Integer pageSize, Integer pageNumber) throws PersistenceException(Code) | |
Find a list of value objects, with the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. SeePersistenceManager.openSession openSession.
Parameters:
queryName - The name of the query to execute. The actual definitionof the query with this name depends on the implementation of thepersistence manager.
Parameters:
queryArguments - All query arguments in the order in which theyappear in the query text.
Parameters:
pageSize - Maximum number of items to return.
Parameters:
pageNumber - Defines where to start returning. This numbermultiplied by pageSize gives the total number of rowsbefore the first row returned. List of ValueObject instances, matchingthe results of this query.
throws:
PersistenceException - Thrown if the query cannot be performed forany reason. |
| findInstance | | ValueObject findInstance(PersistenceSession session, String queryName, Object[] queryArguments) throws PersistenceException(Code) | |
Find a single value object, using the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. SeePersistenceManager.openSession openSession.
Parameters:
queryName - The name of the query to execute. The actual definitionof the query with this name depends on the implementation of thepersistence manager.
Parameters:
queryArguments - All query arguments in the order in which theyappear in the query text. a single ValueObject matchingthe result of this query.
throws:
PersistenceException - Thrown if the query cannot be performed forany reason. |
| findInteger | | Integer findInteger(PersistenceSession session, String queryName, Object[] queryArguments) throws PersistenceException(Code) | |
Find a integer property value, using the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. SeePersistenceManager.openSession openSession.
Parameters:
queryName - The name of the query to execute. The actual definitionof the query with this name depends on the implementation of thepersistence manager.
Parameters:
queryArguments - All query arguments in the order in which theyappear in the query text. a single Integer matchingthe result of this query.
throws:
PersistenceException - Thrown if the query cannot be performed forany reason. |
| findString | | String findString(PersistenceSession session, String queryName, Object[] queryArguments) throws PersistenceException(Code) | |
Find a string property value, using the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. SeePersistenceManager.openSession openSession.
Parameters:
queryName - The name of the query to execute. The actual definitionof the query with this name depends on the implementation of thepersistence manager.
Parameters:
queryArguments - All query arguments in the order in which theyappear in the query text. a single String matchingthe result of this query.
throws:
PersistenceException - Thrown if the query cannot be performed forany reason. |
| removeAll | | void removeAll(PersistenceSession session, String queryName, Object[] queryArguments) throws PersistenceException(Code) | |
Remove all value objects matching the given query name and arguments.
The meaning of the query name is implementation specific - in the
initialization of your concrete persistence manager, you define
which queries are available.
Parameters:
session - A valid persistence session. SeePersistenceManager.openSession openSession.
Parameters:
queryName - The name of the query to execute. The actual definitionof the query with this name depends on the implementation of thepersistence manager.
Parameters:
queryArguments - All query arguments in the order in which theyappear in the query text.
throws:
PersistenceException - Thrown if the query cannot be performed forany reason. |
|
|