1 /*
2 * Copyright (c) 2002-2022, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.plugins.workflow.modules.archive.service;
35
36 import fr.paris.lutece.plugins.workflow.modules.archive.business.ArchiveConfig;
37 import fr.paris.lutece.plugins.workflow.modules.archive.business.ArchiveResource;
38 import fr.paris.lutece.plugins.workflowcore.business.resource.ResourceWorkflow;
39 import fr.paris.lutece.plugins.workflowcore.service.task.ITask;
40
41 /**
42 * Service for Archive Task
43 */
44 public interface IArchiveService
45 {
46
47 /**
48 * Load config of task.
49 *
50 * @param task
51 * @return
52 */
53 ArchiveConfig loadConfig( ITask task );
54
55 /**
56 * Load the {@link ArchiveResource}
57 *
58 * @param nIdHistory
59 * @param nIdTask
60 * @return ArchiveResource
61 */
62 ArchiveResource getArchiveResource( int nIdHistory, int nIdTask );
63
64 /**
65 * Creates the Archive Resource.
66 *
67 * @param resourceWorkflow
68 * @param config
69 */
70 void createArchiveResource( ResourceWorkflow resourceWorkflow, ArchiveConfig config );
71
72 /**
73 * Determines if a resource is up for archival. <br>
74 *
75 * @param resourceWorkflow
76 * @param config
77 * @return true if the resource should be archived
78 */
79 boolean isResourceUpForArchival( ResourceWorkflow resourceWorkflow, ArchiveConfig config );
80
81 /**
82 * Get resource owning the history
83 *
84 * @param nIdHistory
85 * @return
86 */
87 ResourceWorkflow getResourceWorkflowByHistory( int nIdHistory );
88
89 /**
90 * Archives the resource according to the specified config
91 *
92 * @param resourceWorkflow
93 * @param task
94 * @param config
95 */
96 void archiveResource( ResourceWorkflow resourceWorkflow, ITask task, ArchiveConfig config );
97
98 /**
99 * Delete the {@link ArchiveResource} by idResource
100 *
101 * @param idResource
102 * @param idTask
103 */
104 void removeArchiveResource( int idResource, int idTask );
105
106 /**
107 * Deletes the config for the task.
108 *
109 * @param task
110 */
111 void removeConfig( ITask task );
112 }