Class InternalCoreAction<R>
java.lang.Object
com.mendix.core.actionmanagement.internal.InternalCoreAction<R>
- Type Parameters:
R
- the result type of the action
- All Implemented Interfaces:
ICoreAction<R>
,Callable<R>
- Direct Known Subclasses:
CoreAction
Provides the (internal) interface to an action that can be executed.
This is an internal class that is not to be used and may change any time.
-
Constructor Summary
ConstructorsConstructorDescriptionInternalCoreAction
(CoreActionHandler handler) Creates an action with a handler.InternalCoreAction
(IContext context) Creates an action with a context. -
Method Summary
Modifier and TypeMethodDescriptionvoid
addDatavalidationFeedback
(IMendixIdentifier id, Map<String, String> errorFields) Deprecated.since 10.24.void
Deprecated.since 10.24.call()
Invokes the action handler for this action.clone()
Deprecated.since 10.24.abstract R
execute()
Executes the action and returns the result.Returns the name of this action.getClonedContext
(IMendixIdentifier currentIdentifier, List<IMendixIdentifier> constraint) Deprecated.since 10.18.Returns the context of the action.Returns the event objects of this action.Deprecated.since 10.24.Returns the handler of this action.com.mendix.thirdparty.org.json.JSONObject
Deprecated.since 10.24.Returns the meta-info of this action, containing additional details about the action.getState()
Deprecated.since 10.24.void
Deprecated.since 10.24.void
setActionName
(String actionName) Deprecated.since 10.24.void
setAllowsConcurrentExecution
(Boolean enabled) Deprecated.since 10.24.void
setContext
(IContext context) Deprecated.since 9.23.void
setEventObjects
(List<IMendixObject> eventObjects) Deprecated.since 10.24.void
setException
(Exception exception) Deprecated.since 10.24.void
setMetaInfo
(com.mendix.thirdparty.org.json.JSONObject metaInfo) Deprecated.since 10.24.void
setState
(ActionState state) Deprecated.since 10.24.
-
Constructor Details
-
InternalCoreAction
Creates an action with a context.- Parameters:
context
- the context for the action
-
InternalCoreAction
Creates an action with a handler.- Parameters:
handler
- the action handler for executing the action
-
-
Method Details
-
getHandler
Returns the handler of this action.- Returns:
- the handler
-
getContext
Description copied from interface:ICoreAction
Returns the context of the action.- Specified by:
getContext
in interfaceICoreAction<R>
- Returns:
- the context for executing the action
-
setContext
Deprecated.since 9.23. There is no replacement.Sets the context for the action to execute in.- Specified by:
setContext
in interfaceICoreAction<R>
- Parameters:
context
- the context for executing the action
-
execute
Executes the action and returns the result.- Returns:
- the execution result
- Throws:
Exception
- when executing the action failed
-
call
Description copied from interface:ICoreAction
Invokes the action handler for this action. -
addDatavalidationFeedback
@Deprecated public void addDatavalidationFeedback(IMendixIdentifier id, Map<String, String> errorFields) Deprecated.since 10.24. There is no replacement.Adds validation feedback to this action.- Parameters:
id
- the identifier of the Mendix object that was validatederrorFields
- the validation messages by attribute name
-
addDataValidationFeedback
Deprecated.since 10.24. There is no replacement.Adds validation feedback to this action.- Parameters:
dvInfo
- the validation feedback details
-
handleConcurrentExecution
Deprecated.since 10.24. There is no replacement.Throws a concurrent execution exception.- Throws:
UserException
- alwaysCoreException
-
getEventObjects
Description copied from interface:ICoreAction
Returns the event objects of this action.- Specified by:
getEventObjects
in interfaceICoreAction<R>
- Returns:
- the Mendix objects
-
setEventObjects
Deprecated.since 10.24. There is no replacement.Sets the event objects of this action.- Parameters:
eventObjects
- the event objects to set
-
getMetaInfo
Deprecated.since 10.24. There is no replacement.This is an internal method that is not to be used.- Specified by:
getMetaInfo
in interfaceICoreAction<R>
- Returns:
- the meta-info
-
getMetaInfoJsonString
Description copied from interface:ICoreAction
Returns the meta-info of this action, containing additional details about the action.The contents will differ depending on the type of action.
- Specified by:
getMetaInfoJsonString
in interfaceICoreAction<R>
- Returns:
- the meta-info
-
setMetaInfo
Deprecated.since 10.24. There is no replacement.Sets the meta-info of this action.- Parameters:
metaInfo
- the meta-info to set
-
getActionName
Description copied from interface:ICoreAction
Returns the name of this action.- Specified by:
getActionName
in interfaceICoreAction<R>
- Returns:
- the action name
-
setActionName
Deprecated.since 10.24. There is no replacement.Sets the name of this action.- Parameters:
actionName
- the name to set
-
getException
Deprecated.since 10.24. There is no replacement.Returns the exception that was set for this action (if any).- Returns:
- the exception if it was set; null otherwise
-
setException
Deprecated.since 10.24. There is no replacement.Sets the specified exception for this action.- Parameters:
exception
- the exception to set
-
getState
Deprecated.since 10.24. There is no replacement.Returns the state of this action (if any).- Returns:
- the action state if it was set; null otherwise
-
setState
Deprecated.since 10.24. There is no replacement.Sets the state of this action.- Parameters:
state
- the state to set
-
setAllowsConcurrentExecution
Deprecated.since 10.24. There is no replacement.Sets whether this action allows concurrent execution.If concurrent execution is not allowed,
handleConcurrentExecution()
will be called if this action is called concurrently with itself.- Parameters:
enabled
- true if concurrent execution is allowed; false otherwise
-
getClonedContext
@Deprecated public IContext getClonedContext(IMendixIdentifier currentIdentifier, List<IMendixIdentifier> constraint) Deprecated.since 10.18. No replacement.Returns a copy of the context of this action with the specified identifier and context objects.- Parameters:
currentIdentifier
- the identifier to set on the copied context; if null, the existing identifier is not overwrittenconstraint
- the context objects to set on the copied context; if null, the existing objects are not overwritten- Returns:
- the cloned context
-
clone
Deprecated.since 10.24. There is no replacement.Returns a clone of this action.
-