Package com.simplicite.webapp.services
Class RESTMappedObjectsExternalObject
- java.lang.Object
-
- com.simplicite.util.ExternalObject
-
- com.simplicite.webapp.services.RESTServiceExternalObject
-
- com.simplicite.webapp.services.RESTMappedObjectsExternalObject
-
- All Implemented Interfaces:
CacheInterface
,java.io.Serializable
public abstract class RESTMappedObjectsExternalObject extends RESTServiceExternalObject
REST service external object dedicated to mapped business object services- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DESC_HIDDEN_FROM_SCHEMA
Hidden description, means hiding from the schemasstatic java.lang.String
OPERATION_CREATE
Create operationstatic java.lang.String
OPERATION_DELETE
Delete operationstatic java.lang.String
OPERATION_GET
Get operationstatic java.lang.String
OPERATION_PING
Ping operationstatic java.lang.String
OPERATION_SEARCH
Search operationstatic java.lang.String
OPERATION_UPDATE
Update operation-
Fields inherited from class com.simplicite.util.ExternalObject
DEFAUT_MIME_TYPE
-
-
Constructor Summary
Constructors Constructor Description RESTMappedObjectsExternalObject()
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addField(java.lang.String name, java.lang.String field, java.lang.String fieldName)
Add a field mappingvoid
addField(java.lang.String name, java.lang.String field, java.lang.String fieldName, java.lang.String desc, java.lang.String example)
Add a field mappingvoid
addObject(java.lang.String name, java.lang.String objName)
Add an object mappingvoid
addObject(java.lang.String name, java.lang.String objName, java.lang.String desc)
Add an object mappingvoid
addOperationDesc(java.lang.String name, java.lang.String op, java.lang.String desc)
Add a description for operationvoid
addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName)
Add a reference field mappingvoid
addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName, java.lang.String desc)
Add a reference field mappingvoid
addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName, java.lang.String linkName, boolean embeddedLink, java.lang.String desc)
Add a reference field mappingjava.lang.String
getOpenAPIBasePath()
Get OpenAPI base pathjava.lang.String
getOpenAPIDesc()
Get OpenAPI descriptionint
getOpenAPISpec()
Get OpenAPI specificationjava.lang.String
getOpenAPIVers()
Get OpenAPI versionint
getOpenAPIVersion()
Deprecated.Use getOpenAPISpecvoid
setOpenAPIBasePath(java.lang.String basePath)
Set base path (defauts to /api/) void
setOpenAPIDesc(java.lang.String desc)
Set description (defauts to external objet description)void
setOpenAPISpec(int spec)
Set OpenAPI specificationvoid
setOpenAPIVers(java.lang.String version)
Set version (defauts to external objet name)void
setOpenAPIVersion(int spec)
Deprecated.Use setOpenAPISpec-
Methods inherited from class com.simplicite.webapp.services.RESTServiceExternalObject
display
-
Methods inherited from class com.simplicite.util.ExternalObject
addChartjs, addExtraCSS, addExtraCSS, addExtraJS, addExtraJS, addFullCalendar, addJQPlot, addMarkdown, addMustache, addSharedScript, addVue, appendChartjs, appendCSSInclude, appendCSSIncludes, appendFullCalendar, appendJQPlot, appendJSInclude, appendJSIncludes, appendMarkdown, appendMustache, appendVue, enableGC, evalExpression, garbageCollection, getBooleanParameter, getCacheKey, getClassName, getConsole, getContentDisposition, getCSSResources, getDesc, getDisplay, getDoubleParameter, getExtraCSS, getExtraJS, getFlagParameter, getFloatParameter, getGrant, getHelp, getHTML, getHTMLResources, getHTTPStatus, getIconCode, getId, getImageResources, getIntParameter, getJSResources, getLabel, getLongParameter, getMaxAge, getMimeType, getMIMEType, getModuleId, getModuleName, getName, getObjectParameter, getParameter, getParameter, getResource, getResourceContent, getResourceCSSContent, getResourceCSSURL, getResourceHTMLContent, getResourceHTMLURL, getResourceJSContent, getResourceJSURL, getResourcePDFContent, getResourcePDFURL, getResources, getResourceURL, getRoot, getScriptId, getSharedScripts, getTarget, getURL, hasDecoration, hasJSGlobals, hasJSParameters, hasResources, hasTitle, httpRedirect, invokeAction, invokeAction, invokeAction, invokeAction, isJavaImplemented, isPublic, javascript, lastUsage, prepareExpression, readScript, redirect, removeParameter, removeParameters, sendHttpRedirect, sendJavaScript, sendRedirect, setClassName, setConsole, setContentDisposition, setCSVMIMEType, setDecoration, setDisplay, setGrant, setHelp, setHTML, setHTMLMIMEType, setHTTPStatus, setIconCode, setId, setJavaImplemented, setJSGlobals, setJSONMIMEType, setJSParameters, setLabel, setMaxAge, setMimeType, setMIMEType, setModuleId, setModuleName, setMSExcelMIMEType, setMSPowerPointMIMEType, setMSWordMIMEType, setName, setParameter, setParameter, setParameter, setParameter, setParameter, setParameter, setPDFMIMEType, setPublic, setResources, setRoot, setScriptId, setTarget, setTextMIMEType, setTitle, setTSVMIMEType, setURL, setUseCalculator, setUseCalendar, setUseCharts, setUseCompletion, setUseHTMLEditor, setUseTreeview, setXMLMIMEType, setYAMLMIMEType, setZIPMIMEType, toJSONObject, toString, unitTests, useCalculator, useCalendar, useCharts, useCompletion, useHTMLEditor, useTreeview
-
-
-
-
Field Detail
-
DESC_HIDDEN_FROM_SCHEMA
public static final java.lang.String DESC_HIDDEN_FROM_SCHEMA
Hidden description, means hiding from the schemas- See Also:
- Constant Field Values
-
OPERATION_PING
public static final java.lang.String OPERATION_PING
Ping operation- See Also:
- Constant Field Values
-
OPERATION_SEARCH
public static final java.lang.String OPERATION_SEARCH
Search operation- See Also:
- Constant Field Values
-
OPERATION_GET
public static final java.lang.String OPERATION_GET
Get operation- See Also:
- Constant Field Values
-
OPERATION_CREATE
public static final java.lang.String OPERATION_CREATE
Create operation- See Also:
- Constant Field Values
-
OPERATION_UPDATE
public static final java.lang.String OPERATION_UPDATE
Update operation- See Also:
- Constant Field Values
-
OPERATION_DELETE
public static final java.lang.String OPERATION_DELETE
Delete operation- See Also:
- Constant Field Values
-
-
Method Detail
-
addObject
public void addObject(java.lang.String name, java.lang.String objName)
Add an object mapping- Parameters:
name
- Mapped object name (e.g. users mapped to User)objName
- Business object name (e.g. User)
-
addObject
public void addObject(java.lang.String name, java.lang.String objName, java.lang.String desc)
Add an object mapping- Parameters:
name
- Mapped object name (e.g. users mapped to User)objName
- Business object name (e;g. User)desc
- Optional description (defaults to configured object description, using DESC_HIDDEN constant hides object from the schemas)
-
addOperationDesc
public void addOperationDesc(java.lang.String name, java.lang.String op, java.lang.String desc)
Add a description for operation- Parameters:
name
- Object name (may be null)op
- Operation name (one of OPERATION_* constant)desc
- Description
-
addField
public void addField(java.lang.String name, java.lang.String field, java.lang.String fieldName)
Add a field mapping- Parameters:
name
- Mapped object name (e.g. users)field
- Mapped field name (e.g. login)fieldName
- Actual business object field name (e.g. usr_login)
-
addField
public void addField(java.lang.String name, java.lang.String field, java.lang.String fieldName, java.lang.String desc, java.lang.String example)
Add a field mapping- Parameters:
name
- Mapped object name (e.g. users)field
- Mapped field name (e.g. login)fieldName
- Actual business object field name (e.g. usr_login)desc
- Optional description (defaults to configured field description)example
- Optional example value
-
addRefField
public void addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName)
Add a reference field mapping- Parameters:
name
- Mapped object name (e.g. resps mapped to Responsability)refName
- Mapped referenced object name (e.g. users mapped to User)refField
- Mapped reference field name (e.g. userId)refFieldName
- Actual business object reference field name (e.g. rsp_login_id)
-
addRefField
public void addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName, java.lang.String desc)
Add a reference field mapping- Parameters:
name
- Mapped object name (e.g. resps mapped to Responsability)refName
- Mapped referenced object name (e.g. users mapped to User)refField
- Mapped reference field name (e.g. userId)refFieldName
- Actual business object reference field name (e.g. rsp_login_id)desc
- Optional description (defaults to configured reference field description)
-
addRefField
public void addRefField(java.lang.String name, java.lang.String refName, java.lang.String refField, java.lang.String refFieldName, java.lang.String linkName, boolean embeddedLink, java.lang.String desc)
Add a reference field mapping- Parameters:
name
- Mapped object name (e.g. resps mapped to Responsability)refName
- Mapped referenced object name (e.g. users mapped to User)refField
- Mapped reference field name (e.g. userId)refFieldName
- Actual business object reference field name (e.g. rsp_login_id)linkName
- Optional link name (e.g. userResps)embeddedLink
- Embedded link?desc
- Optional description (defaults to configured reference field description)
-
getOpenAPISpec
public int getOpenAPISpec()
Get OpenAPI specification- Returns:
- OpenAPI specification (one of JSONTool.OPENAPI_*)
-
getOpenAPIVersion
@Deprecated public int getOpenAPIVersion()
Deprecated.Use getOpenAPISpec
-
setOpenAPISpec
public void setOpenAPISpec(int spec)
Set OpenAPI specification- Parameters:
spec
- OpenAPI specification (one of JSONTool.OPENAPI_*)
-
setOpenAPIVersion
@Deprecated public void setOpenAPIVersion(int spec)
Deprecated.Use setOpenAPISpec
-
setOpenAPIDesc
public void setOpenAPIDesc(java.lang.String desc)
Set description (defauts to external objet description)- Parameters:
desc
- OpenAPI description
-
getOpenAPIDesc
public java.lang.String getOpenAPIDesc()
Get OpenAPI description- Returns:
- OpenAPI description
-
setOpenAPIVers
public void setOpenAPIVers(java.lang.String version)
Set version (defauts to external objet name)- Parameters:
version
- OpenAPI version
-
getOpenAPIVers
public java.lang.String getOpenAPIVers()
Get OpenAPI version- Returns:
- OpenAPI version
-
setOpenAPIBasePath
public void setOpenAPIBasePath(java.lang.String basePath)
Set base path (defauts to /api/) - Parameters:
basePath
- OpenAPI base path
-
getOpenAPIBasePath
public java.lang.String getOpenAPIBasePath()
Get OpenAPI base path- Returns:
- basePath OpenAPI base path
-
-