appInterface.php 5.81 KB
Newer Older
Prosper De Laure's avatar
Prosper De Laure committed
1
2
<?php
namespace presentation\maarchRM\UserStory\app;
Dylan's avatar
#6998    
Dylan committed
3
use bundle\organization\Controller\organization;
Prosper De Laure's avatar
Prosper De Laure committed
4
5
6
7
8
9
10
11
12
13
14
15
16

/**
 * Interface for user administration
 */
interface appInterface
{
    /**
     * Welcome page
     *
     * @return recordsManagement/welcome/welcomePage
     */
    public function read();

Cyril Vazquez's avatar
Cyril Vazquez committed
17
18
    /**
     * Folder contents
19
20
21
     * @param string  $originatorOrgRegNumber The organization registration number
     * @param string  $filePlanPosition       The file plan position
     * @param boolean $archiveUnit            List the archive unit
22
     *
23
     * @uses recordsManagement/archives/readList
24
     * @uses recordsManagement/archives/readCountList
25
     *
Cyril Vazquez's avatar
Cyril Vazquez committed
26
27
     * @return recordsManagement/welcome/folderContents
     */
28
    public function readFolder($originatorOrgRegNumber, $filePlanPosition = null, $archiveUnit = false);
29
30
31
32

    /**
     * Retrieve archive info
     *
33
     * @return recordsManagement/archive/getArchiveInfo
34
     * @uses  recordsManagement/archive/readMetadata_archiveId_
35
36
     */
    public function readArchive_archiveId_();
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
    
    /**
     * View the archive
     *
     * @return recordsManagement/archive/getDescription The recordsManagement/archive object
     * @uses  recordsManagement/archiveDescription/read_archiveId_
     */
    public function readRecordsmanagementArchivedescription_archiveId_();

    /**
     * View the archive
     *
     * @return recordsManagement/archive/getArchiveDetails
     * @uses  recordsManagement/archiveDescription/read_archiveId_
     */
    public function readRecordsmanagementArchiveinfo_archiveId_();
53
54
55
56

    /**
     * Retrieve archive contents
     *
57
     * @return recordsManagement/archive/showArchiveTree
58
     * @uses  recordsManagement/archive/readListchildrenarchive_archiveId_
59
     */
60
    public function readArchivecontents_archiveId_();
61
62
63
64
65
66
67
68
69
70
71
72

    /**
     * Retrieve archive info
     *
     * @return recordsManagement/welcome/documentInfo
     */
    public function readDocumentinfo();

    /**
     * Retrieve an archive resource by its id
     *
     * @return recordsManagement/archive/getContents
73
     * @uses  recordsManagement/archive/readConsultation_archiveId_Digitalresource_resId_
74
75
76
77
78
79
80
     */
    public function readRecordsmanagement_archiveId_Digitalresource_resId_();

    /**
     * Display a preview of the contents
     *
     * @return digitalResource/digitalResource/retrieve
81
     * @uses  recordsManagement/archive/readConsultation_archiveId_Digitalresource_resId_
82
83
84
     */
    public function read_archiveId_Digitalresource_resId_();

85
86
    /**
     * Search form
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
     * @param string $archiveId
     * @param string $profileReference
     * @param string $status
     * @param string $archiveName
     * @param string $agreementReference
     * @param string $archiveExpired
     * @param string $finalDisposition
     * @param string $originatorOrgRegNumber
     * @param string $originatorOwnerOrgId
     * @param string $originatorArchiveId
     * @param array  $originatingDate
     * @param string $filePlanPosition
     * @param bool   $hasParent
     * @param string $description
     * @param string $text
     * @param bool   $partialRetentionRule
     * @param string $retentionRuleCode
     * @param string $depositStartDate
     * @param string $depositEndDate
     * @param string $originatingStartDate
     * @param string $originatingEndDate
108
109
     *
     * @uses recordsManagement/archives/read
110
     * @uses recordsManagement/archives/readCount
111
112
113
114
115
116
117
118
119
120
121
122
     *
     * @return recordsManagement/welcome/folderContents
     */
    public function readRecordsmanagementArchivesSearch(
        $archiveId = null,
        $profileReference = null,
        $status = null,
        $archiveName = null,
        $agreementReference = null,
        $archiveExpired = null,
        $finalDisposition = null,
        $originatorOrgRegNumber = null,
Dylan's avatar
Dylan committed
123
        $originatorOwnerOrgId = null,
124
125
126
127
        $originatorArchiveId = null,
        $originatingDate = null,
        $filePlanPosition = null,
        $hasParent = null,
128
        $description = null,
129
130
131
132
133
134
135
        $text = null,
        $partialRetentionRule = null,
        $retentionRuleCode = null,
        $depositStartDate = null,
        $depositEndDate = null,
        $originatingStartDate = null,
        $originatingEndDate = null
136
137
    );

138
139
140
141
142
143
144
145
146
147
    /**
     * Move an archive into a folder
     * @param array  $archiveIds   The archive identifier list
     * @param string $fromFolderId The originating folder identifier
     * @param string $toFolderId   The destination folder identifier
     * 
     * @return recordsManagement/welcome/moveArchivesToFolder
     * @uses recordsManagement/archives/udpateMovearchivestofolder
     */
    public function updateArchivesMovetofolder($archiveIds, $fromFolderId=null, $toFolderId=null);
148
149
150
151
152
153
154
155

    /**
     * Search formats
     *
     * @uses digitalResource/format/readFind_query_
     * @return digitalResource/format/find
     */
    public function readDigitalresourceFormatFind_query_();
Dylan's avatar
Dylan committed
156
157
158
159
160
161
162
163

    /**
     * Get the organizations' list
     *
     * @return organization/orgTree/orgList
     * @uses organization/organization/readTodisplay
     */
    public function readOrganizationsTodisplay();
Dylan's avatar
#6295    
Dylan committed
164

Dylan's avatar
#6998    
Dylan committed
165
166
167
168
169
170
171
172
    /**
     * Get the organizations' list
     *
     * @return organization/orgTree/orgList
     * @uses organization/organization/readTodisplayOrgUnit
     */
    public function readOrganizationsTodisplayorgunit();

Dylan's avatar
#6295    
Dylan committed
173
174
175
176
177
178
    /**
     * Get the producer' list
     *
     * @uses organization/organization/readOriginator
     */
    public function readOriginator();
179
180

    /**
181
     * Search a reference or get the entire ref list
182
183
     * @param string $query
     *
184
     * @uses recordsManagement/descriptionRef/read_name_
185
     */
186
    public function readDescriptionref_name_($query = null);
187
188

    /**
189
     * Get one ref entry by its key
190
     *
191
     * @uses recordsManagement/descriptionRef/read_name__key_
192
     */
193
    public function readDescriptionref_name__key_();
Prosper De Laure's avatar
Prosper De Laure committed
194
}