01: /*
02: * Copyright 2004-2006 the original author or authors.
03: *
04: * Licensed under the Apache License, Version 2.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.apache.org/licenses/LICENSE-2.0
09: *
10: * Unless required by applicable law or agreed to in writing, software
11: * distributed under the License is distributed on an "AS IS" BASIS,
12: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13: * See the License for the specific language governing permissions and
14: * limitations under the License.
15: */
16:
17: package org.compass.core;
18:
19: /**
20: * Simple convenience class for the CompassCallback implementation. Allows
21: * implementing a doInCompass version without a result, i.e without the need for
22: * a return statement.
23: *
24: * @author kimchy
25: */
26: public abstract class CompassCallbackWithoutResult implements
27: CompassCallback<Object> {
28:
29: public Object doInCompass(CompassSession session)
30: throws CompassException {
31: doInCompassWithoutResult(session);
32: return null;
33: }
34:
35: /**
36: * Gets called by <code>CompassTemplate.execute</code> with an active
37: * Compass Session. Does not need to care about activating or closing the
38: * Session, or handling transactions.
39: *
40: * <p>If called without a thread-bound Compass transaction (initiated by an
41: * outer compass transaction abstraction), the code will simply get executed
42: * on the outer compass transaction with its transactional semantics.
43: *
44: * @param session
45: * @throws CompassException
46: */
47: protected abstract void doInCompassWithoutResult(
48: CompassSession session) throws CompassException;
49: }
|