1. Project Clover database Tue Dec 20 2016 21:24:09 CET
  2. Package org.xwiki.extension.job.history

File ExtensionJobHistory.java

 

Code metrics

0
0
0
1
54
11
0
-
-
0
-

Classes

Class Line # Actions
ExtensionJobHistory 34 0 - 0 0
-1.0 -
 

Contributing tests

No tests hitting this source file were found.

Source view

1    /*
2    * See the NOTICE file distributed with this work for additional
3    * information regarding copyright ownership.
4    *
5    * This is free software; you can redistribute it and/or modify it
6    * under the terms of the GNU Lesser General Public License as
7    * published by the Free Software Foundation; either version 2.1 of
8    * the License, or (at your option) any later version.
9    *
10    * This software is distributed in the hope that it will be useful,
11    * but WITHOUT ANY WARRANTY; without even the implied warranty of
12    * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13    * Lesser General Public License for more details.
14    *
15    * You should have received a copy of the GNU Lesser General Public
16    * License along with this software; if not, write to the Free
17    * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
18    * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
19    */
20    package org.xwiki.extension.job.history;
21   
22    import java.util.List;
23   
24    import org.apache.commons.collections4.Predicate;
25    import org.xwiki.component.annotation.Role;
26   
27    /**
28    * The history of extension jobs.
29    *
30    * @version $Id: ab51d105473c10c01ff8b222f9a1169f073d82aa $
31    * @since 7.1RC1
32    */
33    @Role
 
34    public interface ExtensionJobHistory
35    {
36    /**
37    * Adds a new record to the history.
38    *
39    * @param record the record to add
40    */
41    void addRecord(ExtensionJobHistoryRecord record);
42   
43    /**
44    * Returns the history records that match the given filter after the specified offset record.
45    *
46    * @param filter the predicate used to filter the history records
47    * @param offsetRecordId specifies the offset record (where to start from); pass {@code null} to start from the most
48    * recent record in the history
49    * @param limit the maximum number of records to return from the specified offset
50    * @return a list of history records that match the given filter and are older than the specified offset record
51    */
52    List<ExtensionJobHistoryRecord> getRecords(Predicate<ExtensionJobHistoryRecord> filter, String offsetRecordId,
53    int limit);
54    }