public interface Message
Message
s can be used to pass additional information along with the response.
Some clients such as Fiori UIs provide controls to show these messages in a user friendly way.Modifier and Type | Interface and Description |
---|---|
static class |
Message.Severity
Severity levels.
|
Modifier and Type | Method and Description |
---|---|
Message |
code(String code)
Adds the passed
code to the current message. |
static Message |
create(Message.Severity severity,
String text)
This method creates a standalone instance of
Message that is not added to the Messages of the active RequestContext . |
static Message |
create(Message.Severity severity,
String text,
Message message)
This method creates a standalone instance of
Message that is not added to the Messages of the active RequestContext . |
static Message |
create(String text,
ServiceException exception)
This method creates a standalone instance of
Message that is not added to the Messages of the active RequestContext . |
String |
getCode()
The optional code of the message
|
String |
getLongTextUrl()
The optional long text url
|
String |
getMessage()
The localized message
|
Message.Severity |
getSeverity()
The severity of the message.
|
MessageTarget |
getTarget()
The optional
MessageTarget |
Message |
longTextUrl(String longTextUrl)
Adds the passed
longTextUrl to the current message. |
<E extends com.sap.cds.ql.StructuredType<E>> |
target(Class<E> type,
Function<E,Object> path)
Adds the passed path as target to the current
Message . |
Message |
target(Function<com.sap.cds.ql.StructuredType<?>,Object> path)
Adds the passed path as target to the current
Message . |
Message |
target(com.sap.cds.ql.cqn.Path path,
com.sap.cds.reflect.CdsElement element)
Adds the passed path and element as target to the current
Message . |
Message |
target(String target)
Sets the provided string-based target.
|
<E extends com.sap.cds.ql.StructuredType<E>> |
target(String parameter,
Class<E> type,
Function<E,Object> path)
Adds the passed target parameter and path as target to the current
Message . |
Message |
target(String parameter,
Function<com.sap.cds.ql.StructuredType<?>,Object> path)
Adds the passed target parameter and path as target to the current
Message . |
Message |
target(String prefix,
String entity,
Function<com.sap.cds.ql.StructuredType<?>,Object> path)
Deprecated.
no longer supported, use
target(String, Function) instead. |
static Message create(Message.Severity severity, String text)
Message
that is not added to the Messages
of the active RequestContext
.severity
- the Message.Severity
of the Message
text
- the final text of the message. For localization use CdsRuntime.getLocalizedMessage(String, Object[], Locale)
explicitly.Message
instance.static Message create(Message.Severity severity, String text, Message message)
Message
that is not added to the Messages
of the active RequestContext
.severity
- the Message.Severity
of the Message
text
- the final text of the message. For localization use CdsRuntime.getLocalizedMessage(String, Object[], Locale)
explicitly.message
- the Message
to copy optional arguments fromMessage
instancestatic Message create(String text, ServiceException exception)
Message
that is not added to the Messages
of the active RequestContext
.text
- the final text of the message. For localization use CdsRuntime.getLocalizedMessage(String, Object[], Locale)
explicitly.exception
- the ServiceException
to copy optional arguments fromMessage
instanceString getCode()
String getMessage()
MessageTarget getTarget()
MessageTarget
MessageTarget
String getLongTextUrl()
Message.Severity getSeverity()
Message longTextUrl(String longTextUrl)
longTextUrl
to the current message.longTextUrl
- The long text url to be setMessage code(String code)
code
to the current message.code
- The code to be setMessage target(String target)
target
- the string-based targetMessage target(Function<com.sap.cds.ql.StructuredType<?>,Object> path)
Message
.
The path is interpreted relative to the CQN statement, which was determined from the request.
For CRUD events this CQN statement points to the targeted entity.
For bound actions or functions this CQN statement points to the bound entity.
Is equivalent to calling target(MessageTarget.PARAMETER_CQN, path)
path
- the path to the target element or associationMessage target(String parameter, Function<com.sap.cds.ql.StructuredType<?>,Object> path)
Message
.parameter
- target parameter serving as the entry point for the path resolution.
Passing MessageTarget.PARAMETER_CQN
indicates that the path
should be interpreted relatively to the target entity of the request.
Alternatively you can pass names of action or function parameters.path
- the path to the target element or association@Deprecated Message target(String prefix, String entity, Function<com.sap.cds.ql.StructuredType<?>,Object> path)
target(String, Function)
instead.Message
.prefix
- the string-based prefix, prepended to the CQN pathentity
- the root entity of the pathpath
- the path to the target element or association<E extends com.sap.cds.ql.StructuredType<E>> Message target(Class<E> type, Function<E,Object> path)
Message
.
This method allows to build the path in a type-safe way, by passing the corresponding entity or structured type interface.
The path is interpreted relative to the CQN statement, which was determined from the request.
For CRUD events this CQN statement points to the targeted entity.
For bound actions or functions this CQN statement points to the bound entity.
Is equivalent to calling target(MessageTarget.PARAMETER_CQN, type, path)
E
- the type of the roottype
- the root type of the path. Either an entity or a structured type.path
- the path to the target element or association<E extends com.sap.cds.ql.StructuredType<E>> Message target(String parameter, Class<E> type, Function<E,Object> path)
Message
. This method allows to build the path in a type-safe way,
by passing the corresponding entity or structured type interface.E
- the type of the rootparameter
- target parameter serving as the entry point for the path resolution.
Passing MessageTarget.PARAMETER_CQN
indicates that the path
should be interpreted relatively to the target entity of the request.
Alternatively you can pass names of action or function parameters.type
- the root type of the path. Either an entity or a structured type.path
- the path to the target element or associationMessage target(com.sap.cds.ql.cqn.Path path, com.sap.cds.reflect.CdsElement element)
Message
.
The path is interpreted relative to the CQN statement, which was determined from the request.
For CRUD events this CQN statement points to the targeted entity.
For bound actions or functions this CQN statement points to the bound entity.
This method can be used with the CdsDataProcessor
and its functional interfaces.path
- the pathelement
- the target element or associationCopyright © 2022. All rights reserved.