Skip navigation links
A B C D E F G H I J L M N O P R S T U V W 

A

ActionAccessEventContext - Interface in com.sap.cds.services.authorization
 
addRole(String) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Adds a role to the user.
addTopic(String) - Method in interface com.sap.cds.services.messaging.MessageQueue
Adds topic to the queue.
addTopics(Set<String>) - Method in interface com.sap.cds.services.messaging.MessageQueue
Adds all topics to the queue.
addUnrestrictedAttribute(String) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Adds the attribute from the list of unrestricted attributes.
After - Annotation Type in com.sap.cds.services.handler.annotations
Annotation to register a handler for the AFTER phase of an event on a specific service and entity.
after(EventPredicate, Handler) - Method in interface com.sap.cds.services.Service
Registers a Handler on this Service for the AFTER phase of the processing of an EventContext.
after(EventPredicate, Handler) - Method in class com.sap.cds.services.ServiceDelegator
 
afterClose(boolean) - Method in interface com.sap.cds.services.changeset.ChangeSetListener
Called, after the ChangeSetContext is closed.
ALL - Static variable in interface com.sap.cds.services.handler.EventPredicate
EventPredicate, which always evaluates to true
ApplicationLifecycleService - Interface in com.sap.cds.services.application
The interface for the technical service which indicates application's lifecycle events.
applicationPrepared(CdsRuntime) - Method in interface com.sap.cds.services.application.ApplicationLifecycleService
Called when the application is fully initialized but not started yet.
ApplicationPreparedEventContext - Interface in com.sap.cds.services.application
 
applicationProviders(CdsRuntimeConfigurer) - Method in interface com.sap.cds.services.application.ApplicationLifecycleService
Called during initialization of after standard providers such as com.sap.cds.services.runtime.UserInfoProvider have been registered.
ApplicationProvidersPreparedEventContext - Interface in com.sap.cds.services.application
 
ApplicationService - Interface in com.sap.cds.services.cds
An ApplicationService is a CdsService that is backed by an actual service definition within the CdsModel.
applicationStarted() - Method in interface com.sap.cds.services.application.ApplicationLifecycleService
Called when the application has been started.
ApplicationStartedEventContext - Interface in com.sap.cds.services.application
 
args - Variable in exception com.sap.cds.services.ServiceException
 
as(Class<T>) - Method in interface com.sap.cds.services.EventContext
Overlays an existing EventContext with a specialized EventContext interface (for example CdsReadEventContext or CdsCreateEventContext) The specialized EventContext provides typed access to the input and output parameters of the event.
as(Class<T>) - Method in interface com.sap.cds.services.request.UserInfo
Provides type-safe access to UserInfo and additional attributes.
AuthorizationService - Interface in com.sap.cds.services.authorization
Technical service for checking authorization on service or entity level for the current user.

B

Before - Annotation Type in com.sap.cds.services.handler.annotations
Annotation to register a handler for the BEFORE phase of an event on a specific service and entity.
before(EventPredicate, Handler) - Method in interface com.sap.cds.services.Service
Registers a Handler on this Service for the BEFORE phase of the processing of an EventContext.
before(EventPredicate, Handler) - Method in class com.sap.cds.services.ServiceDelegator
 
beforeClose() - Method in interface com.sap.cds.services.changeset.ChangeSetListener
Called, before the ChangeSetContext is closed.
begin() - Method in interface com.sap.cds.services.transaction.TransactionManager
Starts a new transaction
build() - Static method in class com.sap.cds.services.runtime.Request
Deprecated.
Builds a new Request

C

calcWhereCondition(String, String) - Method in interface com.sap.cds.services.authorization.AuthorizationService
Calculates a CqnPredicate which reflects the 'where' conditions for the given entity and event.
CalcWhereConditionEventContext - Interface in com.sap.cds.services.authorization
 
cancelDraft(CqnDelete, Object...) - Method in interface com.sap.cds.services.draft.DraftService
Deletes draft entities by executing the provided delete statement.
cancelDraft(CqnDelete, Map<String, Object>) - Method in interface com.sap.cds.services.draft.DraftService
Deletes draft entities by executing the provided delete statement.
cancelDraft(CqnDelete, Iterable<Map<String, Object>>) - Method in interface com.sap.cds.services.draft.DraftService
Deletes draft entities by executing the provided delete statement.
CDS_NAME - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 
CdsCreateEventContext - Interface in com.sap.cds.services.cds
The specialized EventContext to be used for CdsService.EVENT_CREATE
CdsDeleteEventContext - Interface in com.sap.cds.services.cds
The specialized EventContext to be used for CdsService.EVENT_DELETE
CdsMessageEventContext - Interface in com.sap.cds.services.messaging.message
Describes the content of a CDS structured message, received via the messaging adapter
cdsModel() - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Sets the default CDS model on the CdsRuntime of this CdsRuntimeConfigurer
cdsModel(String) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Sets the CDS model from the specified CSN file path on the CdsRuntime of this CdsRuntimeConfigurer
cdsModel(CdsModel) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Sets the given CdsModel on the CdsRuntime of this CdsRuntimeConfigurer
CdsModelProvider - Interface in com.sap.cds.services.runtime
A provider of CDS models
CdsReadEventContext - Interface in com.sap.cds.services.cds
The specialized EventContext to be used for CdsService.EVENT_READ
CdsRuntime - Interface in com.sap.cds.services.runtime
Interface for Protocol Adapters to get access to Service instances and CdsModel.
CdsRuntimeConfiguration - Interface in com.sap.cds.services.runtime
 
CdsRuntimeConfigurer - Interface in com.sap.cds.services.runtime
 
CdsService - Interface in com.sap.cds.services.cds
The interface defining the consumption API of a CdsService.
CdsUpdateEventContext - Interface in com.sap.cds.services.cds
The specialized EventContext to be used for CdsService.EVENT_UPDATE
CdsUpsertEventContext - Interface in com.sap.cds.services.cds
The specialized EventContext to be used for CdsService.EVENT_UPSERT
ChangedEventContext - Interface in com.sap.cds.services.messaging.message
Describes the content of a String-based structured message, received via the messaging adapter
ChangeSetContext - Interface in com.sap.cds.services.changeset
A ChangeSetContext defines the transactional boundaries around one or multiple Service.emit(com.sap.cds.services.EventContext) calls.
changeSetContext() - Method in interface com.sap.cds.services.runtime.CdsRuntime
Starts a new ChangeSetContext which defines the transactional boundaries
ChangeSetContextAccessor - Interface in com.sap.cds.services.changeset
Interface to access ChangeSetContext objects.
ChangeSetContextRunner - Interface in com.sap.cds.services.runtime
 
ChangeSetListener - Interface in com.sap.cds.services.changeset
Listener interface to get notified when a ChangeSetContext is closed successfully or cancelled.
clearParameters() - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Resets the ParameterInfo for the RequestContext being opened.
clearUser() - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Resets the UserInfo for the RequestContext being opened.
code(String) - Method in interface com.sap.cds.services.messages.Message
Adds the passed code to the current message.
com.sap.cds.services - package com.sap.cds.services
 
com.sap.cds.services.application - package com.sap.cds.services.application
 
com.sap.cds.services.authorization - package com.sap.cds.services.authorization
 
com.sap.cds.services.cds - package com.sap.cds.services.cds
 
com.sap.cds.services.changeset - package com.sap.cds.services.changeset
 
com.sap.cds.services.draft - package com.sap.cds.services.draft
 
com.sap.cds.services.handler - package com.sap.cds.services.handler
 
com.sap.cds.services.handler.annotations - package com.sap.cds.services.handler.annotations
 
com.sap.cds.services.messages - package com.sap.cds.services.messages
 
com.sap.cds.services.messaging - package com.sap.cds.services.messaging
 
com.sap.cds.services.messaging.message - package com.sap.cds.services.messaging.message
 
com.sap.cds.services.persistence - package com.sap.cds.services.persistence
 
com.sap.cds.services.request - package com.sap.cds.services.request
 
com.sap.cds.services.runtime - package com.sap.cds.services.runtime
 
com.sap.cds.services.transaction - package com.sap.cds.services.transaction
 
commit() - Method in interface com.sap.cds.services.transaction.TransactionManager
Commits the current transaction
complete() - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Completes the CdsRuntimeConfigurer to prevent any further modifications of the CdsRuntime
configuration(CdsRuntimeConfiguration) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
copy() - Method in interface com.sap.cds.services.request.ParameterInfo
Creates a ModifiableParameterInfo based on this ParameterInfo.
copy() - Method in interface com.sap.cds.services.request.UserInfo
Creates a ModifiableUserInfo based on this UserInfo.
create() - Static method in interface com.sap.cds.services.application.ApplicationPreparedEventContext
Creates an EventContext already overlayed with this interface.
create() - Static method in interface com.sap.cds.services.application.ApplicationProvidersPreparedEventContext
Creates an EventContext already overlayed with this interface.
create() - Static method in interface com.sap.cds.services.application.ApplicationStartedEventContext
Creates an EventContext already overlayed with this interface.
create() - Static method in interface com.sap.cds.services.authorization.ActionAccessEventContext
 
