Mendix Runtime
Documentation for the Mendix Runtime Environment API
|
Inherits Callable< R >, and ICoreAction< R >.
Public Types | |
enum | ActionState { IDLE, RUNNING, COMPLETED, ERROR } |
Public Member Functions | |
CoreAction () | |
CoreAction (IContext context) | |
boolean | isSystemAction () |
void | setSystemAction (boolean isSystemAction) |
final String | getActionName () |
final void | setActionName (String actionName) |
final JSONObject | getMetaInfo () |
final void | setMetaInfo (JSONObject metaInfo) |
final List< IMendixObject > | getEventObjects () |
final void | setEventObjects (List< IMendixObject > eventObjects) |
void | addTextMessageFeedback (MessageType type, String message, boolean blocking) |
void | addRefreshObjectFeedback (IMendixIdentifier id) |
void | addRefreshObjectListFeedback (List< IMendixIdentifier > ids) |
void | addRefreshClass (String objectClass) |
void | addOpenFormFeedback (String formName, FormTarget target) |
void | addOpenFormFeedback (String formName, FormTarget target, IMendixIdentifier currentIdentifier, List< IMendixIdentifier > constraints) |
void | addOpenFormFeedback (String formName, String title, FormTarget target) |
void | addOpenFormFeedback (String formName, String title, FormTarget target, IMendixIdentifier currentIdentifier, List< IMendixIdentifier > constraints) |
void | addOpenFormFeedback (String formName, String title, FormTarget target, boolean isResizable, int width, int height) |
void | addOpenFormFeedback (String formName, FormTarget target, boolean isResizable, int width, int height) |
void | addOpenFormFeedback (String formName, FormTarget target, boolean isResizable, int width, int height, IMendixIdentifier currentIdentifier, List< IMendixIdentifier > constraints) |
void | addOpenFormFeedback (String formName, String title, FormTarget target, boolean isResizable, int width, int height, IMendixIdentifier currentIdentifier, List< IMendixIdentifier > constraints) |
void | addLoginFeedback () |
void | addCloseCallerFeedback () |
void | addDatavalidationFeedback (IMendixIdentifier id, Map< String, String > errorFields) |
void | addDataValidationFeedback (DataValidationFeedback dvFeedback) |
final ActionState | getState () |
final void | setState (ActionState state) |
final IContext | getContext () |
Object | clone () |
void | setContext (IContext context) |
final IContext | createContext () |
final Exception | getException () |
final void | setException (Exception exception) |
final R | call () throws Exception |
boolean | allowsConcurrentExecution () |
abstract R | execute () throws Exception |
CoreAction< R > | getUnwrappedAction () |
String | toString () |
Protected Attributes | |
Context | context |
boolean | allowsConcurrentExecution |
String | actionName |
JSONObject | metaInfo = new JSONObject() |
String | whenLockedActionName |
String | i18nWhenLockedMessageKey |
Defines abstract CoreAction<R> R is the return type of this CoreAction
enum com::mendix::core::actionmanagement::CoreAction< R >::ActionState |
com.mendix.core.actionmanagement.CoreAction< R >.CoreAction | ( | ) |
com.mendix.core.actionmanagement.CoreAction< R >.CoreAction | ( | IContext | context | ) |
void com.mendix.core.actionmanagement.CoreAction< R >.addCloseCallerFeedback | ( | ) |
Add close caller feedback to this action
void com.mendix.core.actionmanagement.CoreAction< R >.addDatavalidationFeedback | ( | IMendixIdentifier | id, |
Map< String, String > | errorFields | ||
) |
Add data validation feedback to this action
id | the id of the object data validation was performed on |
errorFields | a map with attribute names as key and error messages as values |
void com.mendix.core.actionmanagement.CoreAction< R >.addDataValidationFeedback | ( | DataValidationFeedback | dvFeedback | ) |
Add datavalidation feedback
dvFeedback | the datavalidation feedback to add |
void com.mendix.core.actionmanagement.CoreAction< R >.addLoginFeedback | ( | ) |
void com.mendix.core.actionmanagement.CoreAction< R >.addOpenFormFeedback | ( | String | formName, |
FormTarget | target | ||
) |
Add open form feedback to this action
formName | path to the form to open |
target | is target content, window (popup) or modal window |
void com.mendix.core.actionmanagement.CoreAction< R >.addOpenFormFeedback | ( | String | formName, |
FormTarget | target, | ||
IMendixIdentifier | currentIdentifier, | ||
List< IMendixIdentifier > | constraints | ||
) |
Add open form feedback to this action
formName | path to the form to open |
target | is target content, window (popup) or modal window |
currentIdentifier | the currentIdentifier |
constraints | the context objects |
void com.mendix.core.actionmanagement.CoreAction< R >.addOpenFormFeedback | ( | String | formName, |
String | title, | ||
FormTarget | target | ||
) |
Add open form feedback to this action
formName | path to the form to open |
title | the title of the form |
target | is target content, window (popup) or modal window |
void com.mendix.core.actionmanagement.CoreAction< R >.addOpenFormFeedback | ( | String | formName, |
String | title, | ||
FormTarget | target, | ||
IMendixIdentifier | currentIdentifier, | ||
List< IMendixIdentifier > | constraints | ||
) |
Add open form feedback to this action
formName | path to the form to open |
title | the title of the form |
target | is target content, window (popup) or modal window |
currentIdentifier | the currentIdentifier |
constraints | the context objects |
void com.mendix.core.actionmanagement.CoreAction< R >.addOpenFormFeedback | ( | String | formName, |
String | title, | ||
FormTarget | target, | ||
boolean | isResizable, | ||
int | width, | ||
int | height | ||
) |
Add open form feedback to this action
formName | path to the form to open |
title | the title of the form |
target | is target content, window (popup) or modal window |
isResizable | whether the form is resizeable or not |
width | the width of the form |
height | the height of the form |
void com.mendix.core.actionmanagement.CoreAction< R >.addOpenFormFeedback | ( | String | formName, |
FormTarget | target, | ||
boolean | isResizable, | ||
int | width, | ||
int | height | ||
) |
Add open form feedback to this action
formName | path to the form to open |
target | is target content, window (popup) or modal window |
isResizable | whether the form is resizeable or not |
width | the width of the form |
height | the height of the form |
void com.mendix.core.actionmanagement.CoreAction< R >.addOpenFormFeedback | ( | String | formName, |
FormTarget | target, | ||
boolean | isResizable, | ||
int | width, | ||
int | height, | ||
IMendixIdentifier | currentIdentifier, | ||
List< IMendixIdentifier > | constraints | ||
) |
Add open form feedback to this action
formName | path to the form to open |
target | is target content, window (popup) or modal window |
isResizable | whether the form is resizeable or not |
width | the width of the form |
height | the height of the form |
currentIdentifier | the currentIdentifier |
constraints | the context objects |
void com.mendix.core.actionmanagement.CoreAction< R >.addOpenFormFeedback | ( | String | formName, |
String | title, | ||
FormTarget | target, | ||
boolean | isResizable, | ||
int | width, | ||
int | height, | ||
IMendixIdentifier | currentIdentifier, | ||
List< IMendixIdentifier > | constraints | ||
) |
Add open form feedback to this action
formName | path to the form to open |
title | the title of the form |
target | is target content, window (popup) or modal window |
isResizable | whether the form is resizeable or not |
width | the width of the form |
height | the height of the form |
currentIdentifier | the currentIdentifier |
constraints | the context objects |
void com.mendix.core.actionmanagement.CoreAction< R >.addRefreshClass | ( | String | objectClass | ) |
Add refresh class object feedback to this action
objectClass | the name of the class to refresh |
void com.mendix.core.actionmanagement.CoreAction< R >.addRefreshObjectFeedback | ( | IMendixIdentifier | id | ) |
Add refresh object feedback to this action
id | the id of the object to refresh |
void com.mendix.core.actionmanagement.CoreAction< R >.addRefreshObjectListFeedback | ( | List< IMendixIdentifier > | ids | ) |
Add refresh object list feedback to this action
ids | the ids of the objects to refresh |
void com.mendix.core.actionmanagement.CoreAction< R >.addTextMessageFeedback | ( | MessageType | type, |
String | message, | ||
boolean | blocking | ||
) |
Add text message feedback to this action
type | the type of message |
message | the message content |
blocking | whether the message is blocking (user has to take action before message disappears) |
boolean com.mendix.core.actionmanagement.CoreAction< R >.allowsConcurrentExecution | ( | ) |
final R com.mendix.core.actionmanagement.CoreAction< R >.call | ( | ) | throws Exception |
The call method will be executed by the ActionManager This method is final, so it can't be overridden In that way we can add security checks (etc.) before and after the 'user-implemented' actions
Object com.mendix.core.actionmanagement.CoreAction< R >.clone | ( | ) |
final IContext com.mendix.core.actionmanagement.CoreAction< R >.createContext | ( | ) |
CoreException |
abstract R com.mendix.core.actionmanagement.CoreAction< R >.execute | ( | ) | throws Exception [pure virtual] |
All sub-classes should implement this method, it will be executed by the ActionManager
Exception |
final String com.mendix.core.actionmanagement.CoreAction< R >.getActionName | ( | ) |
final IContext com.mendix.core.actionmanagement.CoreAction< R >.getContext | ( | ) |
final List<IMendixObject> com.mendix.core.actionmanagement.CoreAction< R >.getEventObjects | ( | ) |
final Exception com.mendix.core.actionmanagement.CoreAction< R >.getException | ( | ) |
final JSONObject com.mendix.core.actionmanagement.CoreAction< R >.getMetaInfo | ( | ) |
final ActionState com.mendix.core.actionmanagement.CoreAction< R >.getState | ( | ) |
CoreAction<R> com.mendix.core.actionmanagement.CoreAction< R >.getUnwrappedAction | ( | ) |
boolean com.mendix.core.actionmanagement.CoreAction< R >.isSystemAction | ( | ) |
final void com.mendix.core.actionmanagement.CoreAction< R >.setActionName | ( | String | actionName | ) |
actionName | the actionName to set |
void com.mendix.core.actionmanagement.CoreAction< R >.setContext | ( | IContext | context | ) |
final void com.mendix.core.actionmanagement.CoreAction< R >.setEventObjects | ( | List< IMendixObject > | eventObjects | ) |
final void com.mendix.core.actionmanagement.CoreAction< R >.setException | ( | Exception | exception | ) |
exception | the exception to set |
final void com.mendix.core.actionmanagement.CoreAction< R >.setMetaInfo | ( | JSONObject | metaInfo | ) |
final void com.mendix.core.actionmanagement.CoreAction< R >.setState | ( | ActionState | state | ) |
state | the new action state |
void com.mendix.core.actionmanagement.CoreAction< R >.setSystemAction | ( | boolean | isSystemAction | ) |
isSystemAction | the isSystemAction to set |
String com.mendix.core.actionmanagement.CoreAction< R >.toString | ( | ) |
String com.mendix.core.actionmanagement.CoreAction< R >.actionName [protected] |
boolean com.mendix.core.actionmanagement.CoreAction< R >.allowsConcurrentExecution [protected] |
Context com.mendix.core.actionmanagement.CoreAction< R >.context [protected] |
Defines the context of this action
String com.mendix.core.actionmanagement.CoreAction< R >.i18nWhenLockedMessageKey [protected] |
JSONObject com.mendix.core.actionmanagement.CoreAction< R >.metaInfo = new JSONObject() [protected] |
String com.mendix.core.actionmanagement.CoreAction< R >.whenLockedActionName [protected] |