logInterface.php 3.18 KB
Newer Older
Prosper De Laure's avatar
Prosper De Laure committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
<?php
/*
 * Copyright (C) 2015 Maarch
 *
 * This file is part of bundle recordsManagement.
 *
 * Bundle recordsManagement is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Bundle recordsManagement is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with bundle recordsManagement.  If not, see <http://www.gnu.org/licenses/>.
 */
namespace bundle\recordsManagement;
/**
 * Standard interface for log archive description class
 */
interface logInterface
25
{
Prosper De Laure's avatar
Prosper De Laure committed
26
27
    /**
     * Get a  search result
28
29
30
31
32
33
34
35
36
37
     *
     * @param string  $archiveId   The archive identifier
     * @param string  $type        The type
     * @param date    $fromDate    The date
     * @param date    $toDate      The date
     * @param string  $processName The process name
     * @param string  $processId   The process identifier
     * @param string  $sortBy      The process identifier
     * @param integer $maxResults  Max number of results to return
     *
Prosper De Laure's avatar
Prosper De Laure committed
38
39
     * @action recordsManagement/log/find
     */
40
    public function readFind(
Alexandre Morin's avatar
Alexandre Morin committed
41
42
43
44
45
46
47
        $archiveId = null,
        $type = null,
        $fromDate = null,
        $toDate = null,
        $processName = null,
        $processId = null,
        $sortBy = ">fromDate",
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
        $maxResults = null
    );

    /**
     * Count search results
     *
     * @param string  $archiveId   The archive identifier
     * @param string  $type        The type
     * @param date    $fromDate    The date
     * @param date    $toDate      The date
     * @param string  $processName The process name
     * @param string  $processId   The process identifier

     * @action recordsManagement/log/countFind
     */
    public function countFind(
        $archiveId = null,
        $type = null,
        $fromDate = null,
        $toDate = null,
        $processName = null,
        $processId = null
Alexandre Morin's avatar
Alexandre Morin committed
70
    );
71

Prosper De Laure's avatar
Prosper De Laure committed
72
73
74
75
76
77
78
79
80
81
82
    /**
     * Deposit a log file
     * @param string    $journalFileName   The name of the journal to deposit
     * @param timestamp $fromDate          The journal start date
     * @param timestamp $toDate            The journal end date
     * @param string    $type              The tye of the journal (system, lifeCycle, application)
     * @param string    $processName       The journal process name
     * @param string    $timestampFileName The name of the timestamp file
     *
     * @action recordsManagement/log/depositJournal
     */
Alexandre Morin's avatar
Alexandre Morin committed
83
84
85
86
87
88
89
90
    public function createDepositjournal(
        $journalFileName,
        $fromDate,
        $toDate,
        $type,
        $processName = null,
        $timestampFileName = null
    );
Alexandre Morin's avatar
Alexandre Morin committed
91
92
93
94
95
96
97
98

    /**
     * @param string $archiveId     Archiver identifier
     * @param string $resourceId    Resource identifier
     *
     * @action recordsManagement/log/contents
     */
    public function contents_type__archiveId__resourceId_();
Prosper De Laure's avatar
Prosper De Laure committed
99
}