archivalProfile.php 2.85 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
<?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\Message;
Alexis Ragot's avatar
Alexis Ragot committed
21

Prosper De Laure's avatar
Prosper De Laure committed
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
/**
 * Class model that represents an archival profile
 *
 * @package RecordsManagement
 * @author  Prosper DE LAURE (Maarch) <prosper.delaure@maarch.org>
 */
class archivalProfile
{
    /**
     * The identifier
     *
     * @var id
     */
    public $archivalProfileId;

    /**
     * The reference
     *
     * @var string
41
     * @pattern #^[A-Za-z][A-Za-z0-9_-]*$#
Dylan's avatar
#6581    
Dylan committed
42
     * @notempty
Prosper De Laure's avatar
Prosper De Laure committed
43
44
45
46
47
48
49
50
51
52
53
     */
    public $reference;

    /**
     * The name
     *
     * @var string
     */
    public $name;

    /**
Alexis Ragot's avatar
Alexis Ragot committed
54
     * The description of the rule
Prosper De Laure's avatar
Prosper De Laure committed
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
     *
     * @var string
     */
    public $description;

    /**
     * The archive description schema
     *
     * @var string
     */
    public $descriptionSchema;

    /**
     * The archive description class
     *
     * @var string
     */
    public $descriptionClass;

    /**
Alexis Ragot's avatar
Alexis Ragot committed
75
     * The starting date of the retention rule calculation
Prosper De Laure's avatar
Prosper De Laure committed
76
77
78
79
80
     *
     * @var string
     */
    public $retentionStartDate;

81
    /**
Mathieu's avatar
Mathieu committed
82
     * The starting date of calculated retention rule based on last deposit date
83
84
85
86
87
     *
     * @var boolean
     */
    public $isRetentionLastDeposit;

Prosper De Laure's avatar
Prosper De Laure committed
88
    /**
Alexis Ragot's avatar
Alexis Ragot committed
89
     * The retention rule code
Prosper De Laure's avatar
Prosper De Laure committed
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
     *
     * @var string
     */
    public $retentionRuleCode;

    /**
     *  The access code
     *
     * @var string
     */
    public $accessRuleCode;


    /**
     * The document accepts user custom indexes
     *
     * @var boolean
     */
    public $acceptUserIndex;

110
111
112
113
114
115
116
    /**
     * The archive accepts sub archive without profile
     *
     * @var boolean
     */
    public $acceptArchiveWithoutProfile;

117
118
119
120
121
122
123
    /**
     * The archive description level
     *
     * @var string
     */
    public $fileplanLevel;

Prosper De Laure's avatar
Prosper De Laure committed
124
125
126
127
128
129
    /**
     *  The list of profile description
     *
     * @var recordsManagement/archiveDescription[]
     */
    public $archiveDescription = array();
130
131
132
133
134
135
136

    /**
     *  The list of child archival profiles
     *
     * @var array
     */
    public $containedProfiles = array();
137
138
139

    /**
     * The processing statuses, actions and views
Alexandre Goldstein's avatar
Alexandre Goldstein committed
140
     * @var json
141
142
     */
    public $processingStatuses;
Alexis Ragot's avatar
Alexis Ragot committed
143
}