create(String) - Static method in interface com.sap.cds.services.authorization.CalcWhereConditionEventContext
 
create(String) - Static method in interface com.sap.cds.services.authorization.EntityAccessEventContext
 
create() - Static method in interface com.sap.cds.services.authorization.FunctionAccessEventContext
 
create() - Static method in interface com.sap.cds.services.authorization.ServiceAccessEventContext
 
create(String) - Static method in interface com.sap.cds.services.cds.CdsCreateEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.cds.CdsDeleteEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.cds.CdsReadEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.cds.CdsUpdateEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.cds.CdsUpsertEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.draft.DraftCancelEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.draft.DraftCreateEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.draft.DraftEditEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.draft.DraftNewEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.draft.DraftPatchEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.draft.DraftPrepareEventContext
Creates an EventContext already overlayed with this interface.
create(String) - Static method in interface com.sap.cds.services.draft.DraftSaveEventContext
Creates an EventContext already overlayed with this interface.
create(String, String) - Static method in interface com.sap.cds.services.EventContext
Creates a new EventContext
create(Class<T>, String) - Static method in interface com.sap.cds.services.EventContext
Creates a new specialized EventContext of concrete type T
create(String, String) - Method in interface com.sap.cds.services.EventContextFactory
The factory method to create a new EventContext
create(String) - Static method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
create(String) - Static method in interface com.sap.cds.services.messaging.message.ChangedEventContext
 
create() - Static method in interface com.sap.cds.services.messaging.message.JsonMessageEventContext
 
create(String, String) - Static method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
create() - Static method in interface com.sap.cds.services.messaging.message.StringMessageEventContext
 
create() - Static method in interface com.sap.cds.services.messaging.SendCdsMessageEventContext
create() - Static method in interface com.sap.cds.services.messaging.SendMessageEventContext
create() - Static method in interface com.sap.cds.services.request.ParameterInfo
Creates a ModifiableUserInfo based on default values of a clear ParameterInfo.
create(ParameterInfo) - Method in interface com.sap.cds.services.request.ParameterInfoFactory
Creates a ModifiableParameterInfo based on passed ParameterInfo.
create() - Static method in interface com.sap.cds.services.request.UserInfo
Creates a ModifiableUserInfo based on default values of a clear UserInfo.
create(UserInfo) - Method in interface com.sap.cds.services.request.UserInfoFactory
Creates a ModifiableUserInfo based on passed UserInfo.
create() - Static method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Creates a new CdsRuntimeConfigurer.
create(String) - Static method in interface com.sap.cds.services.Service
Creates a new Service
create(String) - Method in interface com.sap.cds.services.ServiceFactory
The factory method to create a new Service
create(String, Service) - Method in interface com.sap.cds.services.ServiceFactory
The factory method to create a new Service with a given delegator Service This method is intended to be used by ServiceDelegator
CREATED_BY_USER - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 
CREATION_DATE_TIME - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 

D

DEFAULT_NAME - Static variable in interface com.sap.cds.services.application.ApplicationLifecycleService
 
DEFAULT_NAME - Static variable in interface com.sap.cds.services.authorization.AuthorizationService
 
DEFAULT_NAME - Static variable in interface com.sap.cds.services.messaging.MessagingService
 
DEFAULT_NAME - Static variable in interface com.sap.cds.services.persistence.PersistenceService
The PersistenceService wrapping the primary SQL database uses this name
DRAFT_ADMINISTRATIVE_DATA - Static variable in interface com.sap.cds.services.draft.Drafts
 
DRAFT_ADMINISTRATIVE_DATA_DRAFT_UUID - Static variable in interface com.sap.cds.services.draft.Drafts
 
DRAFT_IS_CREATED_BY_ME - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 
DRAFT_IS_PROCESSED_BY_ME - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 
DRAFT_UUID - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 
DraftAdministrativeData - Interface in com.sap.cds.services.draft
Interface for the DraftAdministrativeData of a draft enabled entity.
DraftCancelEventContext - Interface in com.sap.cds.services.draft
DraftCreateEventContext - Interface in com.sap.cds.services.draft
DraftEditEventContext - Interface in com.sap.cds.services.draft
DraftNewEventContext - Interface in com.sap.cds.services.draft
DraftPatchEventContext - Interface in com.sap.cds.services.draft
DraftPrepareEventContext - Interface in com.sap.cds.services.draft
Drafts - Interface in com.sap.cds.services.draft
Interface for a draft enabled entity.
DraftSaveEventContext - Interface in com.sap.cds.services.draft
DraftService - Interface in com.sap.cds.services.draft
An ApplicationService that handles draft enabled entities.

E

editDraft(CqnSelect, boolean, Object...) - Method in interface com.sap.cds.services.draft.DraftService
Creates a new draft entity from an active entity.
editDraft(CqnSelect, boolean, Map<String, Object>) - Method in interface com.sap.cds.services.draft.DraftService
Creates a new draft entity from an active entity.
emit(EventContext) - Method in interface com.sap.cds.services.Service
The generic consumption API to emit arbitrary events, represented by EventContext objects.
emit(EventContext) - Method in class com.sap.cds.services.ServiceDelegator
 
ENTITY_NAME - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 
EntityAccessEventContext - Interface in com.sap.cds.services.authorization
 
error(String, Object...) - Method in interface com.sap.cds.services.messages.Messages
Adds a new Message with severity Message.Severity.ERROR to the current request with the given message text or format and format parameters.
ErrorStatus - Interface in com.sap.cds.services
An ErrorStatus is used by ServiceException to identify certain error types.
errorStatus - Variable in exception com.sap.cds.services.ServiceException
 
ErrorStatuses - Enum in com.sap.cds.services
This enum implements ErrorStatus, which is the interface required by ServiceException.
EVENT_ACTION_ACCESS - Static variable in interface com.sap.cds.services.authorization.AuthorizationService
 
EVENT_APPLICATION_LIFECYCLE_PREPARED - Static variable in interface com.sap.cds.services.application.ApplicationLifecycleService
 
EVENT_APPLICATION_LIFECYCLE_PROVIDERS - Static variable in interface com.sap.cds.services.application.ApplicationLifecycleService
 
EVENT_APPLICATION_LIFECYCLE_STARTED - Static variable in interface com.sap.cds.services.application.ApplicationLifecycleService
 
EVENT_CALC_WHERE_CONDITION - Static variable in interface com.sap.cds.services.authorization.AuthorizationService
 
EVENT_CHANGED - Static variable in interface com.sap.cds.services.messaging.message.ChangedEventContext
 
EVENT_CREATE - Static variable in interface com.sap.cds.services.cds.CdsService
 
EVENT_DELETE - Static variable in interface com.sap.cds.services.cds.CdsService
 
EVENT_DRAFT_CANCEL - Static variable in interface com.sap.cds.services.draft.DraftService
 
EVENT_DRAFT_CREATE - Static variable in interface com.sap.cds.services.draft.DraftService
 
EVENT_DRAFT_EDIT - Static variable in interface com.sap.cds.services.draft.DraftService
 
EVENT_DRAFT_NEW - Static variable in interface com.sap.cds.services.draft.DraftService
 
EVENT_DRAFT_PATCH - Static variable in interface com.sap.cds.services.draft.DraftService
 
EVENT_DRAFT_PREPARE - Static variable in interface com.sap.cds.services.draft.DraftService
 
EVENT_DRAFT_SAVE - Static variable in interface com.sap.cds.services.draft.DraftService
 
EVENT_ENTITY_ACCESS - Static variable in interface com.sap.cds.services.authorization.AuthorizationService
 
EVENT_FUNCTION_ACCESS - Static variable in interface com.sap.cds.services.authorization.AuthorizationService
 
EVENT_JSON_RECEIVED - Static variable in interface com.sap.cds.services.messaging.message.JsonMessageEventContext
 
EVENT_READ - Static variable in interface com.sap.cds.services.cds.CdsService
 
EVENT_SEND - Static variable in interface com.sap.cds.services.messaging.MessagingService
 
EVENT_SEND_CDS - Static variable in interface com.sap.cds.services.messaging.MessagingService
 
EVENT_SERVICE_ACCESS - Static variable in interface com.sap.cds.services.authorization.AuthorizationService
 
EVENT_STRING_RECEIVED - Static variable in interface com.sap.cds.services.messaging.message.StringMessageEventContext
 
