1 /*
2 * Copyright (c) 2002-2021, 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.rest.service;
35
36 import fr.paris.lutece.plugins.workflowcore.business.action.Action;
37 import fr.paris.lutece.plugins.workflowcore.business.action.ActionFilter;
38 import fr.paris.lutece.plugins.workflowcore.business.resource.ResourceWorkflow;
39 import fr.paris.lutece.plugins.workflowcore.business.resource.ResourceWorkflowFilter;
40 import fr.paris.lutece.plugins.workflowcore.business.state.State;
41 import fr.paris.lutece.plugins.workflowcore.business.workflow.Workflow;
42
43 import java.util.List;
44
45 /**
46 *
47 * IWorkflowRestService
48 *
49 */
50 public interface IWorkflowRestService
51 {
52 /**
53 * Get the workflow
54 *
55 * @param nIdWorkflow
56 * the id workflow
57 * @return the workflow
58 */
59 Workflow getWorkflow( int nIdWorkflow );
60
61 /**
62 * Get the list of workflows
63 *
64 * @return the list of workflows
65 */
66 List<Workflow> getWorkflowsList( );
67
68 /**
69 * Get the state
70 *
71 * @param nIdState
72 * the id state
73 * @return the state
74 */
75 State getState( int nIdState );
76
77 /**
78 * Get the list of states
79 *
80 * @return the list of states
81 */
82 List<State> getStatesList( );
83
84 /**
85 * Get the action
86 *
87 * @param nIdAction
88 * the id action
89 * @return the action
90 */
91 Action getAction( int nIdAction );
92
93 /**
94 * Get the list of actions
95 *
96 * @return the list of actions
97 */
98 List<Action> getActionsList( );
99
100 /**
101 * Get the resource workflow
102 *
103 * @param nIdResource
104 * the id resource
105 * @param strResourceType
106 * the resource type
107 * @param nIdWorkflow
108 * the id workflow
109 * @return the resource workflow
110 */
111 ResourceWorkflow getResourceWorkflow( int nIdResource, String strResourceType, int nIdWorkflow );
112
113 /**
114 * Select ResourceWorkflow by filter
115 *
116 * @param resourceWorkflowFilter
117 * the filter
118 * @return ResourceWorkflow List
119 */
120 List<ResourceWorkflow> getListResourceWorkflowByFilter( ResourceWorkflowFilter resourceWorkflowFilter );
121
122 /**
123 * Select actions by filter
124 *
125 * @param filter
126 * the action filter
127 * @return Action List
128 */
129 List<Action> getListActionByFilter( ActionFilter filter );
130 }