1 /*
2 * #%L
3 * Bitrepository Access
4 *
5 * $Id$
6 * $HeadURL$
7 * %%
8 * Copyright (C) 2010 - 2012 The State and University Library, The Royal Library and The State Archives, Denmark
9 * %%
10 * This program is free software: you can redistribute it and/or modify
11 * it under the terms of the GNU Lesser General Public License as
12 * published by the Free Software Foundation, either version 2.1 of the
13 * License, or (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Lesser Public License for more details.
19 *
20 * You should have received a copy of the GNU General Lesser Public
21 * License along with this program. If not, see
22 * <http://www.gnu.org/licenses/lgpl-2.1.html>.
23 * #L%
24 */
25 package org.bitrepository.access.getaudittrails;
26
27 import org.bitrepository.client.BitrepositoryClient;
28 import org.bitrepository.client.eventhandler.EventHandler;
29
30 public interface AuditTrailClient extends BitrepositoryClient {
31 /**
32 * @param collectionID The collection to request audit trails for.
33 * @param componentQueries Defines which components to retrieve audit trail from. Also defines a filter which
34 * can be used to limit the audit trail result from each pillar. If null all audit trails
35 * from all contributers are returned.
36 * @param fileID The optional fileID to retrieve audit trails for. If <code>null</code> audit trail are retrieved for
37 * all files.
38 * @param urlForResult If defined, the result is upload to this url (with a -componentID postfix) in stead of being
39 * returned in a completeEvent.
40 * @param eventHandler The handler which should receive notifications of the progress events.
41 * @param auditTrailInformation The audit information for the given operation. E.g. who is behind the operation call.
42 */
43 void getAuditTrails(
44 String collectionID,
45 AuditTrailQuery[] componentQueries,
46 String fileID,
47 String urlForResult,
48 EventHandler eventHandler, String auditTrailInformation);
49 }