EVENT_UPDATE - Static variable in interface com.sap.cds.services.cds.CdsService
 
EVENT_UPSERT - Static variable in interface com.sap.cds.services.cds.CdsService
 
EventContext - Interface in com.sap.cds.services
The EventContext provides information about the event that is emitted via Service.emit(EventContext).
EventContextFactory - Interface in com.sap.cds.services
Factory to create EventContext objects.
EventHandler - Interface in com.sap.cds.services.handler
Marker interface for annotation-based handler registration.
eventHandler(Object) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Registers an event handler instance with the CdsRuntime.
eventHandler(Class<T>, Supplier<T>) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Registers an event handler class with the CdsRuntime, given a factory to create instances of the event handler
eventHandlerConfigurations() - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Applies all event handler configuration modules to the CdsRuntime of this CdsRuntimeConfigurer
eventHandlers(CdsRuntimeConfigurer) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfiguration
Creates and registers one or multiple event handler instances, using the given CdsRuntimeConfigurer
EventName - Annotation Type in com.sap.cds.services
Annotation to be used on class level to specify the event which matches the interface of a deviated EventContext.
EventPredicate - Interface in com.sap.cds.services.handler
Functional interface to filter for certain events and entities, when registering Handler instances on Service instances.
EXTERNAL_MESSAGE_MARKER - Static variable in interface com.sap.cds.services.messaging.MessagingService
 

F

forEachTopic(Consumer<String>) - Method in interface com.sap.cds.services.messaging.MessageQueue
Performs the given action for all topics in the queue.
FunctionAccessEventContext - Interface in com.sap.cds.services.authorization
 

G

get(String) - Method in interface com.sap.cds.services.EventContext
Returns an input or output parameter, which was stored under the given key.
get(String) - Method in interface com.sap.cds.services.runtime.CdsModelProvider
 
get() - Method in interface com.sap.cds.services.runtime.ParameterInfoProvider
Provides the ParameterInfo.
get() - Method in interface com.sap.cds.services.runtime.UserInfoProvider
Provides the UserInfo.
getAccessEntityName() - Method in interface com.sap.cds.services.authorization.EntityAccessEventContext
 
getAccessEventName() - Method in interface com.sap.cds.services.authorization.EntityAccessEventContext
 
getAccessEventName() - Method in interface com.sap.cds.services.authorization.ServiceAccessEventContext
 
getAccessServiceName() - Method in interface com.sap.cds.services.authorization.ServiceAccessEventContext
 
getActionName() - Method in interface com.sap.cds.services.authorization.ActionAccessEventContext
 
getAdditionalAttribute(String) - Method in interface com.sap.cds.services.request.UserInfo
Returns additional attribute with given name if existing.
getAdditionalAttributes() - Method in interface com.sap.cds.services.request.UserInfo
Returns all additional attributes as Map.
getAdditionalAttributes() - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns a Map with additional attributes.
getAttribute(String) - Method in interface com.sap.cds.services.request.UserInfo
Deprecated.
getAttributes() - Method in interface com.sap.cds.services.request.UserInfo
Returns all user attributes as a Map.
getAttributeValues(String) - Method in interface com.sap.cds.services.request.UserInfo
Returns a List of values of the specified attribute as presented in the request.
getByCode(int) - Static method in enum com.sap.cds.services.ErrorStatuses
 
getByType(String) - Static method in enum com.sap.cds.services.messaging.message.MessageType
Provides the message type from the given string.
getCdsDataStore() - Method in interface com.sap.cds.services.persistence.PersistenceService
Deprecated.
getCdsModel() - Method in interface com.sap.cds.services.runtime.CdsRuntime
 
getCdsModel(String) - Method in interface com.sap.cds.services.runtime.CdsRuntime
 
getCdsRuntime() - Method in interface com.sap.cds.services.EventContext
Returns the underlying CdsRuntime.
getCdsRuntime() - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
The CdsRuntime that is configured by this CdsRuntimeConfigurer.
getCdsRuntimeConfigurer() - Method in interface com.sap.cds.services.application.ApplicationProvidersPreparedEventContext
 
getChangeSetContext() - Method in interface com.sap.cds.services.EventContext
 
getCloudEventsVersion() - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
getCode() - Method in interface com.sap.cds.services.ErrorStatus
 
getCode() - Method in enum com.sap.cds.services.ErrorStatuses
 
getCode() - Method in interface com.sap.cds.services.messages.Message
The optional code of the message
getContentType() - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
getCqn() - Method in interface com.sap.cds.services.cds.CdsCreateEventContext
 
getCqn() - Method in interface com.sap.cds.services.cds.CdsDeleteEventContext
 
getCqn() - Method in interface com.sap.cds.services.cds.CdsReadEventContext
 
getCqn() - Method in interface com.sap.cds.services.cds.CdsUpdateEventContext
 
getCqn() - Method in interface com.sap.cds.services.cds.CdsUpsertEventContext
 
getCqn() - Method in interface com.sap.cds.services.draft.DraftCancelEventContext
 
getCqn() - Method in interface com.sap.cds.services.draft.DraftCreateEventContext
 
getCqn() - Method in interface com.sap.cds.services.draft.DraftEditEventContext
 
getCqn() - Method in interface com.sap.cds.services.draft.DraftNewEventContext
 
getCqn() - Method in interface com.sap.cds.services.draft.DraftPatchEventContext
 
getCqn() - Method in interface com.sap.cds.services.draft.DraftPrepareEventContext
 
getCqn() - Method in interface com.sap.cds.services.draft.DraftSaveEventContext
 
getCqnNamedValues() - Method in interface com.sap.cds.services.cds.CdsReadEventContext
The CQN named values, for parameterized CqnSelect statements
getCqnNamedValues() - Method in interface com.sap.cds.services.draft.DraftEditEventContext
The CQN named values, for parameterized CqnSelect statements
getCqnNamedValues() - Method in interface com.sap.cds.services.draft.DraftPrepareEventContext
The CQN named values, for parameterized CqnSelect statements
getCqnNamedValues() - Method in interface com.sap.cds.services.draft.DraftSaveEventContext
The CQN named values, for parameterized CqnSelect statements
getCqnValueSets() - Method in interface com.sap.cds.services.cds.CdsDeleteEventContext
 
getCqnValueSets() - Method in interface com.sap.cds.services.cds.CdsUpdateEventContext
 
getCqnValueSets() - Method in interface com.sap.cds.services.draft.DraftCancelEventContext
 
getCqnValueSets() - Method in interface com.sap.cds.services.draft.DraftPatchEventContext
 
getCreatedByUser() - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
getCreationDateTime() - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
getCurrent() - Static method in interface com.sap.cds.services.changeset.ChangeSetContext
Gives access to the currently active ChangeSetContext.
getCurrent() - Method in interface com.sap.cds.services.changeset.ChangeSetContextAccessor
Gives access to the currently active ChangeSetContext.
getCurrent(CdsRuntime) - Static method in interface com.sap.cds.services.request.RequestContext
Gives access to either the current RequestContext, or if this does not exist to a helper RequestContext that itself ensures that there is always a RequestContext opened.
getCurrent(CdsRuntime) - Method in interface com.sap.cds.services.request.RequestContextAccessor
Gives access to either the current RequestContext, or if this does not exist to a helper RequestContext that itself ensures that there is always a RequestContext opened.
getData() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getData() - Method in interface com.sap.cds.services.messaging.message.ChangedEventContext
 
getData() - Method in interface com.sap.cds.services.messaging.message.JsonMessageEventContext
 
getData() - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
getData() - Method in interface com.sap.cds.services.messaging.message.StringMessageEventContext
 
getData() - Method in interface com.sap.cds.services.messaging.SendCdsMessageEventContext
Returns the message data
getDataContentType() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getDataSchema() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getDelegatedService() - Method in class com.sap.cds.services.ServiceDelegator
 
getDescription() - Method in interface com.sap.cds.services.ErrorStatus
 
getDescription() - Method in enum com.sap.cds.services.ErrorStatuses
 
getDraftAdministrativeData() - Method in interface com.sap.cds.services.draft.Drafts
 
getDraftAdministrativeDataDraftUuid() - Method in interface com.sap.cds.services.draft.Drafts
 
getDraftIsCreatedByMe() - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
getDraftIsProcessedByMe() - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
getDraftUUID() - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
getEntity() - Method in interface com.sap.cds.services.messages.MessageTarget
 
getEntityName() - Method in interface com.sap.cds.services.authorization.ActionAccessEventContext
 
getEntityName() - Method in interface com.sap.cds.services.authorization.CalcWhereConditionEventContext
 
getEntityName() - Method in interface com.sap.cds.services.authorization.FunctionAccessEventContext
 
