public interface ICore
Modifier and Type | Method and Description |
---|---|
<T extends CoreAction<?>> |
addListener(ActionListener<T> al)
Deprecated.
As of release 7.6, replaced by
ListenersRegistry.addListener(ActionListener) |
void |
addRequestHandler(java.lang.String path,
RequestHandler requestHandler)
Deprecated.
Add a custom request handler to the Mendix Business Server.
|
void |
addUserAction(java.lang.Class<? extends UserAction<?>> userActionClass)
Deprecated.
Add the action specified by the given action name to action registry.
|
boolean |
authenticate(IContext context,
IUser user,
java.lang.String password)
Deprecated.
Authenticate the given user with the given password.
|
void |
buildException(java.lang.StringBuilder trace,
java.lang.Throwable throwable)
Deprecated.
|
boolean |
change(IContext context,
IMendixObject object,
java.util.Map<java.lang.String,java.lang.String> changes)
Deprecated.
Changes the given object in the state store (synchronously).
|
java.util.concurrent.Future<java.lang.Boolean> |
changeAsync(IContext context,
IMendixObject obj,
java.util.Map<java.lang.String,java.lang.String> changes)
Deprecated.
Changes the object (asynchronously).
|
IMendixObject |
commit(IContext context,
IMendixObject object)
Deprecated.
Commits the given object.
|
IMendixObject |
commit(IContext context,
IMendixObject object,
int queryTimeout)
Deprecated.
Commits the given object.
|
java.util.List<IMendixObject> |
commit(IContext context,
java.util.List<IMendixObject> objects)
Deprecated.
Commits the given objects.
|
java.util.List<IMendixObject> |
commit(IContext context,
java.util.List<IMendixObject> objects,
int queryTimeout)
Deprecated.
Commits the given objects.
|
java.util.List<java.util.concurrent.Future<java.util.List<IMendixObject>>> |
commitAsync(IContext context,
java.util.List<IMendixObject> objects)
Deprecated.
Commits the given object (asynchronously).
|
IMendixObject |
commitWithoutEvents(IContext context,
IMendixObject object)
Deprecated.
Commits the given object without events.
|
IMendixObject |
commitWithoutEvents(IContext context,
IMendixObject object,
int queryTimeout)
Deprecated.
Commits the given object without events.
|
java.util.List<IMendixObject> |
commitWithoutEvents(IContext context,
java.util.List<IMendixObject> objects)
Deprecated.
Commits the given objects without events.
|
java.util.List<IMendixObject> |
commitWithoutEvents(IContext context,
java.util.List<IMendixObject> objects,
int queryTimeout)
Deprecated.
Commits the given objects without events.
|
IDataType |
createDataType(java.lang.String type)
Deprecated.
Creates a DataType based on a type.
Possible types: - Boolean - Integer - Long - Float - String - Datetime - {code#id} (enumeration key) - ModuleName.ObjectName (IMendixObject) - [ModuleName.ObjectName] (List<IMendixObject>) |
IDataType |
createDataType(java.lang.String objectType,
java.lang.String attributeName)
Deprecated.
Creates a DataType based on an object type and a attribute name.
|
IMendixIdentifier |
createMendixIdentifier(long guid)
Deprecated.
Creates a new IMendixIdentifier for the given guid.
|
IMendixIdentifier |
createMendixIdentifier(java.lang.String guid)
Deprecated.
Creates a IMendixIdentifier for the given guid.
|
IOQLTextGetRequest |
createOQLTextGetRequest()
Deprecated.
Create a new IOQLTextGetRequest.
|
IOQLTextGetRequest |
createOQLTextGetRequestFromDataSet(java.lang.String dataSetQualifiedName)
Deprecated.
Instantiate
IOQLTextGetRequest from given qualified DataSet name. |
IRetrievalSchema |
createRetrievalSchema()
Deprecated.
Create a new IRetrievalSchema.
|
IContext |
createSystemContext()
Deprecated.
Returns the context of the system session (this is always a sudo context).
|
XPathQuery |
createXPathQuery(java.lang.String xpathQuery)
Deprecated.
Creates an XPath query representation that can be built up in a fluent manner
|
IXPathTextGetRequest |
createXPathTextGetRequest()
Deprecated.
Create a new IXPathTextGetRequest.
|
boolean |
delete(IContext context,
IMendixObject... objects)
Deprecated.
Deletes the given objects from the database and server state store (synchronously).
|
boolean |
delete(IContext context,
int queryTimeout,
IMendixObject... objects)
Deprecated.
Deletes the given objects from the database and server state store (synchronously).
|
boolean |
delete(IContext context,
java.util.List<IMendixObject> objectList)
Deprecated.
Deletes the given objects from the database and server state store (synchronously).
|
java.util.List<java.util.concurrent.Future<java.lang.Boolean>> |
deleteAsync(IContext context,
IMendixObject object,
boolean useDeleteBehavior)
Deprecated.
Deletes the given object from the database and server state store (asynchronously).
|
java.util.List<java.util.concurrent.Future<java.lang.Boolean>> |
deleteAsync(IContext context,
java.util.List<IMendixObject> objects,
boolean useDeleteBehavior)
Deprecated.
Deletes the given object from the database and server state store (asynchronously).
|
boolean |
deleteWithoutEvents(IContext context,
java.util.List<IMendixObject> objects,
boolean useDeleteBehavior)
Deprecated.
Deletes the given objects from the database and server state store (synchronously) without events This action is executed in a
transaction.
|
java.lang.Object |
evaluateExpression(IContext context,
java.util.Map<java.lang.String,java.lang.Object> variables,
java.lang.String expression)
Deprecated.
Evaluate the given (microflow)expression.
|
<R> R |
execute(IContext context,
java.lang.String actionName,
boolean executeInTransaction,
java.util.Map<java.lang.String,java.lang.Object> params)
Deprecated.
Execute the specified action (synchronously).
|
<R> R |
execute(IContext context,
java.lang.String actionName,
java.util.Map<java.lang.String,java.lang.Object> params)
Deprecated.
Execute the specified action (synchronously).
|
<R> R |
execute(IContext context,
java.lang.String actionName,
java.lang.Object... params)
Deprecated.
Execute a Java or microflow action synchronously based on the name passed.
|
<T extends CoreAction<R>,R> |
execute(T action)
Deprecated.
Execute an action asynchronously, result is given and/or exceptions are raised when calling Future.get().
|
<R> java.util.concurrent.Future<R> |
executeAsync(IContext context,
java.lang.String actionName,
long asyncId,
boolean executeInTransaction,
java.util.Map<java.lang.String,java.lang.Object> params)
Deprecated.
Execute the specified microflow (asynchronously).
|
<R> java.util.concurrent.Future<R> |
executeAsync(IContext context,
java.lang.String actionName,
long asyncId,
java.lang.Object... params)
Deprecated.
Execute the specified action (asynchronously)
Result is given and/or exceptions are raised when calling Future.get().
|
<R> java.util.concurrent.Future<R> |
executeAsync(IContext context,
java.lang.String actionName,
java.lang.Object... params)
Deprecated.
Execute the specified action (asynchronously)
Result is given and/or exceptions are raised when calling Future.get().
|
<T extends ICoreAction<R>,R> |
executeSync(T action)
Deprecated.
Execute an action synchronously.
|
<T extends CoreAction<R>,R> |
executeVoid(T action)
Deprecated.
Execute the specified action (asynchronously).
|
int |
getActionQueueSize()
Deprecated.
Returns the current action pool queue size.
|
int |
getActiveActionCount()
Deprecated.
Returns the current number of active actions.
|
ISession |
getActiveSession(java.lang.String userName)
Deprecated.
use xpath query on session table instead.
|
java.util.Collection<? extends ISession> |
getActiveSessions()
Deprecated.
use xpath query on session table instead.
|
java.lang.Iterable<IMendixObject> |
getAllMendixObjects()
Deprecated.
Get all IMendixObject types.
|
long |
getCompletedActionCount()
Deprecated.
Returns the number of completed actions since server startup.
|
long |
getConcurrentUserCount(boolean anonymous)
Deprecated.
The current number of concurrent users.
|
Configuration |
getConfiguration()
Deprecated.
|
int |
getCurrentPoolSize()
Deprecated.
Returns the current action pool size.
|
java.lang.String |
getDatabaseChildColumnName(IMetaAssociation metaAssociation)
Deprecated.
Returns the name of the database column for the child of the given association.
|
java.lang.String |
getDatabaseColumnName(IMetaPrimitive metaPrimitive)
Deprecated.
Returns the name of the database column for the given attribute.
|
java.lang.String |
getDatabaseParentColumnName(IMetaAssociation metaAssociation)
Deprecated.
Returns the name of the database column for the parent of the given association.
|
java.lang.String |
getDatabaseTableName(IMetaAssociation metaAssociation)
Deprecated.
Returns the name of the database table for the given association.
|
java.lang.String |
getDatabaseTableName(IMetaObject metaObject)
Deprecated.
Returns the name of the database table for the given entity type.
|
ILanguage |
getDefaultLanguage()
Deprecated.
Returns the default language of the loaded project.
|
java.io.InputStream |
getFileDocumentContent(IContext context,
IMendixObject fileDocument)
Deprecated.
Returns contents of a file document as an input stream.
|
java.io.InputStream |
getImage(IContext context,
IMendixObject imageDocument,
boolean retrieveThumbnail)
Deprecated.
Retrieve contents of the given image document.
|
java.util.Map<java.lang.String,IDataType> |
getInputParameters(java.lang.String actionName)
Deprecated.
Returns all input parameter data types the specified action by name.
|
java.lang.String |
getInternationalizedString(IContext context,
java.lang.String key,
java.lang.Object... args)
Deprecated.
Returns the translated string for a certain key and context.
|
java.lang.String |
getInternationalizedString(java.lang.String languageCode,
java.lang.String key,
java.lang.Object... args)
Deprecated.
Returns the translated string for a certain key and language code.
|
int |
getLargestPoolSize()
Deprecated.
Returns the largest action pool size.
|
ListenersRegistry |
getListenersRegistry()
Deprecated.
Returns an instance of
ListenersRegistry which can be used to register
callbacks on system events for all persistable entities in the application. |
java.util.Locale |
getLocale(IContext context)
Deprecated.
Retrieve locale using the given context.
|
java.util.Locale |
getLocale(java.lang.String languageCode)
Deprecated.
Retrieve locale using the given language code (e.g.
|
com.mendix.logging.ILogNode |
getLogger(java.lang.String name)
Deprecated.
|
int |
getMaximumNumberConcurrentUsers()
Deprecated.
Returns the maximum number of concurrent users since the server was started.
|
IMetaAssociation |
getMetaAssociation(java.lang.String association)
Deprecated.
Get the IMetaAssociation corresponding to the given association name.
|
java.lang.Iterable<IMetaAssociation> |
getMetaAssociations()
Deprecated.
Get all IMetaAssociations.
|
IMetaObject |
getMetaObject(java.lang.String metaObjectName)
Deprecated.
Get the IMetaObject corresponding to the given meta object name.
|
java.lang.Iterable<IMetaObject> |
getMetaObjects()
Deprecated.
Get all IMetaObjects.
|
IMetaPrimitive |
getMetaPrimitive(java.lang.String qualifiedAttributeName)
Deprecated.
Get the IMetaPrimtive based on a qualified attribute name (e.g.
|
java.util.Set<java.lang.String> |
getMicroflowNames()
Deprecated.
Returns the names of all modeled microflows.
|
java.lang.String |
getModelVersion()
Deprecated.
Returns the model version of the project.
|
long |
getNamedUserCount()
Deprecated.
|
long |
getNumberConcurrentSessions()
Deprecated.
Returns current number of concurrent sessions.
|
IProfiler |
getProfiler()
Deprecated.
|
java.util.UUID |
getProjectId()
Deprecated.
Returns the project identifier of the project.
|
IDataType |
getReturnType(java.lang.String actionName)
Deprecated.
Returns the return type of the specified action.
|
int |
getScheduledActionCount()
Deprecated.
Returns the number of actions currently scheduled for future execution.
|
ISession |
getSessionById(java.util.UUID sessionId)
Deprecated.
Returns the session belonging to the given session id.
|
java.util.Date |
getStartupDateTime()
Deprecated.
Returns the startup date time of the Mendix Business Server.
|
java.util.List<java.lang.String> |
getSubtypesOf(java.lang.String objectType)
Deprecated.
Get all subtypes for an object type (including subtypes of subtypes, etc.).
|
IUser |
getUser(IContext context,
java.lang.String userName)
Deprecated.
Returns a user using the given user name.
|
java.lang.String |
getXASId()
Deprecated.
Returns the id of this server instance.
|
ISession |
initializeGuestSession()
Deprecated.
Initialize a new session for a guest user.
|
ISession |
initializeSession(IUser user,
java.lang.String currentSessionId)
Deprecated.
Initialize a new session for the given user.
|
IMendixObject |
instantiate(IContext context,
java.lang.String objectType)
Deprecated.
Creates a new IMendixObject with the given object type (synchronously).
|
java.util.concurrent.Future<IMendixObject> |
instantiateAsync(IContext context,
java.lang.String objectType)
Deprecated.
Creates a new IMendixObject with the given object type (asynchronously).
|
boolean |
isInDevelopment()
Deprecated.
|
boolean |
isSubClassOf(IMetaObject superObject,
IMetaObject type)
Deprecated.
Checks whether a type is a subclass of or equal to a potential super class.
|
boolean |
isSubClassOf(java.lang.String superClass,
short typeHash)
Deprecated.
Checks whether a type is a subclass of or equal to a potential super class.
|
boolean |
isSubClassOf(java.lang.String superClass,
java.lang.String type)
Deprecated.
Checks whether a type is a subclass of or equal to a potential super class.
|
ISession |
login(java.util.Map<java.lang.String,? extends java.lang.Object> params)
Deprecated.
Generic login method (can be used in modules in combination with LoginAction replacement).
|
ISession |
login(java.lang.String userName,
java.lang.String password)
Deprecated.
Login user with the given user name and password.
|
ISession |
login(java.lang.String userName,
java.lang.String password,
com.mendix.m2ee.api.IMxRuntimeRequest request)
Deprecated.
|
ISession |
login(java.lang.String userName,
java.lang.String password,
java.lang.String currentSessionId)
Deprecated.
Login user with the given parameters.
|
void |
logout(ISession session)
Deprecated.
Logout the given session.
|
MicroflowCallBuilder |
microflowCall(java.lang.String name)
Deprecated.
|
void |
registerLogSubscriber(com.mendix.logging.LogSubscriber subscriber)
Deprecated.
|
void |
registerProfiler(IProfiler profiler)
Deprecated.
|
boolean |
removeScheduledFuture(java.util.concurrent.RunnableScheduledFuture<?> scheduledFuture)
Deprecated.
Remove scheduled future.
|
<R> java.util.concurrent.ScheduledFuture<?> |
reschedule(java.util.concurrent.RunnableScheduledFuture<R> scheduledFuture,
CoreAction<R> action,
long newDelay,
java.util.concurrent.TimeUnit timeUnit)
Deprecated.
Reschedule an action with a new delay.
|
java.lang.Object |
resolveTokens(IContext context,
java.lang.String text)
Deprecated.
Resolve tokens (Mendix system variables) in the given text.
|
java.util.List<IMendixObject> |
retrieveByIdWithSchema(IContext context,
IMendixIdentifier id,
IRetrievalSchema schema)
Deprecated.
|
java.util.List<IMendixObject> |
retrieveByPath(IContext context,
IMendixObject mxObject,
java.lang.String path)
Deprecated.
Retrieves objects using the given object and path.
|
java.util.List<IMendixObject> |
retrieveByPath(IContext context,
IMendixObject mxObject,
java.lang.String path,
boolean isSelfAssociationChild)
Deprecated.
Retrieves objects using the given object and path.
|
java.util.List<IMendixObject> |
retrieveByPath(IContext context,
IMendixObject mxObject,
java.lang.String path,
java.lang.String entity,
boolean isSelfAssociationChild)
Deprecated.
Retrieves objects using the given object and path.
|
IMendixObject |
retrieveId(IContext context,
IMendixIdentifier id)
Deprecated.
Retrieves object with the given id (synchronously).
|
java.util.concurrent.Future<IMendixObject> |
retrieveIdAsync(IContext context,
IMendixIdentifier id)
Deprecated.
Retrieves object with the given id (asynchronously).
|
java.util.List<IMendixObject> |
retrieveIdList(IContext context,
java.util.List<IMendixIdentifier> ids)
Deprecated.
Retrieves objects with the given ids (synchronously).
|
java.util.List<IMendixObject> |
retrieveIdList(IContext context,
java.util.List<IMendixIdentifier> ids,
int amount,
int offset,
java.util.Map<java.lang.String,java.lang.String> sort)
Deprecated.
Retrieves objects with the given ids (synchronously).
|
java.util.concurrent.Future<java.util.List<IMendixObject>> |
retrieveIdListAsync(IContext context,
java.util.List<IMendixIdentifier> ids)
Deprecated.
Retrieves objects with the given ids (asynchronously).
|
IDataTable |
retrieveOQLDataTable(IContext context,
IGetRequest request)
Deprecated.
Retrieve raw data (IDataTable) using an IGetRequest object (synchronously).
|
IDataTable |
retrieveOQLDataTable(IContext context,
java.lang.String oqlQuery)
Deprecated.
Retrieve raw data (IDataTable) using an IGetRequest object (synchronously).
|
IDataTable |
retrieveOQLDataTable(IContext context,
java.lang.String oqlQuery,
int amount,
int offset)
Deprecated.
Retrieve raw data (IDataTable) using an OQL query (asynchronously).
|
java.util.concurrent.Future<IDataTable> |
retrieveOQLDataTableAsync(IContext context,
IGetRequest request)
Deprecated.
Retrieve raw data (IDataTable) using an IGetRequest object (asynchronously).
|
java.util.concurrent.Future<IDataTable> |
retrieveOQLDataTableAsync(IContext context,
java.lang.String oqlQuery)
Deprecated.
Retrieve raw data (IDataTable) using an OQL query (asynchronously).
|
java.util.concurrent.Future<IDataTable> |
retrieveOQLDataTableAsync(IContext context,
java.lang.String oqlQuery,
int amount,
int offset)
Deprecated.
Retrieve raw data (IDataTable) using an OQL query (asynchronously).
|
java.util.List<IMendixObject> |
retrieveXPathQuery(IContext context,
java.lang.String xpathQuery)
Deprecated.
Retrieves object list based on the given XPath query (synchronously).
|
java.util.List<IMendixObject> |
retrieveXPathQuery(IContext context,
java.lang.String xpathQuery,
int amount,
int offset,
java.util.Map<java.lang.String,java.lang.String> sort)
Deprecated.
Retrieves object list based on the given XPath query (synchronously).
|
java.util.List<IMendixObject> |
retrieveXPathQuery(IContext context,
java.lang.String xpathQuery,
int amount,
int offset,
java.util.Map<java.lang.String,java.lang.String> sort,
int depth)
Deprecated.
Retrieves object list based on the given XPath query (synchronously).
|
java.util.List<IMendixObject> |
retrieveXPathQuery(IContext context,
java.lang.String xpathQuery,
int amount,
int offset,
java.util.Map<java.lang.String,java.lang.String> sort,
int depth,
int timeout)
Deprecated.
|
java.lang.Long |
retrieveXPathQueryAggregate(IContext context,
java.lang.String xpathQuery)
Deprecated.
Retrieves long aggregate value based on the given query (root element of the query should be an aggregate function) (synchronously).
|
java.util.concurrent.Future<java.lang.Long> |
retrieveXPathQueryAggregateAsync(IContext context,
java.lang.String xpathQuery)
Deprecated.
Retrieves long aggregate value based on the given query (root element of the query should be an aggregate function) (asynchronously).
|
java.util.concurrent.Future<java.lang.Double> |
retrieveXPathQueryAggregateAsyncDouble(IContext context,
java.lang.String xpathQuery)
Deprecated.
Retrieves long value based on the given query (query should have an aggregate function as root element).
|
java.math.BigDecimal |
retrieveXPathQueryAggregateDecimal(IContext context,
java.lang.String xpathQuery)
Deprecated.
|
java.lang.Double |
retrieveXPathQueryAggregateDouble(IContext context,
java.lang.String xpathQuery)
Deprecated.
Retrieves double aggregate value based on the given query (root element of the query should be an aggregate function) (synchronously).
|
java.lang.Long |
retrieveXPathQueryAggregateSchema(IContext context,
java.lang.String xpathQuery,
IRetrievalSchema retrievalSchema)
Deprecated.
Retrieves long aggregate value based on the given query and schema (root element of the query should be an aggregate function).
|
java.lang.Long |
retrieveXPathQueryAggregateSchema(IContext context,
java.lang.String xpathQuery,
IRetrievalSchema retrievalSchema,
boolean disableSecurity)
Deprecated.
Retrieves long aggregate value based on the given query and schema (root element of the query should be an aggregate function).
|
java.util.concurrent.Future<java.util.List<IMendixObject>> |
retrieveXPathQueryAsync(IContext context,
java.lang.String xpathQuery,
int amount,
int offset,
java.util.Map<java.lang.String,java.lang.String> sort,
int depth)
Deprecated.
Retrieves object list based on the given XPath query (asynchronously).
|
java.util.List<IMendixObject> |
retrieveXPathQueryEscaped(IContext context,
java.lang.String xpathFormat,
int amount,
int offset,
java.util.Map<java.lang.String,java.lang.String> sort,
int depth,
java.lang.String... params)
Deprecated.
As of release 7.17, replaced by
createXPathQuery(String) |
java.util.List<IMendixObject> |
retrieveXPathQueryEscaped(IContext context,
java.lang.String xpathFormat,
java.lang.String... params)
Deprecated.
As of release 7.17, replaced by
createXPathQuery(String) |
IDataTable |
retrieveXPathQueryRaw(IContext context,
java.lang.String xpathQuery,
int amount,
int offset,
java.util.Map<java.lang.String,java.lang.String> sort,
int depth)
Deprecated.
Retrieves raw data (IDataTables) based on the given XPath query (synchronously).
|
java.util.List<IMendixObject> |
retrieveXPathSchema(IContext context,
java.lang.String xpathQuery,
IRetrievalSchema retrievalSchema,
boolean shouldRetrieveCount,
boolean disableSecurity)
Deprecated.
Retrieves objects based on the XPath query and given schema (synchronously).
|
java.util.List<IMendixObject> |
retrieveXPathSchemaEscaped(IContext context,
java.lang.String xpathFormat,
IRetrievalSchema retrievalSchema,
boolean shouldRetrieveCount,
boolean disableSecurity,
java.lang.String... params)
Deprecated.
As of release 7.17, replaced by
createXPathQuery(String) |
IDataTable |
retrieveXPathSchemaRaw(IContext context,
java.lang.String xpathQuery,
boolean shouldRetrieveCount,
IRetrievalSchema retrievalSchema)
Deprecated.
Retrieves raw data (IDataTables) based on the XPath query and given schema (synchronously).
|
IMendixObject |
rollback(IContext context,
IMendixObject object)
Deprecated.
Rollback changes of the object with the given id (synchronously).
|
java.util.concurrent.Future<IMendixObject> |
rollbackAsync(IContext context,
IMendixObject object)
Deprecated.
Rollback changes of the object with the given id (asynchronously).
|
<R> java.util.concurrent.RunnableScheduledFuture<?> |
schedule(CoreAction<R> action,
long delay,
java.util.concurrent.TimeUnit timeUnit)
Deprecated.
Schedule an action on a certain delay from now.
|
<R> java.util.concurrent.RunnableScheduledFuture<?> |
schedule(java.lang.String actionName,
java.util.Date date)
Deprecated.
Schedule an action on a certain date.
|
<R> void |
scheduleAtFixedRate(CoreAction<R> action,
java.util.Date firstRun,
long period,
java.util.concurrent.TimeUnit timeUnit)
Deprecated.
Schedule a periodic action that run for the first time on the given date/time, and subsequently with the given period;
that is executions will commence on firstRun then initialDelay+period,
then initialDelay + 2 * period, and so on.
No result will be returned. |
<R> void |
scheduleAtFixedRate(CoreAction<R> action,
long initialDelay,
long period,
java.util.concurrent.TimeUnit timeUnit)
Deprecated.
Schedule a periodic action that runs for the first time after the given initial delay, and subsequently with the given period;
that is executions will commence after initialDelay then
initialDelay+period, then initialDelay + 2 * period, and so on.
|
<R> void |
scheduleAtFixedRate(java.lang.String actionName,
java.util.Date firstRun,
long period,
java.util.concurrent.TimeUnit timeUnit,
java.lang.String name,
java.lang.String description)
Deprecated.
Schedule a periodic action that runs for the first time after the given initial delay (first run), and subsequently with the given
period; that is executions will commence after initialDelay
then initialDelay+period, then initialDelay + 2 * period, and so on.
|
<R> void |
scheduleWithFixedDelay(CoreAction<R> action,
long initialDelay,
long delay,
java.util.concurrent.TimeUnit timeUnit)
Deprecated.
Schedule a periodic action that runs for the first time after the given initial delay, and subsequently with the given delay between
the termination of one execution and the commencement of the
next.
|
void |
storeFileDocumentContent(IContext context,
IMendixObject fileDocument,
java.io.InputStream inputStream)
Deprecated.
Physically stores a file using the given input stream and commits the file document.
|
void |
storeFileDocumentContent(IContext context,
IMendixObject fileDocument,
java.lang.String fileName,
java.io.InputStream inputStream)
Deprecated.
Physically stores a file using the given input stream and commits the file document.
|
void |
storeImageDocumentContent(IContext context,
IMendixObject imageDocument,
java.io.InputStream inputStream,
int thumbnailWidth,
int thumbnailHeight)
Deprecated.
Physically stores an image using the given input stream and commits the image document.
|
void |
unregisterProfiler()
Deprecated.
|
ListenersRegistry getListenersRegistry()
ListenersRegistry
which can be used to register
callbacks on system events for all persistable entities in the application.@Deprecated <T extends CoreAction<?>> void addListener(ActionListener<T> al)
ListenersRegistry.addListener(ActionListener)
al
- the ActionListener to add.void addUserAction(java.lang.Class<? extends UserAction<?>> userActionClass)
execute(actionName)
for this action.userActionClass
- the action (e.g. com.mendix.action.MyAction).boolean authenticate(IContext context, IUser user, java.lang.String password) throws CoreException
CoreException
void buildException(java.lang.StringBuilder trace, java.lang.Throwable throwable)
boolean change(IContext context, IMendixObject object, java.util.Map<java.lang.String,java.lang.String> changes) throws CoreException
context
- the context.object
- the object to change.changes
- contains changes by member name (e.g. <"Name", "User1">).CoreException
java.util.concurrent.Future<java.lang.Boolean> changeAsync(IContext context, IMendixObject obj, java.util.Map<java.lang.String,java.lang.String> changes)
context
- the context.obj
- the MendixObject to changechanges
- contains changes by member name (e.g. <"Name", "User1">).IMendixObject commit(IContext context, IMendixObject object) throws CoreException
context
- the context.object
- the IMendixObject to commit.CoreRuntimeException
- if commit failsCoreException
java.util.List<IMendixObject> commit(IContext context, java.util.List<IMendixObject> objects)
context
- the context.objects
- the objects to commit.CoreRuntimeException
- if commit failsIMendixObject commit(IContext context, IMendixObject object, int queryTimeout)
context
- the context.object
- the IMendixObject to commit.queryTimeout
- the timeout for queries related to this commit.CoreRuntimeException
- if commit failsjava.util.List<IMendixObject> commit(IContext context, java.util.List<IMendixObject> objects, int queryTimeout)
context
- the context.objects
- the objects to commit.queryTimeout
- the timeout for queries related to this commit.CoreRuntimeException
- if commit failsjava.util.List<java.util.concurrent.Future<java.util.List<IMendixObject>>> commitAsync(IContext context, java.util.List<IMendixObject> objects)
context
- the contextobjects
- the instances of IMendixObject to commit.IMendixObject commitWithoutEvents(IContext context, IMendixObject object)
Commits the given object without events. This will store the object in the database and remove it from the server cache.
This action is executed in a transaction.
Validations except unique validation are not executed. It is possible to save an entity which would not pass validations using this method.
context
- the context.object
- the IMendixObject to commit.CoreRuntimeException
- if commit failsIMendixObject commitWithoutEvents(IContext context, IMendixObject object, int queryTimeout)
Commits the given object without events. This will store the object in the database and remove it from the server cache.
This action is executed in a transaction.
Validations except unique validation are not executed. It is possible to save an entity which would not pass validations using this method.
context
- the context.object
- the IMendixObject to commit.queryTimeout
- the timeout for queries related to this commit.CoreRuntimeException
- if commit failsjava.util.List<IMendixObject> commitWithoutEvents(IContext context, java.util.List<IMendixObject> objects)
Commits the given objects without events. This will store the objects in the database and remove it from the server cache.
This action is executed in a transaction.
Validations except unique validation are not executed. It is possible to save entities which would not pass validations using this method.
context
- the context.objects
- the objects to commit.CoreRuntimeException
- if commit failsjava.util.List<IMendixObject> commitWithoutEvents(IContext context, java.util.List<IMendixObject> objects, int queryTimeout)
Commits the given objects without events. This will store the objects in the database and remove it from the server cache.
This action is executed in a transaction.
Validations except unique validation are not executed. It is possible to save entities which would not pass validations using this method.
context
- the context.objects
- the objects to commit.queryTimeout
- the query timeout.CoreRuntimeException
- if commit failsIDataType createDataType(java.lang.String type)
type
- the type to base the IDataType on.IDataType createDataType(java.lang.String objectType, java.lang.String attributeName)
objectType
- the object type (format: "ModuleName.EntityName").attributeName
- the attribute to create the IDataType for (should be a member of above object type)IMendixIdentifier createMendixIdentifier(long guid)
guid
- the guid.IMendixIdentifier createMendixIdentifier(java.lang.String guid)
guid
- the guid.IOQLTextGetRequest createOQLTextGetRequest()
IOQLTextGetRequest createOQLTextGetRequestFromDataSet(java.lang.String dataSetQualifiedName)
IOQLTextGetRequest
from given qualified DataSet name.
Code examples
Example OQL query without parameters
private String getOqlQueryFromDataSet(String dataSetName) {
final IOQLTextGetRequest oqlTextGetRequest = Core.createOQLTextGetRequestFromDataSet(dataSetName);
return oqlTextGetRequest.getQuery();
}
public Report generateReport() {
String oqlQuery = getOqlQueryFromDataSet();
final IDataTable dataTable = Core.retrieveOQLDataTable(context, oqlQuery);
final List<? extends IDataRow> rows = dataTable.getRows();
Report report = new Report();
report.addRow(rows.get(0));
return report;
}
The above example first defines a getOqlQueryFromDataSet method at the top, which returns a OQL query in string format.
It takes a qualified dataSetName which means DataSet name along with its module name separated by '.' character.
For example, if the name of the DataSet is ReportGeneratorDataSet and it belongs to a module named Reporting
then the qualified DataSet name will be Reporting.ReportGeneratorDataSet.
public Report generateReport(String dataSetName) {
final IOQLTextGetRequest oqlTextGetRequest = Core.createOQLTextGetRequestFromDataSet(dataSetName);
final IParameterMap newParameterMap = oqlTextGetRequest.createParameterMap();
newParameterMap.put("ParGroupNumber", 4); // Set value of ParGroupNumber parameter to 4
oqlTextGetRequest.setParameters(newParameterMap);
final IDataTable dataTable = Core.retrieveOQLDataTable(context, oqlTextGetRequest);
final List<? extends IDataRow> rows = dataTable.getRows();
Report report = new Report();
report.addRow(rows.get(0));
return report;
}
The above example defines a similar generateReport method as shown in the previous example, however in this case the given
DataSet has a OQL query which takes parameters.
Let us consider that the given DataSet contains following OQL query with a parameter named ParGroupNumber -
FROM CRM.Customers As CustomerObj
INNER JOIN CustomerObj/CRM.Orders_Customer/CRM.Orders As OrderObj
WHERE CustomerObj/CRM.Customer_Group/CRM.Group/GroupNumber = $ParGroupNumber
GROUP BY CustomerObj/Name
SELECT CustomerObj/Name As Name, SUM(OrderObj/TotalAmount) As TotalAmount
Using the DataSet name generateReport method first creates a oqlTextGetRequest. Next, in order to set the
ParGroupNumber parameter a new IParameterMap is instantiated and the value of ParGroupNumber parameter is specified,
which in the above example would be 4.
Finally we provide this newParameterMap to the setParameters method of IOQLTextGetRequest.
This modified request is then used to retrieve a data table from the database, which in turn is used to generate a report.dataSetQualifiedName
- the qualified name of the DataSet containing OQLIOQLTextGetRequest
if DataSet with OQL is found by given namejava.lang.IllegalArgumentException
- if given qualified name is null, has invalid format, found DataSet
contains Java Action or DataSet is not foundIRetrievalSchema createRetrievalSchema()
IContext createSystemContext()
ISession getSessionById(java.util.UUID sessionId)
sessionId
- A session id.IXPathTextGetRequest createXPathTextGetRequest()
XPathQuery createXPathQuery(java.lang.String xpathQuery)
Can be used to create and execute XPath queries in a fluent manner. For example:
public getObjectsWithValue(IContext context, ICore core, int value) {
List<IMendixObject> results = core.createXPathQuery("//Entity[attribute=$value]")
.setVariable("value", 1)
.setAmount(500)
.setOffset(50)
.setDepth(1)
.execute(context);
return results;
}
After the XPath query
is built up, XPathQueryBase.execute(IContext)
can be called to retrieve the results.
xpathQuery
- the XPath query to execute. Variable can be denoted with '$', e.g. a valid query syntax could be
'//Entity.Ref[field >= $limit)'.XPathQuery
that can be use to construct an XPath queryboolean delete(IContext context, IMendixObject... objects)
context
- the context.objects
- the objects to delete.boolean delete(IContext context, int queryTimeout, IMendixObject... objects)
context
- the context.objects
- the objects to delete.queryTimeout
- the timeout for queries related to this delete.boolean delete(IContext context, java.util.List<IMendixObject> objectList)
context
- the context.objectList
- the objects to delete.java.util.List<java.util.concurrent.Future<java.lang.Boolean>> deleteAsync(IContext context, IMendixObject object, boolean useDeleteBehavior)
context
- the context.object
- the object to delete.useDeleteBehavior
- whether to use delete behavior.java.util.List<java.util.concurrent.Future<java.lang.Boolean>> deleteAsync(IContext context, java.util.List<IMendixObject> objects, boolean useDeleteBehavior)
context
- the context.objects
- the objects to delete.useDeleteBehavior
- whether to use delete behavior.boolean deleteWithoutEvents(IContext context, java.util.List<IMendixObject> objects, boolean useDeleteBehavior)
context
- the context.objects
- the objects to delete.useDeleteBehavior
- whether to use delete behavior.java.lang.Object evaluateExpression(IContext context, java.util.Map<java.lang.String,java.lang.Object> variables, java.lang.String expression)
context
- the context.variables
- name of variables referenced in the expression (without '$') and their values.expression
- the expressionMicroflowCallBuilder microflowCall(java.lang.String name)
<R> R execute(IContext context, java.lang.String actionName, boolean executeInTransaction, java.util.Map<java.lang.String,java.lang.Object> params) throws CoreException
context
- the context for this action.actionName
- the name of a microflow or java action (format "ModuleName.ActionName").executeInTransaction
- defines whether the action should be execute in a transaction (enables rolling back changes when exceptions
are raised).params
- action parameters by name.CoreException
<R> R execute(IContext context, java.lang.String actionName, java.util.Map<java.lang.String,java.lang.Object> params) throws CoreException
context
- the context for this action.actionName
- the name of a microflow or java action (format "ModuleName.ActionName").params
- action parameters by name.CoreException
<R> R execute(IContext context, java.lang.String actionName, java.lang.Object... params) throws CoreException
Note that when called with a microflow, primitives will not be passed and multiple arguments that are a subtype of a microflow parameter will not work as expected.
When calling microflows use execute(IContext, String, boolean, Map)
instead.
context
- the contextactionName
- the name of the user action or microflowparams
- the objects to be passed to either the constructor of the Java action or the microflow in
which case one can pass IMendixObject, IMendixIdentifier or primitive values.CoreException
<T extends CoreAction<R>,R> java.util.concurrent.Future<R> execute(T action)
T
- action type, subclass of CoreAction.R
- result type of the action, can be any object.action
- the action to execute.<R> java.util.concurrent.Future<R> executeAsync(IContext context, java.lang.String actionName, long asyncId, boolean executeInTransaction, java.util.Map<java.lang.String,java.lang.Object> params) throws CoreException
context
- the context for this microflow.actionName
- the name of the microflow (format "ModuleName.ActionName").asyncId
- async id of this microflow.executeInTransaction
- defines whether the microflow should be executed in a transaction (enables rolling back changes when
exceptions are raised).params
- microflow parameters by name.CoreException
<R> java.util.concurrent.Future<R> executeAsync(IContext context, java.lang.String actionName, long asyncId, java.lang.Object... params) throws CoreException
executeAsync(IContext, String, long, boolean, Map)
instead.context
- the context for this action.actionName
- the name of a microflow or java action (format "ModuleName.ActionName").asyncId
- the asyncId this action has.params
- for microflows: add IMendixObject, IMendixIdentifier or primitive parameters.
for Java actions: add any object parameters.CoreException
<R> java.util.concurrent.Future<R> executeAsync(IContext context, java.lang.String actionName, java.lang.Object... params) throws CoreException
context
- the context for this action.actionName
- the name of a microflow or java action (format "ModuleName.ActionName").params
- for microflows: add IMendixObject, IMendixIdentifier or primitive parameters.
for Java actions: add any object parameters.CoreException
<T extends ICoreAction<R>,R> R executeSync(T action) throws CoreException
T
- action type, subclass of CoreAction.R
- result type of action, can be any object.action
- the action to execute.CoreException
<T extends CoreAction<R>,R> void executeVoid(T action)
R
- result type of the action, can be any object.T
- action type, subclass of CoreAction.action
- the action to execute.int getActionQueueSize()
int getActiveActionCount()
@Deprecated ISession getActiveSession(java.lang.String userName)
userName
- the user name associated with the session to search for.@Deprecated java.util.Collection<? extends ISession> getActiveSessions()
java.lang.Iterable<IMendixObject> getAllMendixObjects()
long getCompletedActionCount()
long getConcurrentUserCount(boolean anonymous)
anonymous
- whether anonymous users should be included in the count.Configuration getConfiguration()
int getCurrentPoolSize()
java.lang.String getDatabaseChildColumnName(IMetaAssociation metaAssociation)
metaAssociation
- the meta association to get the database child column name forjava.lang.String getDatabaseColumnName(IMetaPrimitive metaPrimitive)
metaPrimitive
- the meta primitive to get the database column name forjava.lang.String getDatabaseParentColumnName(IMetaAssociation metaAssociation)
metaAssociation
- the meta association to get the database parent column name forjava.lang.String getDatabaseTableName(IMetaObject metaObject)
metaObject
- the meta object to get the database table name forjava.lang.String getDatabaseTableName(IMetaAssociation metaAssociation)
metaAssociation
- the meta association to get the database table name forILanguage getDefaultLanguage()
java.io.InputStream getFileDocumentContent(IContext context, IMendixObject fileDocument)
context
- the context.fileDocument
- the file document from which the contents will be returned.java.io.InputStream getImage(IContext context, IMendixObject imageDocument, boolean retrieveThumbnail)
context
- the context.imageDocument
- the image document for which its contents are retrieved.retrieveThumbnail
- indicates whether a thumbnail or the full image is retrieved.java.util.Map<java.lang.String,IDataType> getInputParameters(java.lang.String actionName)
actionName
- the name of a microflow or java action (format "ModuleName.ActionName").java.lang.String getInternationalizedString(IContext context, java.lang.String key, java.lang.Object... args)
context
- the context.key
- the key referring to the translatable string.args
- the arguments which should be applied to translatable string template.java.lang.String getInternationalizedString(java.lang.String languageCode, java.lang.String key, java.lang.Object... args)
languageCode
- the language code (ISO-639).key
- the key referring to the translatable string.args
- values which should replace possible templates in the translatable string ({1}, {2}, etc.).int getLargestPoolSize()
java.util.Locale getLocale(IContext context)
context
- the context.java.util.Locale getLocale(java.lang.String languageCode)
languageCode
- the languageCode (ISO-639).int getMaximumNumberConcurrentUsers() throws CoreException
CoreException
IMetaAssociation getMetaAssociation(java.lang.String association)
association
- the association name (e.g. "System.UserRoles").java.lang.Iterable<IMetaAssociation> getMetaAssociations()
IMetaObject getMetaObject(java.lang.String metaObjectName)
metaObjectName
- the meta object name.java.lang.Iterable<IMetaObject> getMetaObjects()
IMetaPrimitive getMetaPrimitive(java.lang.String qualifiedAttributeName)
qualifiedAttributeName
- the qualified attribute name.java.util.Set<java.lang.String> getMicroflowNames()
long getNamedUserCount()
long getNumberConcurrentSessions()
IProfiler getProfiler()
IDataType getReturnType(java.lang.String actionName)
actionName
- the name of a microflow or java action (format "ModuleName.ActionName").int getScheduledActionCount()
java.util.Date getStartupDateTime()
java.util.List<java.lang.String> getSubtypesOf(java.lang.String objectType)
objectType
- the object type.IUser getUser(IContext context, java.lang.String userName) throws CoreException
context
- the context.userName
- the user name to retrieve a user for.CoreException
java.lang.String getXASId()
com.mendix.logging.ILogNode getLogger(java.lang.String name)
ISession initializeGuestSession() throws CoreException
CoreException
- if something goes wrong during the initializing a guest sessionISession initializeSession(IUser user, java.lang.String currentSessionId) throws CoreException
user
- the user for which the session should be initialized.currentSessionId
- id of the current session, will be used to transfer data when current session is associated with a guest user.CoreException
IMendixObject instantiate(IContext context, java.lang.String objectType)
context
- the context.objectType
- type of object to create (e.g. "System.User").java.util.concurrent.Future<IMendixObject> instantiateAsync(IContext context, java.lang.String objectType)
context
- the context.objectType
- type of object to create (e.g. "System.User").boolean isInDevelopment()
boolean isSubClassOf(IMetaObject superObject, IMetaObject type)
superObject
- the super object.type
- the name of the type to check.boolean isSubClassOf(java.lang.String superClass, short typeHash)
superClass
- the name of the super classtypeHash
- the hash of the name of the type to checkboolean isSubClassOf(java.lang.String superClass, java.lang.String type)
superClass
- the name of the super classtype
- the name of the type to checkISession login(java.util.Map<java.lang.String,? extends java.lang.Object> params) throws CoreException
params
- the params.CoreException
ISession login(java.lang.String userName, java.lang.String password) throws CoreException
userName
- the user name.password
- the password.CoreException
ISession login(java.lang.String userName, java.lang.String password, com.mendix.m2ee.api.IMxRuntimeRequest request) throws CoreException
CoreException
ISession login(java.lang.String userName, java.lang.String password, java.lang.String currentSessionId) throws CoreException
userName
- the user name.password
- the password.currentSessionId
- current session UUID.CoreException
void logout(ISession session)
session
- the session to logout.void registerLogSubscriber(com.mendix.logging.LogSubscriber subscriber)
void registerProfiler(IProfiler profiler) throws MendixException
MendixException
boolean removeScheduledFuture(java.util.concurrent.RunnableScheduledFuture<?> scheduledFuture)
scheduledFuture
- the RunnableScheduledFuture to remove.<R> java.util.concurrent.ScheduledFuture<?> reschedule(java.util.concurrent.RunnableScheduledFuture<R> scheduledFuture, CoreAction<R> action, long newDelay, java.util.concurrent.TimeUnit timeUnit)
scheduledFuture
- the scheduledFuture (old action) to remove from the queue.action
- the action to reschedule.newDelay
- the new delay.timeUnit
- time unit of the delay.java.lang.Object resolveTokens(IContext context, java.lang.String text)
text
- the text to resolve.context
- the context.java.util.List<IMendixObject> retrieveByIdWithSchema(IContext context, IMendixIdentifier id, IRetrievalSchema schema)
java.util.List<IMendixObject> retrieveByPath(IContext context, IMendixObject mxObject, java.lang.String path)
context
- the context.mxObject
- the start point of the path.path
- the path (association) to the objects to retrieve.java.util.List<IMendixObject> retrieveByPath(IContext context, IMendixObject mxObject, java.lang.String path, boolean isSelfAssociationChild)
context
- the context.mxObject
- the start point of the path.path
- the path (association) to the objects to retrieve.isSelfAssociationChild
- defines whether the mxObject instance is the child of the path of a self association.java.util.List<IMendixObject> retrieveByPath(IContext context, IMendixObject mxObject, java.lang.String path, java.lang.String entity, boolean isSelfAssociationChild)
context
- the context.mxObject
- the start point of the path.path
- the path (association) to the objects to retrieve.entity
- the specialization entity to limit the results to.isSelfAssociationChild
- defines whether the mxObject instance is the child of the path of a self association.IMendixObject retrieveId(IContext context, IMendixIdentifier id) throws CoreException
context
- the context.id
- id of the object to retrieve.CoreException
java.util.concurrent.Future<IMendixObject> retrieveIdAsync(IContext context, IMendixIdentifier id)
context
- the context.id
- id of the object to retrieve.java.util.List<IMendixObject> retrieveIdList(IContext context, java.util.List<IMendixIdentifier> ids) throws CoreException
context
- the context.ids
- ids of the objects to retrieve.CoreException
java.util.List<IMendixObject> retrieveIdList(IContext context, java.util.List<IMendixIdentifier> ids, int amount, int offset, java.util.Map<java.lang.String,java.lang.String> sort) throws CoreException
context
- the context.ids
- ids of the objects to retrieve.amount
- the maximum number of objects to retrieve from the database.offset
- offset of returned objects when retrieved from the database.sort
- sorting of returned objects when retrieved from the database (e.g. <"Name", "ASC">, <"Age", "DESC">).CoreException
java.util.concurrent.Future<java.util.List<IMendixObject>> retrieveIdListAsync(IContext context, java.util.List<IMendixIdentifier> ids)
context
- the context.ids
- ids of the objects to retrieve.IDataTable retrieveOQLDataTable(IContext context, java.lang.String oqlQuery, int amount, int offset) throws CoreException
context
- context to be used to process this requestoqlQuery
- the OQL query to execute.amount
- maximum number of objects to retrieve.offset
- index of first object to retrieve.CoreException
IDataTable retrieveOQLDataTable(IContext context, IGetRequest request) throws CoreException
context
- context to be used to process this requestrequest
- the request object.CoreException
IDataTable retrieveOQLDataTable(IContext context, java.lang.String oqlQuery) throws CoreException
context
- context to be used to process this requestoqlQuery
- the OQL query to execute.CoreException
java.util.concurrent.Future<IDataTable> retrieveOQLDataTableAsync(IContext context, java.lang.String oqlQuery)
context
- context to be used to process this requestoqlQuery
- the OQL query to execute.java.util.concurrent.Future<IDataTable> retrieveOQLDataTableAsync(IContext context, IGetRequest request)
context
- context to be used to process this requestrequest
- the request object.java.util.concurrent.Future<IDataTable> retrieveOQLDataTableAsync(IContext context, java.lang.String oqlQuery, int amount, int offset)
context
- context to be used to process this requestoqlQuery
- the OQL query to execute.amount
- maximum number of objects to retrieve.offset
- index of first object to retrieve.java.util.List<IMendixObject> retrieveXPathQuery(IContext context, java.lang.String xpathQuery, int amount, int offset, java.util.Map<java.lang.String,java.lang.String> sort) throws CoreException
context
- context to be used to process this requestxpathQuery
- the XPath query to execute.amount
- maximum number of objects to retrieve.offset
- index of first object to retrieve.sort
- sorting of returned objects when retrieved from the database (e.g. <"Name", "ASC">, <"Age", "DESC">).CoreException
java.util.List<IMendixObject> retrieveXPathQuery(IContext context, java.lang.String xpathQuery) throws CoreException
context
- context to be used to process this requestxpathQuery
- the XPath query to execute.CoreException
java.util.List<IMendixObject> retrieveXPathQuery(IContext context, java.lang.String xpathQuery, int amount, int offset, java.util.Map<java.lang.String,java.lang.String> sort, int depth) throws CoreException
context
- context to be used to process this requestxpathQuery
- the XPath query to execute.amount
- maximum number of objects to retrieve.offset
- index of first object to retrieve.sort
- sorting of returned objects when retrieved from the database (e.g. <"Name", "ASC">, <"Age", "DESC">).depth
- indicates the level until which each reference (IMendixIdentifier) is also retrieved as an IMendixObject.CoreException
java.util.List<IMendixObject> retrieveXPathQuery(IContext context, java.lang.String xpathQuery, int amount, int offset, java.util.Map<java.lang.String,java.lang.String> sort, int depth, int timeout) throws CoreException
CoreException
java.lang.Long retrieveXPathQueryAggregate(IContext context, java.lang.String xpathQuery) throws CoreException
context
- context to be used to process this requestxpathQuery
- the aggregate xpath query (e.g. "COUNT(//System.User)").CoreException
java.lang.Double retrieveXPathQueryAggregateDouble(IContext context, java.lang.String xpathQuery) throws CoreException
context
- context to be used to process this requestxpathQuery
- the aggregate xpath query (e.g. "COUNT(//System.User)").CoreException
java.math.BigDecimal retrieveXPathQueryAggregateDecimal(IContext context, java.lang.String xpathQuery)
IDataTable retrieveXPathQueryRaw(IContext context, java.lang.String xpathQuery, int amount, int offset, java.util.Map<java.lang.String,java.lang.String> sort, int depth) throws CoreException
context
- context to be used to process this requestxpathQuery
- the XPath query to execute.amount
- maximum number of objects to retrieve.offset
- index of first object to retrieve.sort
- sorting of returned objects when retrieved from the database (e.g. <"Name", "ASC">, <"Age", "DESC">).depth
- indicates the level until which each reference (IMendixIdentifier) is also retrieved as an IMendixObject.CoreException
@Deprecated java.util.List<IMendixObject> retrieveXPathQueryEscaped(IContext context, java.lang.String xpathFormat, java.lang.String... params) throws CoreException
createXPathQuery(String)
context
- context to be used to process this requestxpathFormat
- the XPath query to execute with %s for each param to escape.params
- a collection of parameters for each %s in xpathFormat.CoreException
@Deprecated java.util.List<IMendixObject> retrieveXPathQueryEscaped(IContext context, java.lang.String xpathFormat, int amount, int offset, java.util.Map<java.lang.String,java.lang.String> sort, int depth, java.lang.String... params) throws CoreException
createXPathQuery(String)
context
- context to be used to process this requestxpathFormat
- the XPath query to execute with %s for each param to escape.amount
- maximum number of objects to retrieve.offset
- index of first object to retrieve.sort
- sorting of returned objects when retrieved from the database (e.g. <"Name", "ASC">, <"Age", "DESC">).depth
- depth of the retrieval (0 is all attributes and association guids, 1 is also all attributes of 1-deep associations
and 2-deep associaton guids etc.).params
- xpath arguments.CoreException
java.lang.Long retrieveXPathQueryAggregateSchema(IContext context, java.lang.String xpathQuery, IRetrievalSchema retrievalSchema) throws CoreException
context
- context to be used to process this requestxpathQuery
- the aggregate xpath query (e.g. "COUNT(//System.User)").retrievalSchema
- the schema.CoreException
java.lang.Long retrieveXPathQueryAggregateSchema(IContext context, java.lang.String xpathQuery, IRetrievalSchema retrievalSchema, boolean disableSecurity) throws CoreException
context
- context to be used to process this requestxpathQuery
- the aggregate xpath query (e.g. "COUNT(//System.User)").retrievalSchema
- the schema.disableSecurity
- whether security should be applied for this retrieval.CoreException
java.util.concurrent.Future<java.lang.Double> retrieveXPathQueryAggregateAsyncDouble(IContext context, java.lang.String xpathQuery)
context
- context to be used to process this requestxpathQuery
- the aggregate XPath query (e.g. "COUNT(//System.User)")java.util.concurrent.Future<java.lang.Long> retrieveXPathQueryAggregateAsync(IContext context, java.lang.String xpathQuery)
context
- context to be used to process this requestxpathQuery
- the aggregate xpath query (e.g. "COUNT(//System.User)").java.util.concurrent.Future<java.util.List<IMendixObject>> retrieveXPathQueryAsync(IContext context, java.lang.String xpathQuery, int amount, int offset, java.util.Map<java.lang.String,java.lang.String> sort, int depth)
context
- the context.xpathQuery
- the XPath query to execute.amount
- maximum number of objects to retrieve.offset
- index of first object to retrieve.sort
- sorting of returned objects when retrieved from the database (e.g. <"Name", "ASC">, <"Age", "DESC">).depth
- indicates the level until which each reference (IMendixIdentifier) is also retrieved as an IMendixObject.java.util.List<IMendixObject> retrieveXPathSchema(IContext context, java.lang.String xpathQuery, IRetrievalSchema retrievalSchema, boolean shouldRetrieveCount, boolean disableSecurity) throws CoreException
context
- the context.xpathQuery
- the XPath query to execute.retrievalSchema
- the schema to apply.shouldRetrieveCount
- indicates whether the total number object corresponding to the given schema should be included in the
result.disableSecurity
- indicates whether security should be applied when this query is being executed.CoreException
@Deprecated java.util.List<IMendixObject> retrieveXPathSchemaEscaped(IContext context, java.lang.String xpathFormat, IRetrievalSchema retrievalSchema, boolean shouldRetrieveCount, boolean disableSecurity, java.lang.String... params) throws CoreException
createXPathQuery(String)
context
- the context.xpathFormat
- the XPath query to execute with %s for each param to escape.retrievalSchema
- the schema to apply.shouldRetrieveCount
- indicates whether the total number object corresponding to the given schema should be included in the
result.disableSecurity
- indicates whether security should be disabled when executing this query.params
- a collection of parameters for each %s in xpathFormat.CoreException
IDataTable retrieveXPathSchemaRaw(IContext context, java.lang.String xpathQuery, boolean shouldRetrieveCount, IRetrievalSchema retrievalSchema) throws CoreException
context
- the context.xpathQuery
- the XPath query to execute.shouldRetrieveCount
- indicates whether the total number object corresponding to the given schema should be included in the
result.retrievalSchema
- the schema to apply.CoreException
IMendixObject rollback(IContext context, IMendixObject object) throws CoreException
context
- the context.object
- the object to rollback.CoreException
java.util.concurrent.Future<IMendixObject> rollbackAsync(IContext context, IMendixObject object)
context
- the context.object
- the object to rollback.<R> java.util.concurrent.RunnableScheduledFuture<?> schedule(java.lang.String actionName, java.util.Date date) throws CoreException
actionName
- the name of a microflow or java action (format "ModuleName.ActionName")date
- the date and time on which the action should be executedCoreException
<R> java.util.concurrent.RunnableScheduledFuture<?> schedule(CoreAction<R> action, long delay, java.util.concurrent.TimeUnit timeUnit)
action
- the action to execute.delay
- the delay after which the action should be executed.timeUnit
- time unit in which the delay is specified.<R> void scheduleAtFixedRate(CoreAction<R> action, java.util.Date firstRun, long period, java.util.concurrent.TimeUnit timeUnit)
action
- the action to executefirstRun
- the Date/time on which the action will be executed the first timeperiod
- the period between each start of the execution of the actiontimeUnit
- the timeUnit in which the period is specified<R> void scheduleAtFixedRate(CoreAction<R> action, long initialDelay, long period, java.util.concurrent.TimeUnit timeUnit)
action
- the action to execute.initialDelay
- the delay after which the action will be executed the first time.period
- the period between each start of the execution of the action.timeUnit
- the timeUnit in which the initialDelay and the period is specified.<R> void scheduleAtFixedRate(java.lang.String actionName, java.util.Date firstRun, long period, java.util.concurrent.TimeUnit timeUnit, java.lang.String name, java.lang.String description)
actionName
- the name of a microflow or java action (format "ModuleName.ActionName").firstRun
- the date on which the action will be executed the first time.period
- the period between each start of the execution of the action.timeUnit
- the timeUnit in which the initialDelay and the period is specified.name
- the name of the scheduled event.description
- the description of the scheduled event.<R> void scheduleWithFixedDelay(CoreAction<R> action, long initialDelay, long delay, java.util.concurrent.TimeUnit timeUnit)
action
- the action to execute.initialDelay
- the delay after which the action will be executed the first time.delay
- the delay between the end of the execution of the action and the start of the next time the action will be
executed.timeUnit
- the timeUnit in which the initialDelay and the delay is specified.void storeFileDocumentContent(IContext context, IMendixObject fileDocument, java.io.InputStream inputStream)
context
- the context.fileDocument
- the file document to which the file to store is linked to.inputStream
- the content of the filevoid storeFileDocumentContent(IContext context, IMendixObject fileDocument, java.lang.String fileName, java.io.InputStream inputStream)
context
- the context.fileDocument
- the file document to which the file to store is linked to.fileName
- the original name of the file (will be stored in the Name attribute)inputStream
- the content of the filevoid storeImageDocumentContent(IContext context, IMendixObject imageDocument, java.io.InputStream inputStream, int thumbnailWidth, int thumbnailHeight)
context
- the context.imageDocument
- the image document to which the image to store is linked to.inputStream
- the content of the filethumbnailWidth
- the width of the thumbnail to create for this image.thumbnailHeight
- the width of the thumbnail to create for this image.void unregisterProfiler()
void addRequestHandler(java.lang.String path, RequestHandler requestHandler)
path
- the path for which request should be processed.requestHandler
- the custom request handler.java.util.UUID getProjectId()
java.lang.String getModelVersion()