Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
R
- raw(String) - Method in interface ch.ivyteam.ivy.business.data.store.search.Query
-
Search for business data values using a raw Elasticsearch search query.
- read() - Method in interface ch.ivyteam.ivy.cm.ContentObjectValue
-
Returns the accessory to read the content.
- read() - Method in class ch.ivyteam.ivy.scripting.objects.File
-
Reads the file content and returns it as a String; the default encoding is used.
- read() - Method in interface ch.ivyteam.ivy.workflow.document.IDocument
-
Provides methods to read the content of the document.
- read(String) - Method in class ch.ivyteam.ivy.rest.client.FeatureConfig
- read(String) - Method in class ch.ivyteam.ivy.scripting.objects.File
-
Reads the file content and returns it as a String.
- readBinary() - Method in class ch.ivyteam.ivy.scripting.objects.File
-
Reads the file content and returns it as a Binary.
- reader() - Method in interface ch.ivyteam.ivy.cm.ContentObjectReader
-
Returns the content as character stream (UTF-8).
- reader(Reader) - Method in interface ch.ivyteam.ivy.cm.ContentObjectWriter
-
Sets the content.
- readMandatory(String) - Method in class ch.ivyteam.ivy.rest.client.FeatureConfig
- readOnlyTuple() - Method in class ch.ivyteam.ivy.scripting.objects.Tuple
-
Creates a read-only version of the given tuple.
- READY_FOR_JOIN - Enum constant in enum class ch.ivyteam.ivy.workflow.TaskState
-
If a task reaches a task switch process element it changes its state from
TaskState.RESUMED
orTaskState.CREATED
to this state. - receivers() - Method in interface ch.ivyteam.ivy.workflow.signal.IBpmSignalService
-
Query information about signal receivers, Signal Start- or Signal Boundary-Events.
- Record - Class in ch.ivyteam.ivy.scripting.objects
-
Records are rows in DB tables.
- Record() - Constructor for class ch.ivyteam.ivy.scripting.objects.Record
-
Creates an empty uninitialized record.
- Record(String[], Object[]) - Constructor for class ch.ivyteam.ivy.scripting.objects.Record
-
Creates a new Record with given initial values.
- Record(List<String>, List<? extends Object>) - Constructor for class ch.ivyteam.ivy.scripting.objects.Record
-
Creates a new Record with given initial values.
- recordset() - Method in interface ch.ivyteam.ivy.persistence.query.IFluentQueryExecutor
-
Gets a
Recordset
with all records that matches the givenquery
. - recordset(int, int) - Method in interface ch.ivyteam.ivy.persistence.query.IFluentQueryExecutor
-
Gets a
Recordset
with the records that matches the givenquery
. - Recordset - Class in ch.ivyteam.ivy.scripting.objects
-
A Recordset is a data structure corresponding to a table from a a database.
- Recordset() - Constructor for class ch.ivyteam.ivy.scripting.objects.Recordset
-
Creates a new uninitialized recordset.
- Recordset(String[]) - Constructor for class ch.ivyteam.ivy.scripting.objects.Recordset
-
Creates a new empty Recordset with given columns.
- Recordset(List<String>) - Constructor for class ch.ivyteam.ivy.scripting.objects.Recordset
-
Creates a new empty Recordset with given columns.
- redirectLocation() - Method in class ch.ivyteam.ivy.bpm.engine.client.HttpResponse
-
Returns the redirect location of this http process execution.
- ref(String) - Method in interface ch.ivyteam.ivy.cm.exec.ContentManagement
-
Returns the reference of the content object with the given uri as string.
- ref(String) - Method in interface ch.ivyteam.ivy.htmldialog.IHtmlDialogContext
-
Returns the url to the specified process link.
- reference(String) - Method in interface ch.ivyteam.ivy.cm.exec.ContentManagement
-
Creates a reference resolver.
- ReferenceResolver - Interface in ch.ivyteam.ivy.cm.exec
-
Reference resolver
- refresh(T) - Method in interface ch.ivyteam.ivy.process.data.persistence.IIvyEntityManager
-
Refresh the state of the instance from the database, overwriting changes made to the entity, if any.
- RelationalOperator - Enum Class in ch.ivyteam.logicalexpression
-
Relational operators
- relativize(Path) - Method in class ch.ivyteam.ivy.workflow.document.Path
-
Example:
Path relativePath = new Path("documents/sales/January/axonivy.docx").relativize(new Path("documents/sales"))
Boolean isTrue = relativePath.equals(new Path("January/axonivy.docx")); - release() - Method in interface ch.ivyteam.ivy.application.IProcessModelVersion
-
Sets the release state of this process model version to released.
- release() - Method in class ch.ivyteam.ivy.process.extension.impl.AbstractProcessExtension
- release() - Method in interface ch.ivyteam.ivy.process.extension.IProcessExtension
-
This method is called before this process extension is thrown away by the process engine.
- release(Date) - Method in interface ch.ivyteam.ivy.application.IProcessModelVersion
-
Sets the release state of this process model version at the specified date and time to RELEASED.
- RELEASED - Enum constant in enum class ch.ivyteam.ivy.application.ReleaseState
-
Process Model Version Release State RELEASED.
- ReleaseState - Enum Class in ch.ivyteam.ivy.application
-
The release state of a Process Model Version
- reload(T) - Method in interface ch.ivyteam.ivy.business.data.store.BusinessDataRepository
-
Reloads the given business data value from the repository.
- remove(int) - Method in class ch.ivyteam.ivy.scripting.objects.List
- remove(List<Object>) - Method in class ch.ivyteam.ivy.scripting.objects.Recordset
-
Removes a Record, given as a List of values, from this Recordset.
- remove(Record) - Method in class ch.ivyteam.ivy.scripting.objects.Recordset
-
Removes a Record from this Recordset.
- remove(Tree) - Method in class ch.ivyteam.ivy.scripting.objects.Tree
-
Removes
aChild
from this node's child array, giving it a null parent. - remove(Object) - Method in class ch.ivyteam.ivy.scripting.objects.List
- remove(String) - Method in class ch.ivyteam.ivy.scripting.objects.Xml
-
Removes specified elements.
- remove(T) - Method in interface ch.ivyteam.ivy.process.data.persistence.IIvyEntityManager
-
Remove the given entity instance from the database
- removeAll(Collection<?>) - Method in class ch.ivyteam.ivy.scripting.objects.List
- removeAllChildren() - Method in class ch.ivyteam.ivy.scripting.objects.Tree
-
Removes all of this node's children, setting their parents to null.
- removeAt(int) - Method in class ch.ivyteam.ivy.scripting.objects.Recordset
-
Removes a Record from this Recordset.
- removeAttribute(String) - Method in interface ch.ivyteam.util.IAttributeStore
-
Removes a store attribute.
- removeChildAt(int) - Method in class ch.ivyteam.ivy.scripting.objects.Tree
-
Removes a child with given index.
- removeFromParent() - Method in class ch.ivyteam.ivy.scripting.objects.Tree
-
Removes the subtree rooted at this node from the tree, giving this node a null parent.
- removeProperty(String) - Method in interface ch.ivyteam.ivy.security.IRole
-
Removes a property from the role
- removeProperty(String) - Method in interface ch.ivyteam.ivy.security.IUser
-
Removes a property from the user
- removeRole(IRole) - Method in interface ch.ivyteam.ivy.security.IUser
-
Remove a role the user can act as
- removeRoleMember(IRole) - Method in interface ch.ivyteam.ivy.security.IRole
-
Removes the given member role from this role.
- removeServerListener(IServerListener) - Method in interface ch.ivyteam.ivy.server.IServer
-
Removes a listener
- removeSystemEventListener(EnumSet<SystemEventCategory>, ISystemEventListener) - Method in interface ch.ivyteam.ivy.event.ISystemEventDispatcher
-
Removes the given event listener from the given categories.
- rename(String, boolean) - Method in class ch.ivyteam.ivy.scripting.objects.File
-
Renames a file in the same directory.
- replace(String, String) - Method in interface ch.ivyteam.ivy.cm.exec.ContentResolver
-
Template ${name} will be replaced with the given value.
- repo - Variable in class ch.ivyteam.ivy.environment.Ivy
-
Provides access to the
BusinessDataRepository
. - repo() - Static method in class ch.ivyteam.ivy.environment.Ivy
-
Provides access to the
BusinessDataRepository
. - request - Variable in class ch.ivyteam.ivy.environment.Ivy
-
The currently executed process
request
. - request() - Static method in class ch.ivyteam.ivy.environment.Ivy
-
Returns the currently executed process
request
. - REQUEST - Enum constant in enum class ch.ivyteam.ivy.application.RuntimeLogCategory
-
Runtime log category to log request relevant things
- REQUEST_PATH - Enum constant in enum class ch.ivyteam.ivy.workflow.TaskProperty
-
The request path property
- RequestBuilder - Class in ch.ivyteam.ivy.bpm.engine.client
-
Setups and executes
requests
to run against theIBpmEngine
. - RequestException - Exception in ch.ivyteam.ivy.request
-
The base class for all request exceptions
- requestPath() - Method in class ch.ivyteam.ivy.workflow.query.TaskQuery.FilterQuery
- requestPath() - Method in class ch.ivyteam.ivy.workflow.query.TaskQuery.GroupByQuery
- requestPath() - Method in interface ch.ivyteam.ivy.workflow.query.TaskQuery.IFilterableColumns
-
Prepares a where statement for the column
RequestPath
.
Must be followed by a call to a condition method. - requestPath() - Method in interface ch.ivyteam.ivy.workflow.query.TaskQuery.IGroupByQueryColumns
-
Groups the result of the query by the field
RequestPath
. - requestPath() - Method in interface ch.ivyteam.ivy.workflow.query.TaskQuery.IOrderByQueryColumns
-
Adds an order by statement for the column
RequestPath
in the default direction ascending.
To change the order to descending userequestPath().descending()
- requestPath() - Method in class ch.ivyteam.ivy.workflow.query.TaskQuery.OrderByQuery
- requestToken(OAuth2TokenRequester.AuthContext) - Method in interface ch.ivyteam.ivy.rest.client.oauth2.OAuth2TokenRequester
-
Requests a OAuth2 bearer access token
- requireType(Class<?>) - Method in class ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder.ScriptBuilder
-
Defines a type, that must be evaluated by the editors script-expression or attribute (e.g.
- requireType(Function<IIvyScriptClassRepository, IIvyClass<?>>) - Method in class ch.ivyteam.ivy.process.extension.ui.ExtensionUiBuilder.ScriptBuilder
-
Defines a type, that must be evaluated by the editors script-expression or attribute (e.g.
- reset() - Method in interface ch.ivyteam.ivy.workflow.ITask
-
Resets this task to the task start.
- reset(String) - Method in interface ch.ivyteam.ivy.vars.Variables
-
Resets the value of a variable for the active environment back to the default value.
- resetLoopDetection() - Static method in class ch.ivyteam.ivy.bpm.error.BpmErrorHandler
-
Resets the counter of error being thrown in the current request.
- resetTask(ITask) - Method in interface ch.ivyteam.ivy.workflow.IWorkflowSession
-
Resets a task the workflow session user is working on.
- resolve(Locale) - Method in interface ch.ivyteam.ivy.cm.exec.ContentObjectValueResolver
-
Determines the best match with the given locale.
- response - Variable in class ch.ivyteam.ivy.environment.Ivy
-
The
response
for the currently executed request. - response() - Method in class ch.ivyteam.ivy.bpm.engine.client.HttpResponse
-
Provides access to the
http response
of this process execution. - response() - Static method in class ch.ivyteam.ivy.environment.Ivy
-
Returns the
response
for the currently executed request. - ResponseFactory - Class in ch.ivyteam.ivy.request
-
Factory that create responses
- rest - Variable in class ch.ivyteam.ivy.environment.Ivy
-
Access to
rest clients
. - rest() - Static method in class ch.ivyteam.ivy.environment.Ivy
-
Access to
rest clients
. - REST_CLIENT - Enum constant in enum class ch.ivyteam.ivy.application.RuntimeLogCategory
-
Runtime log category to log rest client relevant things
- REST_CLIENT_CONIFG_ID - Static variable in class ch.ivyteam.ivy.bpm.error.BpmError.AttributeNames
-
Available on errors with error codes:
ivy:error:rest:client
- REST_CLIENT_NAME - Static variable in class ch.ivyteam.ivy.bpm.error.BpmError.AttributeNames
-
Available on errors with error codes:
ivy:error:rest:client
- REST_CLIENT_REQUEST_METHOD - Static variable in class ch.ivyteam.ivy.bpm.error.BpmError.AttributeNames
-
Available on errors with error codes:
ivy:error:rest:client
- REST_CLIENT_RESPONSE_STATUS_CODE - Static variable in class ch.ivyteam.ivy.bpm.error.BpmError.AttributeNames
-
Available on errors with error codes:
ivy:error:rest:client
- Result<T> - Interface in ch.ivyteam.ivy.business.data.store.search
-
Search query result.
- results() - Method in interface ch.ivyteam.ivy.persistence.query.IFluentQueryExecutor
-
Gets all business objects that matches the given
query
. - results(int, int) - Method in interface ch.ivyteam.ivy.persistence.query.IFluentQueryExecutor
-
Gets all business objects that matches the given
query
. - resultsPaged() - Method in interface ch.ivyteam.ivy.persistence.query.IFluentQueryExecutor
-
Gets the results page wise.
- resultsPaged(int) - Method in interface ch.ivyteam.ivy.persistence.query.IFluentQueryExecutor
-
Gets the results page wise.
- RESUMED - Enum constant in enum class ch.ivyteam.ivy.workflow.TaskState
-
A user is working on this task right now (see
IWorkflowSession.resumeTask(long)
). - resumeTask(long) - Method in interface ch.ivyteam.ivy.workflow.IWorkflowSession
-
Resumes a suspended or parked task with its identifier.
- retainAll(Collection<?>) - Method in class ch.ivyteam.ivy.scripting.objects.List
- role(IRole) - Method in class ch.ivyteam.ivy.bpm.engine.client.SessionChooser
-
Execute the request as the given role
- role(IRole) - Method in class ch.ivyteam.ivy.bpm.engine.client.sub.SubSessionChooser
-
Execute the request as the given role
- role(IRole) - Method in interface ch.ivyteam.ivy.security.IRoleMatcher
-
Tests if the user of this user token currently owns the given role.
- role(String) - Method in class ch.ivyteam.ivy.bpm.engine.client.SessionChooser
-
Execute the request as role with the given role name
- role(String) - Method in class ch.ivyteam.ivy.bpm.engine.client.sub.SubSessionChooser
-
Execute the request as role with the given role name
- role(String) - Method in interface ch.ivyteam.ivy.security.IRoleMatcher
-
Tests if the user of this user token currently owns the role with the given name.
- ROLE_CREATE - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleCreate
- ROLE_DELETE - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleDelete
- ROLE_MOVE - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleMove
- ROLE_PROPERTY_READ - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RolePropertyRead
- ROLE_PROPERTY_WRITE - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RolePropertyWrite
- ROLE_READ_ALL - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleReadAll
- ROLE_READ_DISPLAY_DESCRIPTION - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleReadDisplayDescription
- ROLE_READ_DISPLAY_DESCRIPTION_TEMPLATE - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleReadDisplayDescriptionTemplate
- ROLE_READ_DISPLAY_NAME - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleReadDisplayName
- ROLE_READ_DISPLAY_NAME_TEMPLATE - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleReadDisplayNameTemplate
- ROLE_READ_EXTERNAL_SECURITY_NAME - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleReadExternalSecurityName
- ROLE_READ_NAME - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleReadName
- ROLE_READ_USERS - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleReadUsers
- ROLE_SET_DISPLAY_DESCRIPTION - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleSetDisplayDescription
- ROLE_SET_DISPLAY_NAME - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleSetDisplayName
- ROLE_SET_EXTERNAL_SECURITY_NAME - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleSetExternalSecurityName
- ROLE_TREE_NAVIGATION - Static variable in interface ch.ivyteam.ivy.security.IPermission
-
Permission RoleTreeNavigation
- roleCanWorkOn(IRole) - Method in class ch.ivyteam.ivy.workflow.query.CaseQuery.FilterQuery
- roleCanWorkOn(IRole) - Method in interface ch.ivyteam.ivy.workflow.query.CaseQuery.IFilterableColumns
-
Filters all cases where the role can work on at least one task.
- RoleIdentity - Record Class in ch.ivyteam.ivy.security.identity.spi
- roleIsInvolved(IRole) - Method in class ch.ivyteam.ivy.workflow.query.CaseQuery.FilterQuery
- roleIsInvolved(IRole) - Method in interface ch.ivyteam.ivy.workflow.query.CaseQuery.IFilterableColumns
-
Filters all cases the role is involved in.
- roleIsInvolved(IRole) - Method in class ch.ivyteam.ivy.workflow.query.TaskQuery.FilterQuery
- roleIsInvolved(IRole) - Method in interface ch.ivyteam.ivy.workflow.query.TaskQuery.IFilterableColumns
-
Filters all tasks the role is involved in.
- roleIsInvolved(String, String) - Method in class ch.ivyteam.ivy.workflow.query.CaseQuery.FilterQuery
- roleIsInvolved(String, String) - Method in interface ch.ivyteam.ivy.workflow.query.CaseQuery.IFilterableColumns
-
Filters all cases where the role with given name in the given application is involved in.
- roleIsInvolved(String, String) - Method in class ch.ivyteam.ivy.workflow.query.TaskQuery.FilterQuery
- roleIsInvolved(String, String) - Method in interface ch.ivyteam.ivy.workflow.query.TaskQuery.IFilterableColumns
-
Filters all tasks where the role with given name in the given application is involved in.
- roles() - Method in interface ch.ivyteam.ivy.security.ISecurity
-
Gets the role repository of this security context.
- roles() - Method in interface ch.ivyteam.ivy.security.ISecurityContext
-
Gets the role repository of this security context.
- roles(IRole...) - Method in interface ch.ivyteam.ivy.security.IRoleMatcher
-
Tests if the user of this user token currently owns all the given roles.
- roles(String...) - Method in interface ch.ivyteam.ivy.security.IRoleMatcher
-
Tests if the user of this user token currently owns the roles with the given names.
- roles(Collection<IRole>) - Method in interface ch.ivyteam.ivy.security.IRoleMatcher
-
Tests if the user of this user token currently owns all the given roles.
- rolesWithNames(Collection<String>) - Method in interface ch.ivyteam.ivy.security.IRoleMatcher
-
Tests if the user of this user token currently owns all the roles given with their names.
- root() - Method in interface ch.ivyteam.ivy.cm.ContentManagementSystem
-
Gets the root content object of this content management system.
- Rules - Class in ch.ivyteam.ivy.rule.engine.api
-
This class provides the Java API to access all the features of the Rule engine.
- run(Runnable) - Static method in class ch.ivyteam.ivy.security.exec.Sudo
- run(Runnable) - Method in class ch.ivyteam.util.threadcontext.IvyAsyncRunner
- run(Callable<T>) - Method in class ch.ivyteam.util.threadcontext.IvyAsyncRunner
- RUNNING - Enum constant in enum class ch.ivyteam.ivy.workflow.CaseState
-
Running means the Case is in progress.
- RuntimeLogCategory - Enum Class in ch.ivyteam.ivy.application
-
Category of the runtime log
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form