getEntityName() - Method in interface com.sap.cds.services.messaging.SendCdsMessageEventContext
Returns the entity name
getErrorStatus() - Method in exception com.sap.cds.services.ServiceException
 
getEvent() - Method in interface com.sap.cds.services.EventContext
 
getEventID() - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
getEventName() - Method in interface com.sap.cds.services.authorization.CalcWhereConditionEventContext
 
getEventName() - Method in interface com.sap.cds.services.messaging.SendCdsMessageEventContext
Returns the event name
getEventTime() - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
getEventType() - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
getExtensionAttribute(String) - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns the extension attribute if existing.
getFunctionName() - Method in interface com.sap.cds.services.authorization.FunctionAccessEventContext
 
getHasActiveEntity() - Method in interface com.sap.cds.services.draft.Drafts
 
getHasDraftEntity() - Method in interface com.sap.cds.services.draft.Drafts
 
getHeader(String) - Method in interface com.sap.cds.services.request.ParameterInfo
Returns the value of a header with the given identifier.
getHeader(String) - Method in interface com.sap.cds.services.runtime.RequestParameters
Deprecated.
Returns the value of a header with the given identifier
getHeaders() - Method in interface com.sap.cds.services.request.ParameterInfo
Returns the header values as Map.
getHttpStatus() - Method in interface com.sap.cds.services.ErrorStatus
 
getHttpStatus() - Method in enum com.sap.cds.services.ErrorStatuses
 
getId() - Method in interface com.sap.cds.services.changeset.ChangeSetContext
 
getId() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getId() - Method in interface com.sap.cds.services.request.UserInfo
Returns the verified user id of the request's authenticated user.
getId() - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns the verified user id of the request's authenticated user.
getInProcessByUser() - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
getIsActiveEntity() - Method in interface com.sap.cds.services.draft.Drafts
 
getLastChangeDateTime() - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
getLastChangedByUser() - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
getLocale() - Method in interface com.sap.cds.services.request.ParameterInfo
 
getLocales() - Method in interface com.sap.cds.services.runtime.RequestParameters
Deprecated.
getLocalizedMessage() - Method in exception com.sap.cds.services.ServiceException
 
getLocalizedMessage(Locale) - Method in exception com.sap.cds.services.ServiceException
 
getLocalizedMessage(String, Object[], Locale) - Method in interface com.sap.cds.services.ServiceExceptionUtils
Creates a message based on code and args.
getLongTextUrl() - Method in interface com.sap.cds.services.messages.Message
The optional long text url
getMessage() - Method in interface com.sap.cds.services.messages.Message
The localized message
getMessage() - Method in interface com.sap.cds.services.messaging.SendMessageEventContext
 
getMessage() - Method in exception com.sap.cds.services.ServiceException
 
getMessage(String, Object[]) - Method in interface com.sap.cds.services.ServiceExceptionUtils
Creates a message based on code and args.
getMessages() - Method in interface com.sap.cds.services.EventContext
 
getMessages() - Method in interface com.sap.cds.services.request.RequestContext
 
getMessageTarget() - Method in exception com.sap.cds.services.ServiceException
 
getMessageTarget(String) - Method in interface com.sap.cds.services.ServiceExceptionUtils
Creates a new MessageTarget with a string-based target
getMessageTarget(String, String, Function<StructuredType<?>, Object>) - Method in interface com.sap.cds.services.ServiceExceptionUtils
Creates a new MessageTarget with a target, based on a CQN path and a string-based prefix
getMessageTarget(String, Class<E>, Function<E, Object>) - Method in interface com.sap.cds.services.ServiceExceptionUtils
Creates a new MessageTarget with a target, based on a CQN path and a string-based prefix
getModel() - Method in interface com.sap.cds.services.EventContext
Returns the tenant-specific CdsModel.
getModel() - Method in interface com.sap.cds.services.request.RequestContext
Returns the tenant-specific CdsModel.
getName() - Method in interface com.sap.cds.services.messaging.MessageQueue
Returns the queue name.
getName() - Method in interface com.sap.cds.services.request.UserInfo
Returns the verified user name of the request's authenticated user.
getName() - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns the verified user name of the request's authenticated user.
getName() - Method in interface com.sap.cds.services.Service
Returns the name of the Service.
getName() - Method in class com.sap.cds.services.ServiceDelegator
 
getName() - Method in interface com.sap.cds.services.transaction.TransactionManager
The name of the TransactionManager.
getNumericSeverity() - Method in enum com.sap.cds.services.messages.Message.Severity
 
getOwnNamespace() - Method in interface com.sap.cds.services.messaging.SendMessageEventContext
 
getParameterInfo() - Method in interface com.sap.cds.services.EventContext
 
getParameterInfo() - Method in interface com.sap.cds.services.request.RequestContext
 
getPath() - Method in interface com.sap.cds.services.messages.MessageTarget
 
getPlainMessage() - Method in exception com.sap.cds.services.ServiceException
 
getPrefix() - Method in interface com.sap.cds.services.messages.MessageTarget
 
getPreserveChanges() - Method in interface com.sap.cds.services.draft.DraftEditEventContext
 
getProvidedParameterInfo() - Method in interface com.sap.cds.services.runtime.CdsRuntime
 
getProvidedUserInfo() - Method in interface com.sap.cds.services.runtime.CdsRuntime
 
getQueryParameter(String) - Method in interface com.sap.cds.services.request.ParameterInfo
Returns the value of a query parameter with the given key
getQueryParameter(String) - Method in interface com.sap.cds.services.runtime.RequestParameters
Deprecated.
Returns the value of a query parameter with the given key
getQueryParameters() - Method in interface com.sap.cds.services.request.ParameterInfo
Deprecated.
getQueryParameters() - Method in interface com.sap.cds.services.runtime.RequestParameters
Deprecated.
 
getQueryParams() - Method in interface com.sap.cds.services.request.ParameterInfo
Returns the query parameter values as Map.
getRequestParameters() - Method in class com.sap.cds.services.runtime.Request
Deprecated.
 
getRequestUser() - Method in class com.sap.cds.services.runtime.Request
Deprecated.
 
getResult() - Method in interface com.sap.cds.services.authorization.ActionAccessEventContext
 
getResult() - Method in interface com.sap.cds.services.authorization.CalcWhereConditionEventContext
 
getResult() - Method in interface com.sap.cds.services.authorization.EntityAccessEventContext
 
getResult() - Method in interface com.sap.cds.services.authorization.FunctionAccessEventContext
 
getResult() - Method in interface com.sap.cds.services.authorization.ServiceAccessEventContext
 
getResult() - Method in interface com.sap.cds.services.cds.CdsCreateEventContext
 
getResult() - Method in interface com.sap.cds.services.cds.CdsDeleteEventContext
 
getResult() - Method in interface com.sap.cds.services.cds.CdsReadEventContext
 
getResult() - Method in interface com.sap.cds.services.cds.CdsUpdateEventContext
 
getResult() - Method in interface com.sap.cds.services.cds.CdsUpsertEventContext
 
getResult() - Method in interface com.sap.cds.services.draft.DraftCancelEventContext
 
getResult() - Method in interface com.sap.cds.services.draft.DraftCreateEventContext
 
getResult() - Method in interface com.sap.cds.services.draft.DraftEditEventContext
 
getResult() - Method in interface com.sap.cds.services.draft.DraftNewEventContext
 
getResult() - Method in interface com.sap.cds.services.draft.DraftPatchEventContext
 
getResult() - Method in interface com.sap.cds.services.draft.DraftPrepareEventContext
 
getResult() - Method in interface com.sap.cds.services.draft.DraftSaveEventContext
 
getRoles() - Method in interface com.sap.cds.services.request.UserInfo
Returns the List of granted user roles.
getRoles() - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns the roles of the authenticated user.
getSapPassport() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getSchemaURL() - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
getService() - Method in interface com.sap.cds.services.application.ApplicationPreparedEventContext
 
getService() - Method in interface com.sap.cds.services.application.ApplicationProvidersPreparedEventContext
 
getService() - Method in interface com.sap.cds.services.application.ApplicationStartedEventContext
 
getService() - Method in interface com.sap.cds.services.authorization.ActionAccessEventContext
 
getService() - Method in interface com.sap.cds.services.authorization.CalcWhereConditionEventContext
 
getService() - Method in interface com.sap.cds.services.authorization.EntityAccessEventContext
 
getService() - Method in interface com.sap.cds.services.authorization.FunctionAccessEventContext
 
getService() - Method in interface com.sap.cds.services.authorization.ServiceAccessEventContext
 
getService() - Method in interface com.sap.cds.services.cds.CdsCreateEventContext
 
getService() - Method in interface com.sap.cds.services.cds.CdsDeleteEventContext
 
