Repository navigation
Expand file tree
/
Copy pathIFunctionEngine.java
More file actions
143 lines (126 loc) · 4.12 KB
/
Copy pathIFunctionEngine.java
File metadata and controls
143 lines (126 loc) · 4.12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
/*******************************************************************************
* Copyright 2015 Defense Health Agency (DHA)
*
* If your use of this software does not include any GPLv2 components:
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* ----------------------------------------------------------------------------
* If your use of this software includes any GPLv2 components:
* This program 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 2
* of the License, or (at your option) any later version.
*
* This program 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.
*******************************************************************************/
package prerna.engine.api;
import java.util.List;
import java.util.Map;
import java.util.Properties;
import prerna.auth.AccessPermissionEnum;
import prerna.engine.impl.function.FunctionParameter;
import prerna.logging.IgnoreEngineLogging;
public interface IFunctionEngine extends IEngine {
// this is what the FE sends for the type of storage we are creating
// as a result, cannot be a key in the smss file
String FUNCTION_TYPE = "FUNCTION_TYPE";
String NAME_KEY = "FUNCTION_NAME";
String DESCRIPTION_KEY = "FUNCTION_DESCRIPTION";
String PARAMETER_KEY = "FUNCTION_PARAMETERS";
String REQUIRED_PARAMETER_KEY = "FUNCTION_REQUIRED_PARAMETERS";
String PYTHON_FILE_NAME = "PYTHON_FILE_NAME";
/**
*
* @param args
* @return
*/
@EngineAccess(AccessPermissionEnum.READ_ONLY)
Object execute(Map<String, Object> parameterValues);
/**
* Unique name of the function
*
* @return
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.READ_ONLY)
String getFunctionName();
/**
*
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.OWNER)
void setFunctionName(String functionName);
/**
* Description of what this function does
*
* @return
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.READ_ONLY)
String getFunctionDescription();
/**
* The function's type, its {@link #FUNCTION_TYPE} setting.
*
* @return the function type, or null when its settings name none
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.READ_ONLY)
default String getFunctionType() {
Properties smssProp = getSmssProp();
return smssProp == null ? null : smssProp.getProperty(FUNCTION_TYPE);
}
/**
*
* @param description
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.OWNER)
void setFunctionDescription(String description);
/**
*
* @return
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.READ_ONLY)
List<FunctionParameter> getParameters();
/**
*
* @param parameters
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.OWNER)
void setParameters(List<FunctionParameter> parameters);
/**
*
* @return
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.READ_ONLY)
List<String> getRequiredParameters();
/**
*
* @param requiredParameters
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.OWNER)
void setRequiredParameters(List<String> requiredParameters);
/**
*
* @return
*/
@IgnoreEngineLogging
@EngineAccess(AccessPermissionEnum.READ_ONLY)
org.json.JSONObject getFunctionDefintionJson();
}