|
@@ -1,9 +1,9 @@ |
1 |
1 |
|
// This Source Code is in the Public Domain per: http://litesoft.org/License.txt |
2 |
2 |
|
package org.litesoft.bo.views; |
3 |
3 |
|
|
4 |
|
- |
import org.litesoft.core.util.*; |
5 |
|
- |
import org.litesoft.core.simpletypes.*; |
6 |
4 |
|
import org.litesoft.bo.views.server.*; |
|
5 |
+ |
import org.litesoft.core.simpletypes.*; |
|
6 |
+ |
import org.litesoft.core.util.*; |
7 |
7 |
|
|
8 |
8 |
|
public interface ServerVoPersister<T extends IViewObject> |
9 |
9 |
|
{ |
|
@@ -13,8 +13,11 @@ |
13 |
13 |
|
|
14 |
14 |
|
/** |
15 |
15 |
|
* Get a single VO based on an ObejctURL |
|
16 |
+ |
* |
16 |
17 |
|
* @param pObjectURL if null, null will be return |
|
18 |
+ |
* |
17 |
19 |
|
* @return single VO found (matches), or null if not found (or pObjectURL is null) |
|
20 |
+ |
* |
18 |
21 |
|
* @throws PersistenceException if there was an underlying exception! |
19 |
22 |
|
*/ |
20 |
23 |
|
T getVOby( ObjectURL pObjectURL ) |
|
@@ -22,9 +25,13 @@ |
22 |
25 |
|
|
23 |
26 |
|
/** |
24 |
27 |
|
* Get a single Matching VO by the supplied criteria. |
|
28 |
+ |
* |
25 |
29 |
|
* @param pORed_ANDFilters - OR the criteria of each map, where each map is the ANDing of the attribute values (Note: if No Maps are given then return ALL) |
|
30 |
+ |
* |
26 |
31 |
|
* @return single VO found (matches), or null if not found |
27 |
|
- |
* @throws MultipleMatchingPersistenceException if the criteria results in more than one row |
|
32 |
+ |
* |
|
33 |
+ |
* @throws MultipleMatchingPersistenceException |
|
34 |
+ |
* if the criteria results in more than one row |
28 |
35 |
|
* @throws PersistenceException if there was an underlying exception! |
29 |
36 |
|
*/ |
30 |
37 |
|
T getMatchingVO( SSMap... pORed_ANDFilters ) |
|
@@ -32,9 +39,12 @@ |
32 |
39 |
|
|
33 |
40 |
|
/** |
34 |
41 |
|
* Get all Matching VO(s) by the supplied criteria (Not to exceed the pMaxToReturn). |
35 |
|
- |
* @param pMaxToReturn if ! null, then if there are more then the pMaxToReturn that match, return none, but indicate how many would have been returned. |
|
42 |
+ |
* |
|
43 |
+ |
* @param pMaxToReturn if ! null, then if there are more then the pMaxToReturn that match, return none, but indicate how many would have been returned. |
36 |
44 |
|
* @param pORed_ANDFilters - OR the criteria of each map, where each map is the ANDing of the attribute values (Note: if No Maps are given then return ALL) |
|
45 |
+ |
* |
37 |
46 |
|
* @return a SizedIterator, if the rows found are <= pMaxToReturn then the size indicated will match the rows returned by iterating, otherwise, the state of the iterator is unspecified. |
|
47 |
+ |
* |
38 |
48 |
|
* @throws PersistenceException if there was an underlying exception! |
39 |
49 |
|
*/ |
40 |
50 |
|
SizedIterator<T> getMatchingVOs( Integer pMaxToReturn, SSMap... pORed_ANDFilters ) |
|
@@ -42,9 +52,12 @@ |
42 |
52 |
|
|
43 |
53 |
|
/** |
44 |
54 |
|
* ACIDly update the Backing Persistence Engine (DB?) with rows from the pTransactionSet. |
45 |
|
- |
* @param pTransactionSet !null |
|
55 |
+ |
* |
|
56 |
+ |
* @param pTransactionSet !null |
46 |
57 |
|
* @param pReturnOnSuccess the SCresult will contain a VO (which may be null) entry for each VO originally in the pTransactionSet whose original ObjectURL matches the entry in this array (dups allowed). |
|
58 |
+ |
* |
47 |
59 |
|
* @return a Relatively complex object that is used to manage Caches. |
|
60 |
+ |
* |
48 |
61 |
|
* @throws PersistenceException if there was an underlying exception! |
49 |
62 |
|
*/ |
50 |
63 |
|
SCresult commit( TransactionSet pTransactionSet, ObjectURL... pReturnOnSuccess ) |