getService() - Method in interface com.sap.cds.services.cds.CdsReadEventContext
 
getService() - Method in interface com.sap.cds.services.cds.CdsUpdateEventContext
 
getService() - Method in interface com.sap.cds.services.cds.CdsUpsertEventContext
 
getService() - Method in interface com.sap.cds.services.draft.DraftCancelEventContext
 
getService() - Method in interface com.sap.cds.services.draft.DraftCreateEventContext
 
getService() - Method in interface com.sap.cds.services.draft.DraftEditEventContext
 
getService() - Method in interface com.sap.cds.services.draft.DraftNewEventContext
 
getService() - Method in interface com.sap.cds.services.draft.DraftPatchEventContext
 
getService() - Method in interface com.sap.cds.services.draft.DraftPrepareEventContext
 
getService() - Method in interface com.sap.cds.services.draft.DraftSaveEventContext
 
getService() - Method in interface com.sap.cds.services.EventContext
Returns the Service (Consumption API) of the service, targeted by the EventContext.
getService() - Method in interface com.sap.cds.services.messaging.MessageQueue
Returns the full qualified service name.
getService(String) - Method in interface com.sap.cds.services.ServiceCatalog
Returns the Service with the specified name
getService(Class<S>, String) - Method in interface com.sap.cds.services.ServiceCatalog
Returns the Service with the given type and name
getServiceCatalog() - Method in interface com.sap.cds.services.EventContext
Returns the ServiceCatalog, populated with all available Service instances.
getServiceCatalog() - Method in interface com.sap.cds.services.request.RequestContext
Returns the ServiceCatalog, populated with all available Service instances.
getServiceCatalog() - Method in interface com.sap.cds.services.runtime.CdsRuntime
 
getServiceName() - Method in interface com.sap.cds.services.messaging.SendCdsMessageEventContext
Returns the full qualified service name
getServices(Class<S>) - Method in interface com.sap.cds.services.ServiceCatalog
Returns all Service instances of a given type
getServices() - Method in interface com.sap.cds.services.ServiceCatalog
Returns all Service instances known to the ServiceCatalog
getSeverity() - Method in interface com.sap.cds.services.messages.Message
The severity of the message.
getSiblingEntity() - Method in interface com.sap.cds.services.draft.Drafts
 
getSideEffectsQualifier() - Method in interface com.sap.cds.services.draft.DraftPrepareEventContext
 
getSource() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getSource() - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
getSpecVersion() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getSubject() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getSystemAttribute(String) - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns the verified value list of the specified system attribute as presented in the request.
getTarget() - Method in interface com.sap.cds.services.EventContext
Returns the Reflection API CdsEntity, for which the EventContext was created.
getTarget() - Method in interface com.sap.cds.services.messages.Message
The optional MessageTarget
getTenant() - Method in interface com.sap.cds.services.request.UserInfo
Returns the verified tenant of the request's authenticated user.
getTenant() - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns the verified tenant of the request's authenticated user.
getTime() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getTopic() - Method in interface com.sap.cds.services.messaging.SendMessageEventContext
 
getTopics() - Method in interface com.sap.cds.services.messaging.MessageQueue
Provides all topics of the queue.
getType() - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
getType() - Method in enum com.sap.cds.services.messaging.message.MessageType
 
getType() - Method in interface com.sap.cds.services.messaging.MessageQueue
Returns the message type.
getUnrestrictedAttributes() - Method in interface com.sap.cds.services.request.UserInfo
Returns the Set of unrestricted attributes of the user.
getUserAttribute(String) - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns the verified value list of the specified user attribute as presented in the request.
getUserInfo() - Method in interface com.sap.cds.services.EventContext
 
getUserInfo() - Method in interface com.sap.cds.services.request.RequestContext
 
getValidFrom() - Method in interface com.sap.cds.services.request.ParameterInfo
 
getValidTo() - Method in interface com.sap.cds.services.request.ParameterInfo
 

H

Handler - Interface in com.sap.cds.services.handler
Functional interface for progammatic handler registration on Service instances.
HAS_ACTIVE_ENTITY - Static variable in interface com.sap.cds.services.draft.Drafts
 
HAS_DRAFT_ENTITY - Static variable in interface com.sap.cds.services.draft.Drafts
 
hasActionAccess(String, String) - Method in interface com.sap.cds.services.authorization.AuthorizationService
Checks if the current user is allowed to access the given action.
hasEntityAccess(String, String) - Method in interface com.sap.cds.services.authorization.AuthorizationService
Checks if the current user is allowed to access the given entity.
hasFunctionAccess(String, String) - Method in interface com.sap.cds.services.authorization.AuthorizationService
Checks if the current user is allowed to access the given function.
hasOwnNamespace() - Method in interface com.sap.cds.services.messaging.MessageQueue
Determines whether the message queue defines their own name space.
hasRole(String) - Method in interface com.sap.cds.services.request.UserInfo
Checks if the current user is associated with the specified user role.
hasServiceAccess(String, String) - Method in interface com.sap.cds.services.authorization.AuthorizationService
Checks if the current user is allowed to access the given service.

I

IN_PROCESS_BY_USER - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 
info(String, Object...) - Method in interface com.sap.cds.services.messages.Messages
Adds a new Message with severity Message.Severity.INFO to the current request with the given message text or format and format parameters.
INSTANCE - Static variable in interface com.sap.cds.services.changeset.ChangeSetContextAccessor
The instance loaded via Java's ServiceLoader, used by ChangeSetContext.getCurrent()
INSTANCE - Static variable in interface com.sap.cds.services.EventContextFactory
The instance loaded via Java's ServiceLoader, used by EventContext.create(String, String)
INSTANCE - Static variable in interface com.sap.cds.services.request.ParameterInfoFactory
The instance loaded via Java's ServiceLoader.
INSTANCE - Static variable in interface com.sap.cds.services.request.RequestContextAccessor
The instance loaded via Java's ServiceLoader, used by RequestContext.getCurrent(CdsRuntime)
INSTANCE - Static variable in interface com.sap.cds.services.request.UserInfoFactory
The instance loaded via Java's ServiceLoader.
INSTANCE - Static variable in interface com.sap.cds.services.ServiceFactory
The instance loaded via Java's ServiceLoader, used by Service.create(String)
IS_ACTIVE_ENTITY - Static variable in interface com.sap.cds.services.draft.Drafts
 
isActive() - Static method in interface com.sap.cds.services.changeset.ChangeSetContext
 
isActive() - Method in interface com.sap.cds.services.changeset.ChangeSetContextAccessor
 
isActive() - Static method in interface com.sap.cds.services.request.RequestContext
 
isActive() - Method in interface com.sap.cds.services.request.RequestContextAccessor
 
isActive() - Method in interface com.sap.cds.services.transaction.TransactionManager
 
isAuthenticated() - Method in interface com.sap.cds.services.request.UserInfo
Returns true if UserInfo is filled with data of an authenticated user.
isCompleted() - Method in interface com.sap.cds.services.EventContext
 
isMarkedForCancel() - Method in interface com.sap.cds.services.changeset.ChangeSetContext
 
isRollbackOnly() - Method in interface com.sap.cds.services.transaction.TransactionManager
 
isSystemUser() - Method in interface com.sap.cds.services.request.UserInfo
Returns true if the user is a system user and not a named user.
isSystemUser() - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns true if the user is a system user and not a named user.
isUnrestrictedAttribute(String) - Method in interface com.sap.cds.services.request.UserInfo
Returns true if the passed attribute is unrestricted, i.e.
isUnrestrictedUserAttribute(String) - Method in interface com.sap.cds.services.runtime.RequestUser
Deprecated.
Returns true if the passed attribute is unrestricted, i.e.

J

JsonMessageEventContext - Interface in com.sap.cds.services.messaging.message
Describes the content of a JSON structured message, received via the messaging adapter

L

LAST_CHANGE_DATE_TIME - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 
LAST_CHANGED_BY_USER - Static variable in interface com.sap.cds.services.draft.DraftAdministrativeData
 
longTextUrl(String) - Method in interface com.sap.cds.services.messages.Message
Adds the passed longTextUrl to the current message.

M

markForCancel() - Method in interface com.sap.cds.services.changeset.ChangeSetContext
Marks the ChangeSetContext to be cancelled.
Message - Interface in com.sap.cds.services.messages
Messages can be used to pass additional information along with the response.
Message.Severity - Enum in com.sap.cds.services.messages
Severity levels.
MessageQueue - Interface in com.sap.cds.services.messaging
 
Messages - Interface in com.sap.cds.services.messages
API to create Messages with different severity within the RequestContext.
MessageTarget - Interface in com.sap.cds.services.messages
 
messageTarget - Variable in exception com.sap.cds.services.ServiceException
 
