1 /*
2 * Copyright (c) 2007, Fraunhofer-Gesellschaft
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are
7 * met:
8 *
9 * (1) Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the disclaimer at the end.
11 * Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in
13 * the documentation and/or other materials provided with the
14 * distribution.
15 *
16 * (2) Neither the name of Fraunhofer nor the names of its
17 * contributors may be used to endorse or promote products derived
18 * from this software without specific prior written permission.
19 *
20 * DISCLAIMER
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 */
35 package org.ogf.graap.wsag.server.persistence;
36
37
38 /**
39 * This interface encapsulates one or more agreement factory that are loaded with one agreement engine. An
40 * agreement engine is based on one particular WSAG4J configuration, i.e. multiple factories can be exposed
41 * through the persistence layer, where each factory is instantiated on the same engine configuration file.
42 *
43 * @author Oliver Waeldrich
44 *
45 */
46 public interface IAgreementFactoryHome
47 {
48
49 /**
50 * Finds an agreement factory with a given id.
51 *
52 * @param factoryId
53 * ID of the agreement factory.
54 * @return the factory with the given id
55 *
56 * @throws Exception
57 * indicates an exception while loading the factory from the database
58 */
59 PersistentAgreementFactory find( String factoryId ) throws Exception;
60
61 /**
62 * Lists all agreement factories.
63 *
64 * @return List of all agreement factories.
65 *
66 * @throws Exception
67 * indicates an exception while loading the factories from the database
68 */
69 PersistentAgreementFactory[] list() throws Exception;
70
71 /**
72 * Removes the factory with the given ID.
73 *
74 * @param factoryId
75 * ID of the factory to remove.
76 *
77 * @throws Exception
78 * indicates an exception while removing the factory from the database
79 */
80 void remove( String factoryId ) throws Exception;
81
82 /**
83 * @deprecated
84 *
85 * @param factories
86 * List of factories, which should be saved/persisted.
87 *
88 * @throws Exception
89 * indicates an exception while saving the factory in the database
90 */
91 @Deprecated
92 void saveAgreementFactories( PersistentAgreementFactory[] factories ) throws Exception;
93 }