messageTarget(String) - Method in exception com.sap.cds.services.ServiceException
Sets the provided string-based target.
messageTarget(String, Function<StructuredType<?>, Object>) - Method in exception com.sap.cds.services.ServiceException
Adds the passed root entity and CQN path as target to the current ServiceException.
messageTarget(String, String, Function<StructuredType<?>, Object>) - Method in exception com.sap.cds.services.ServiceException
Adds the passed root entity and CQN path as target to the current ServiceException.
messageTarget(Class<E>, Function<E, Object>) - Method in exception com.sap.cds.services.ServiceException
Adds the passed root entity and CQN path as target to the current ServiceException.
messageTarget(String, Class<E>, Function<E, Object>) - Method in exception com.sap.cds.services.ServiceException
Adds the passed root entity and CQN path as target to the current ServiceException.
MessageType - Enum in com.sap.cds.services.messaging.message
The known message type
MessagingService - Interface in com.sap.cds.services.messaging
Messaging service.
ModifiableParameterInfo - Interface in com.sap.cds.services.request
Interface to modify the values of the ParameterInfo used in a RequestContext.
ModifiableUserInfo - Interface in com.sap.cds.services.request
Interface to modify the values of a UserInfo used in a RequestContext..
modifyParameters(Consumer<ModifiableParameterInfo>) - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Opens a RequestContext with an adapted ParameterInfo.
modifyUser(Consumer<ModifiableUserInfo>) - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Opens a RequestContext with an adapted UserInfo.

N

newDraft(CqnInsert) - Method in interface com.sap.cds.services.draft.DraftService
Creates a new draft entity by executing the insert statement.

O

On - Annotation Type in com.sap.cds.services.handler.annotations
Annotation to register a handler for the ON phase of an event on a specific service and entity.
on(EventPredicate, Handler) - Method in interface com.sap.cds.services.Service
Registers a Handler on this Service for the ON phase of the processing of an EventContext.
on(EventPredicate, Handler) - Method in class com.sap.cds.services.ServiceDelegator
 

P

packageScan(String) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Scans the given package for event handler classes and registers them on the CdsRuntime
ParameterInfo - Interface in com.sap.cds.services.request
Interface to access request-specific information.
ParameterInfoFactory - Interface in com.sap.cds.services.request
Factory to create ParameterInfo objects decoupling implementation from API.
ParameterInfoProvider - Interface in com.sap.cds.services.runtime
A ParameterInfoProvider provides the ParameterInfo for a RequestContext if not provided explicitly.
parameters(ParameterInfo) - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Sets a dedicated ParameterInfo for the RequestContext being opened.
patchDraft(CqnUpdate, Object...) - Method in interface com.sap.cds.services.draft.DraftService
Updates draft entities by executing the update statement.
patchDraft(CqnUpdate, Map<String, Object>) - Method in interface com.sap.cds.services.draft.DraftService
Updates draft entities by executing the update statement.
patchDraft(CqnUpdate, Iterable<Map<String, Object>>) - Method in interface com.sap.cds.services.draft.DraftService
Updates draft entities by executing the update statement.
PersistenceService - Interface in com.sap.cds.services.persistence
The interface defining the consumption API of the PersistenceService.
prepareDraft(CqnSelect, String, Object...) - Method in interface com.sap.cds.services.draft.DraftService
Executes checks to validate the current draft entity.
prepareDraft(CqnSelect, String, Map<String, Object>) - Method in interface com.sap.cds.services.draft.DraftService
Executes checks to validate the current draft entity.
PRESERVE_CHANGES - Static variable in interface com.sap.cds.services.draft.DraftEditEventContext
 
process(EventContext) - Method in interface com.sap.cds.services.handler.Handler
Processes an EventContext
providedParameters() - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Sets the ParameterInfo for the RequestContext as provided by the ParameterInfoProvider.
providedUser() - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Sets the UserInfo for the RequestContext as provided by the UserInfoProvider.
provider(CdsModelProvider) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Sets the given CdsModelProvider on the CdsRuntime of this CdsRuntimeConfigurer
provider(UserInfoProvider) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Sets the given UserInfoProvider on the CdsRuntime of this CdsRuntimeConfigurer
provider(ParameterInfoProvider) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
put(String, Object) - Method in interface com.sap.cds.services.EventContext
Stores an input or output parameter under a given key Whenever possible it is preferred to use specialized EventContext interfaces to guarantee correct and typed access.

R

register(ChangeSetListener) - Method in interface com.sap.cds.services.changeset.ChangeSetContext
Registers a ChangeSetListener on the ChangeSetContext, to be notified once the ChangeSetContext is closed successfully or cancelled.
removeRole(String) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Removes a role from the user.
removeUnrestrictedAttribute(String) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Removes the attribute from the list of unrestricted attributes.
Request - Class in com.sap.cds.services.runtime
Deprecated.
RequestContext - Interface in com.sap.cds.services.request
Interface to provide access to request-specific information.
requestContext() - Method in interface com.sap.cds.services.runtime.CdsRuntime
Starts a new RequestContext which defines the context of parameters (reflecting the user, request parameters etc.)
RequestContextAccessor - Interface in com.sap.cds.services.request
Interface to access RequestContext objects.
RequestContextRunner - Interface in com.sap.cds.services.runtime
RequestContextRunner is the main entry to spawn a new RequestContext with adapted UserInfo or ParameterInfo.
RequestParameters - Interface in com.sap.cds.services.runtime
Deprecated.
RequestUser - Interface in com.sap.cds.services.runtime
Deprecated.
rollback() - Method in interface com.sap.cds.services.transaction.TransactionManager
Rollbacks the current transaction
run(CqnSelect, Object...) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnSelect statement with optional positional parameter values against the CdsService.
run(CqnSelect, Map<String, Object>) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnSelect statement with named parameter values against the CdsService.
run(CqnInsert) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnInsert statement against the CdsService.
run(CqnUpsert) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnUpsert statement against the CdsService.
run(CqnUpdate, Object...) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnUpdate statement with optional positional parameter values against the CdsService.
run(CqnUpdate, Map<String, Object>) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnUpdate statement with named parameter values against the CdsService.
run(CqnUpdate, Iterable<Map<String, Object>>) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnUpdate statement as batch with the given named parameter values against the CdsService.
run(CqnDelete, Object...) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnDelete statement with optional positional parameter values against the CdsService.
run(CqnDelete, Map<String, Object>) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnDelete statement with named parameter values against the CdsService.
run(CqnDelete, Iterable<Map<String, Object>>) - Method in interface com.sap.cds.services.cds.CdsService
Executes a CqnDelete statement as batch with the given named parameter values against the CdsService.
run(Function<ChangeSetContext, T>) - Method in interface com.sap.cds.services.runtime.ChangeSetContextRunner
Opens a ChangeSetContext and runs the given handler within its scope.
run(Consumer<ChangeSetContext>) - Method in interface com.sap.cds.services.runtime.ChangeSetContextRunner
Opens a ChangeSetContext and runs the given handler within its scope.
run(Function<RequestContext, T>) - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Opens a RequestContext and runs the given handler within its scope.
run(Consumer<RequestContext>) - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Opens a RequestContext and runs the given handler within its scope.
runInChangeSetContext(Function<ChangeSetContext, T>) - Method in interface com.sap.cds.services.runtime.CdsRuntime
Deprecated.
runInChangeSetContext(Consumer<ChangeSetContext>) - Method in interface com.sap.cds.services.runtime.CdsRuntime
Deprecated.
runInRequestContext(Request, Function<RequestContext, T>) - Method in interface com.sap.cds.services.runtime.CdsRuntime
Deprecated.
runInRequestContext(Request, Consumer<RequestContext>) - Method in interface com.sap.cds.services.runtime.CdsRuntime
Deprecated.

S

S4HanaMessageEventContext - Interface in com.sap.cds.services.messaging.message
Describes the content of a S/4HANA structured message, received via the messaging adapter
saveDraft(CqnSelect, Object...) - Method in interface com.sap.cds.services.draft.DraftService
Saves a draft.
saveDraft(CqnSelect, Map<String, Object>) - Method in interface com.sap.cds.services.draft.DraftService
Saves a draft.
send(String, String) - Method in interface com.sap.cds.services.messaging.MessagingService
Sends the given message to the specified topic/pattern of all connected message brokers.
send(Map<String, Object>, String) - Method in interface com.sap.cds.services.messaging.MessagingService
Sends the given message to the specified topic/pattern of all connected message brokers.
send(Map<String, Object>, String, String, String) - Method in interface com.sap.cds.services.messaging.MessagingService
Sends the CDS message to all connected message brokers.
SendCdsMessageEventContext - Interface in com.sap.cds.services.messaging
Describes the SEND_CDS event of the MessagingService
SendMessageEventContext - Interface in com.sap.cds.services.messaging
Describes the SEND event of the MessagingService
service(Service) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Registers a given Service in the ServiceCatalog of the CdsRuntime.
Service - Interface in com.sap.cds.services
The Service is the root consumption API that every Service instance offers.
ServiceAccessEventContext - Interface in com.sap.cds.services.authorization
 
ServiceCatalog - Interface in com.sap.cds.services
The ServiceCatalog provides access to the Service instances and their consumption API.
serviceConfigurations() - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfigurer
Applies all service configuration modules to the CdsRuntime of this CdsRuntimeConfigurer
ServiceDelegator - Class in com.sap.cds.services
 
ServiceDelegator(String) - Constructor for class com.sap.cds.services.ServiceDelegator
 
ServiceException - Exception in com.sap.cds.services
ServiceException is the central unchecked exception thrown by the framework and Handler when an error occurs during event processing via Service.emit(EventContext) It extends RuntimeException with an ErrorStatus, which indicates an internal error code and a mapping to an HTTP status code.
ServiceException(Throwable) - Constructor for exception com.sap.cds.services.ServiceException
Creates a new ServiceException
The ErrorStatus of the first ServiceException found within the cause chain is used.
ServiceException(String, Object...) - Constructor for exception com.sap.cds.services.ServiceException
Creates a new ServiceException.
ServiceException(ErrorStatus, String, Object...) - Constructor for exception com.sap.cds.services.ServiceException
Creates a new ServiceException
ServiceExceptionUtils - Interface in com.sap.cds.services
Helper methods for creating (localized) messages in ServiceException.
ServiceFactory - Interface in com.sap.cds.services
Factory to create Service objects.
ServiceName - Annotation Type in com.sap.cds.services.handler.annotations
Annotation to be used on class level to specify the default Service, which should be used when registering annotation-based handlers.
services(CdsRuntimeConfigurer) - Method in interface com.sap.cds.services.runtime.CdsRuntimeConfiguration
Creates and registers one or multiple Service instances, using the given CdsRuntimeConfigurer
setAccessEntityName(String) - Method in interface com.sap.cds.services.authorization.EntityAccessEventContext
 
setAccessEventName(String) - Method in interface com.sap.cds.services.authorization.EntityAccessEventContext
 
setAccessEventName(String) - Method in interface com.sap.cds.services.authorization.ServiceAccessEventContext
 
setAccessServiceName(String) - Method in interface com.sap.cds.services.authorization.ServiceAccessEventContext
 
setActionName(String) - Method in interface com.sap.cds.services.authorization.ActionAccessEventContext
 
setAdditionalAttribute(String, Object) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Sets additional attributes.
setAdditionalAttributes(Map<String, Object>) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Sets the additional attributes.
setAttributes(Map<String, List<String>>) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Sets an attribute value of the user.
setAttributeValues(String, List<String>) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Sets the value list of an attribute of the user.
setCdsRuntimeConfigurer(CdsRuntimeConfigurer) - Method in interface com.sap.cds.services.application.ApplicationProvidersPreparedEventContext
 
setCloudEventsVersion(String) - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
setCompleted() - Method in interface com.sap.cds.services.EventContext
Marks the EventContext as completed.
setContentType(String) - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
setCqn(CqnInsert) - Method in interface com.sap.cds.services.cds.CdsCreateEventContext
Sets the CqnInsert statement
setCqn(CqnDelete) - Method in interface com.sap.cds.services.cds.CdsDeleteEventContext
Sets the CqnDelete statement
setCqn(CqnSelect) - Method in interface com.sap.cds.services.cds.CdsReadEventContext
Sets the CqnSelect statement
setCqn(CqnUpdate) - Method in interface com.sap.cds.services.cds.CdsUpdateEventContext
Sets the CqnUpdate statement
setCqn(CqnUpsert) - Method in interface com.sap.cds.services.cds.CdsUpsertEventContext
Sets the CqnUpsert statement
setCqn(CqnDelete) - Method in interface com.sap.cds.services.draft.DraftCancelEventContext
Sets the CqnDelete statement
setCqn(CqnInsert) - Method in interface com.sap.cds.services.draft.DraftCreateEventContext
Sets the CqnInsert statement
setCqn(CqnSelect) - Method in interface com.sap.cds.services.draft.DraftEditEventContext
Sets the CqnSelect statement
setCqn(CqnInsert) - Method in interface com.sap.cds.services.draft.DraftNewEventContext
Sets the CqnInsert statement
setCqn(CqnUpdate) - Method in interface com.sap.cds.services.draft.DraftPatchEventContext
Sets the CqnUpdate statement
setCqn(CqnSelect) - Method in interface com.sap.cds.services.draft.DraftPrepareEventContext
Sets the CqnSelect statement
setCqn(CqnSelect) - Method in interface com.sap.cds.services.draft.DraftSaveEventContext
Sets the CqnSelect statement
setCqnNamedValues(Map<String, Object>) - Method in interface com.sap.cds.services.cds.CdsReadEventContext
Sets the CQN named values, for parameterized CqnSelect statements
setCqnNamedValues(Map<String, Object>) - Method in interface com.sap.cds.services.draft.DraftEditEventContext
Sets the CQN named values, for parameterized CqnSelect statements
setCqnNamedValues(Map<String, Object>) - Method in interface com.sap.cds.services.draft.DraftPrepareEventContext
Sets the CQN named values, for parameterized CqnSelect statements
setCqnNamedValues(Map<String, Object>) - Method in interface com.sap.cds.services.draft.DraftSaveEventContext
Sets the CQN named values, for parameterized CqnSelect statements
setCqnValueSets(Iterable<Map<String, Object>>) - Method in interface com.sap.cds.services.cds.CdsDeleteEventContext
Sets the CQN value sets, to enable batched CqnDelete statements
setCqnValueSets(Iterable<Map<String, Object>>) - Method in interface com.sap.cds.services.cds.CdsUpdateEventContext
Sets the CQN value sets, to enable batched CqnUpdate statements
setCqnValueSets(Iterable<Map<String, Object>>) - Method in interface com.sap.cds.services.draft.DraftCancelEventContext
Sets the CQN value sets, to enable batched CqnDelete statements
setCqnValueSets(Iterable<Map<String, Object>>) - Method in interface com.sap.cds.services.draft.DraftPatchEventContext
Sets the CQN value sets, to enable batched CqnUpdate statements
setCreatedByUser(String) - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
setCreationDateTime(Instant) - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
setData(Map<String, Object>) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setData(Map<String, Object>) - Method in interface com.sap.cds.services.messaging.message.ChangedEventContext
 
setData(Map<String, Object>) - Method in interface com.sap.cds.services.messaging.message.JsonMessageEventContext
 
setData(Map<String, Object>) - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
setData(String) - Method in interface com.sap.cds.services.messaging.message.StringMessageEventContext
 
setData(Map<String, Object>) - Method in interface com.sap.cds.services.messaging.SendCdsMessageEventContext
Sets the message data
setDataContentType(String) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setDataSchema(String) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setDraftAdministrativeData(Map<String, ?>) - Method in interface com.sap.cds.services.draft.Drafts
 
setDraftAdministrativeDataDraftUuid(String) - Method in interface com.sap.cds.services.draft.Drafts
 
setDraftIsCreatedByMe(Boolean) - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
setDraftIsProcessedByMe(Boolean) - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
setDraftUUID(String) - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
setEntityName(String) - Method in interface com.sap.cds.services.authorization.ActionAccessEventContext
 
setEntityName(String) - Method in interface com.sap.cds.services.authorization.CalcWhereConditionEventContext
 
setEntityName(String) - Method in interface com.sap.cds.services.authorization.FunctionAccessEventContext
 
setEntityName(String) - Method in interface com.sap.cds.services.messaging.SendCdsMessageEventContext
Sets the entity name
setEventID(String) - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
setEventName(String) - Method in interface com.sap.cds.services.authorization.CalcWhereConditionEventContext
 
setEventName(String) - Method in interface com.sap.cds.services.messaging.SendCdsMessageEventContext
Sets the event name
setEventTime(long) - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
setEventType(String) - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
setFunctionName(String) - Method in interface com.sap.cds.services.authorization.FunctionAccessEventContext
 
setHasActiveEntity(Boolean) - Method in interface com.sap.cds.services.draft.Drafts
 
setHasDraftEntity(Boolean) - Method in interface com.sap.cds.services.draft.Drafts
 
setHeader(String, String) - Method in interface com.sap.cds.services.request.ModifiableParameterInfo
Sets the value of the header with the given identifier.
setHeaders(Map<String, String>) - Method in interface com.sap.cds.services.request.ModifiableParameterInfo
Sets all the header values.
setId(String) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setId(String) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Sets the ID of the user.
setInProcessByUser(String) - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
setIsActiveEntity(Boolean) - Method in interface com.sap.cds.services.draft.Drafts
 
setIsAuthenticated(boolean) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Specifies if the current user is an authenticated (i.e.
setIsSystemUser(boolean) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Specifies if the current user is a system user.
setLastChangeDateTime(Instant) - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
setLastChangedByUser(String) - Method in interface com.sap.cds.services.draft.DraftAdministrativeData
 
setLocale(Locale) - Method in interface com.sap.cds.services.request.ModifiableParameterInfo
Sets the Locale of the request.
setMessage(String) - Method in interface com.sap.cds.services.messaging.SendMessageEventContext
Sets the message to be sent
setName(String) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Sets the name of the user which is used for $user to uniquely identify.
setOwnNamespace(boolean) - Method in interface com.sap.cds.services.messaging.SendMessageEventContext
Indicates, that the topics already have their own namespace prefixed
setPreserveChanges(boolean) - Method in interface com.sap.cds.services.draft.DraftEditEventContext
Sets whether to preserve changes or not
setPrevious(CdsModelProvider) - Method in interface com.sap.cds.services.runtime.CdsModelProvider
Passes the latest configured CdsModelProvider during configuration phase when this instances gets registered.
setPrevious(ParameterInfoProvider) - Method in interface com.sap.cds.services.runtime.ParameterInfoProvider
Passes the latest configured ParameterInfoProvider during configuration phase when this instances gets registered.
setPrevious(UserInfoProvider) - Method in interface com.sap.cds.services.runtime.UserInfoProvider
Passes the latest configured UserInfoProvider during configuration phase when this instances gets registered.
setQueryParameter(String, String) - Method in interface com.sap.cds.services.request.ModifiableParameterInfo
Sets the value of the query parameter with the given key.
setQueryParameters(Map<String, String>) - Method in interface com.sap.cds.services.request.ModifiableParameterInfo
Sets all the query parameters.
setResult(boolean) - Method in interface com.sap.cds.services.authorization.ActionAccessEventContext
 
setResult(CqnPredicate) - Method in interface com.sap.cds.services.authorization.CalcWhereConditionEventContext
 
setResult(boolean) - Method in interface com.sap.cds.services.authorization.EntityAccessEventContext
 
setResult(boolean) - Method in interface com.sap.cds.services.authorization.FunctionAccessEventContext
 
setResult(boolean) - Method in interface com.sap.cds.services.authorization.ServiceAccessEventContext
 
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.cds.CdsCreateEventContext
Sets the result of the CdsService.EVENT_CREATE event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.cds.CdsDeleteEventContext
Sets the result of the CdsService.EVENT_DELETE event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.cds.CdsReadEventContext
Sets the result of the CdsService.EVENT_READ event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.cds.CdsUpdateEventContext
Sets the result of the CdsService.EVENT_UPDATE event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.cds.CdsUpsertEventContext
Sets the result of the CdsService.EVENT_UPSERT event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.draft.DraftCancelEventContext
Sets the result of the DraftService.EVENT_DRAFT_CANCEL event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.draft.DraftCreateEventContext
Sets the result of the DraftService.EVENT_DRAFT_CREATE event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.draft.DraftEditEventContext
Sets the result of the DraftService.EVENT_DRAFT_EDIT event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.draft.DraftNewEventContext
Sets the result of the DraftService.EVENT_DRAFT_NEW event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.draft.DraftPatchEventContext
Sets the result of the DraftService.EVENT_DRAFT_PATCH event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.draft.DraftPrepareEventContext
Sets the result of the DraftService.EVENT_DRAFT_PREPARE event
setResult(Iterable<? extends Map<String, ?>>) - Method in interface com.sap.cds.services.draft.DraftSaveEventContext
Sets the result of the DraftService.EVENT_DRAFT_SAVE event
setRoles(Set<String>) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Sets the roles of the user.
setRollbackOnly() - Method in interface com.sap.cds.services.transaction.TransactionManager
Marks the transaction as rollback only
setSapPassport(String) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setSchemaURL(String) - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
setServiceName(String) - Method in interface com.sap.cds.services.messaging.SendCdsMessageEventContext
Sets the full qualified service name
setSiblingEntity(Map<String, ?>) - Method in interface com.sap.cds.services.draft.Drafts
 
setSideEffectsQualifier(String) - Method in interface com.sap.cds.services.draft.DraftPrepareEventContext
Sets the sideEffectQualifier
setSource(String) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setSource(String) - Method in interface com.sap.cds.services.messaging.message.S4HanaMessageEventContext
 
setSpecVersion(String) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setSubject(String) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setTenant(String) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
Sets the tenant of the user.
setTime(Instant) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setTopic(String) - Method in interface com.sap.cds.services.messaging.SendMessageEventContext
Sets the topic the message should be sent to
setType(String) - Method in interface com.sap.cds.services.messaging.message.CdsMessageEventContext
 
setUnrestrictedAttributes(Set<String>) - Method in interface com.sap.cds.services.request.ModifiableUserInfo
 
setValidFrom(Instant) - Method in interface com.sap.cds.services.request.ModifiableParameterInfo
Sets the "valid-from" time stamp for the request.
setValidTo(Instant) - Method in interface com.sap.cds.services.request.ModifiableParameterInfo
Sets the "valid-to" time stamp for the request.
SIBLING_ENTITY - Static variable in interface com.sap.cds.services.draft.Drafts
 
SIDE_EFFECTS_QUALIFIER - Static variable in interface com.sap.cds.services.draft.DraftPrepareEventContext
 
stream() - Method in interface com.sap.cds.services.messages.Messages
Returns a Stream of the added messages in the current request context
STRING_DATA_KEY - Static variable in interface com.sap.cds.services.messaging.MessagingService
 
StringMessageEventContext - Interface in com.sap.cds.services.messaging.message
Describes the content of a String-based structured message, received via the messaging adapter
success(String, Object...) - Method in interface com.sap.cds.services.messages.Messages
Adds a new Message with severity Message.Severity.SUCCESS to the current request with the given message text or format and format parameters.

T

target(String) - Method in interface com.sap.cds.services.messages.Message
Sets the provided string-based target.
target(String, Function<StructuredType<?>, Object>) - Method in interface com.sap.cds.services.messages.Message
Adds the passed root entity and CQN path as target to the current Message.
target(String, String, Function<StructuredType<?>, Object>) - Method in interface com.sap.cds.services.messages.Message
Adds the passed root entity and CQN path as target to the current Message.
target(Class<E>, Function<E, Object>) - Method in interface com.sap.cds.services.messages.Message
Adds the passed root entity and CQN path as target to the current Message.
target(String, Class<E>, Function<E, Object>) - Method in interface com.sap.cds.services.messages.Message
Adds the passed root entity and CQN path as target to the current Message.
test(String, String) - Method in interface com.sap.cds.services.handler.EventPredicate
Returns true, if a given event and entity should be handled by the Handler registered with this EventPredicate
TransactionManager - Interface in com.sap.cds.services.transaction
Interface to abstract on TransactionManager instances provided by different frameworks.

U

user(UserInfo) - Method in interface com.sap.cds.services.runtime.RequestContextRunner
Sets a dedicated UserInfo for the RequestContext being opened.
UserInfo - Interface in com.sap.cds.services.request
Interface to fetch user and authorization information.
UserInfoFactory - Interface in com.sap.cds.services.request
Factory to create UserInfo objects decoupling implementation from API.
UserInfoProvider - Interface in com.sap.cds.services.runtime
A UserInfoProvider provides the UserInfo for a RequestContext if not provided explicitly.
Utils - Static variable in exception com.sap.cds.services.ServiceException
 

V

valueOf(String) - Static method in enum com.sap.cds.services.ErrorStatuses
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.sap.cds.services.messages.Message.Severity
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.sap.cds.services.messaging.message.MessageType
Returns the enum constant of this type with the specified name.
values() - Static method in enum com.sap.cds.services.ErrorStatuses
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.sap.cds.services.messages.Message.Severity
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.sap.cds.services.messaging.message.MessageType
Returns an array containing the constants of this enum type, in the order they are declared.

W

warn(String, Object...) - Method in interface com.sap.cds.services.messages.Messages
Adds a new Message with severity Message.Severity.WARNING to the current request with the given message text or format and format parameters.
withParameters(RequestParameters) - Method in class com.sap.cds.services.runtime.Request
Deprecated.
withUser(RequestUser) - Method in class com.sap.cds.services.runtime.Request
Deprecated.
Sets RequestUser on the Request
A B C D E F G H I J L M N O P R S T U V W 
Skip navigation links

Copyright © 2020. All rights reserved.