- ready() - Method in interface org.pentaho.platform.api.engine.IPlatformReadyListener
 
- 
Called after the platform has been booted and is ready to receive requests.
 
- REF_MISSING - Static variable in class org.pentaho.platform.api.repository2.unified.data.node.DataNodeRef
 
-  
 
- refresh() - Method in interface org.pentaho.platform.api.ui.IThemeManager
 
- 
Force the Theme Manager to recalculate system and module themes
 
- register(ILastModifiedCacheItem) - Method in interface org.pentaho.platform.api.cache.ICacheExpirationRegistry
 
- 
Adds an item to the registry
 
- registerConfiguration(IConfiguration) - Method in interface org.pentaho.platform.api.engine.ISystemConfig
 
-  
 
- registerHostnameVerifier() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemHelper
 
-  
 
- registerObject(T) - Method in interface org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory
 
- 
Register an Object instance with the ObjectFactory.
 
- registerObject(T, IPentahoRegistrableObjectFactory.Types) - Method in interface org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory
 
- 
Register an Object instance with the ObjectFactory for the given types
 
- registerObject(T, Class<?>...) - Method in interface org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory
 
- 
Register an Object instance with the ObjectFactory for the given classes
 
- registerReference(IPentahoObjectReference<T>) - Method in interface org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory
 
- 
Register an IPentahoObjectReference with the factory under Types.ALL
 
- registerReference(IPentahoObjectReference<T>, IPentahoRegistrableObjectFactory.Types) - Method in interface org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory
 
- 
Register an IPentahoObjectReference with the factory for the given Types.
 
- registerReference(IPentahoObjectReference<T>, Class<?>...) - Method in interface org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory
 
- 
Register an IPentahoObjectReference with the factory for the given Types.
 
- registerService(IServiceConfig) - Method in interface org.pentaho.platform.api.engine.IServiceManager
 
- 
Registers a service with the service manager.
 
- registerVoter(IRepositoryAccessVoter) - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryAccessVoterManager
 
- 
Register a new repository access voter to the platform
 
- reload() - Method in interface org.pentaho.platform.api.engine.IPluginManager
 
- 
Causes the plug-in manager object to re-register all of the plug-ins that it knows about.
 
- reload(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPluginManager
 
- 
 
- remove() - Method in interface org.pentaho.platform.api.engine.IPentahoObjectRegistration
 
-  
 
- remove(ILogoutListener) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemListeners
 
-  
 
- REMOVE_ABANDONED - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
-  
 
- REMOVE_ABANDONED_TIMEOUT - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
-  
 
- removeAclFor(RepositoryFile) - Method in interface org.pentaho.platform.api.repository2.unified.IAclNodeHelper
 
- 
Deletes the ACL node associated with the repositoryFile if it exists.
 
- removeAttribute(String) - Method in interface org.pentaho.platform.api.engine.IPentahoSession
 
- 
Removes an attribute from the session and returns it.
 
- removeBackgroundExecutedContentForID(String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IBackgroundExecution
 
- 
Removes the content generated by background execution
 
- removeChildFile(IRepositoryFile) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
-  
 
- removeEntryPointHandler(IPentahoSystemEntryPoint) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
 
- 
Removes an entry point handler.
 
- removeExitPointHandler(IPentahoSystemExitPoint) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
 
- 
Removes an exit point handler.
 
- removeFromGlobalAttributesMap(Object) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemStartupActions
 
-  
 
- removeFromGlobalCache(Object) - Method in interface org.pentaho.platform.api.engine.ICacheManager
 
- 
Removes an object from the cache
 
- removeFromRegionCache(String, Object) - Method in interface org.pentaho.platform.api.engine.ICacheManager
 
- 
Removes an object from the cache within a specific region
 
- removeFromSessionCache(IPentahoSession, String) - Method in interface org.pentaho.platform.api.engine.ICacheManager
 
- 
Removes a data item from the user session specific cache
 
- removePluginPerspective(IPluginPerspective) - Method in interface org.pentaho.platform.api.engine.perspective.IPluginPerspectiveManager
 
- 
Deprecated.
No longer needed as IPluginPerspective objects are registered with PentahoSystem. Existing calls will
 do nothing. Replace calls to this method with .IPentahoObjectRegistration#remove()
 
   IPentahoObjectRegistration handle = PentahoSystem.registerObject( pluginPerspective );
   handle.remove(); // replaces call to removePluginPerspective
 
 
 
 
- removeRegionCache(String) - Method in interface org.pentaho.platform.api.engine.ICacheManager
 
- 
Clears any data for the specified for a specific region(For example region could be session, global etc) and
 removed the region from the map
 
- removeRequestContext() - Method in interface org.pentaho.platform.api.engine.IPentahoRequestContextHolderStrategy
 
- 
Clears the current request context.
 
- RepositoryException - Exception in org.pentaho.platform.api.repository
 
-  
 
- RepositoryException() - Constructor for exception org.pentaho.platform.api.repository.RepositoryException
 
-  
 
- RepositoryException(String) - Constructor for exception org.pentaho.platform.api.repository.RepositoryException
 
-  
 
- RepositoryException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository.RepositoryException
 
-  
 
- RepositoryException(Throwable) - Constructor for exception org.pentaho.platform.api.repository.RepositoryException
 
-  
 
- RepositoryFile - Class in org.pentaho.platform.api.repository2.unified
 
- 
Immutable repository file.
 
- RepositoryFile(Serializable, String, boolean, boolean, boolean, Serializable, String, Date, Date, boolean, String, String, Date, String, String, String, String, Date, long, String, Map<String, Properties>, boolean) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
-  
 
- RepositoryFile(Serializable, String, boolean, boolean, boolean, Serializable, String, Date, Date, boolean, String, String, Date, String, String, String, String, Date, long, String, Map<String, Properties>) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
-  
 
- RepositoryFile.Builder - Class in org.pentaho.platform.api.repository2.unified
 
-  
 
- RepositoryFile.Builder(String) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
-  
 
- RepositoryFile.Builder(Serializable, String) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
-  
 
- RepositoryFile.Builder(RepositoryFile) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
-  
 
- RepositoryFileAce - Class in org.pentaho.platform.api.repository2.unified
 
- 
Immutable access control entry (ACE).
 
- RepositoryFileAce(RepositoryFileSid, RepositoryFilePermission, RepositoryFilePermission...) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAce
 
-  
 
- RepositoryFileAce(RepositoryFileSid, EnumSet<RepositoryFilePermission>) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAce
 
-  
 
- RepositoryFileAcl - Class in org.pentaho.platform.api.repository2.unified
 
- 
Immutable access control list (ACL).
 
- RepositoryFileAcl(Serializable, RepositoryFileSid, boolean, List<RepositoryFileAce>) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl
 
-  
 
- RepositoryFileAcl.Builder - Class in org.pentaho.platform.api.repository2.unified
 
-  
 
- RepositoryFileAcl.Builder(String) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
- 
Creates a Builder where the owner is a RepositoryFileSid.Type.USER.
 
- RepositoryFileAcl.Builder(RepositoryFileSid) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
-  
 
- RepositoryFileAcl.Builder(Serializable, RepositoryFileSid) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
-  
 
- RepositoryFileAcl.Builder(String, RepositoryFileSid.Type) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
-  
 
- RepositoryFileAcl.Builder(Serializable, String, RepositoryFileSid.Type) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
-  
 
- RepositoryFileAcl.Builder(RepositoryFileAcl) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
-  
 
- RepositoryFilePermission - Enum in org.pentaho.platform.api.repository2.unified
 
- 
Repository file permission enumeration.
 
- RepositoryFileSid - Class in org.pentaho.platform.api.repository2.unified
 
- 
Repository file security identifier (SID) used as file owners and permission recipients in access control
 entries.
 
- RepositoryFileSid(String) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileSid
 
- 
 
- RepositoryFileSid(String, RepositoryFileSid.Type) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileSid
 
-  
 
- RepositoryFileSid.Type - Enum in org.pentaho.platform.api.repository2.unified
 
-  
 
- RepositoryFileTree - Class in org.pentaho.platform.api.repository2.unified
 
- 
A struct for a 
RepositoryFile and its immediate children.* The immediate children is a list of this type
 (which can have children and so on).
 
 
- RepositoryFileTree(RepositoryFile, List<RepositoryFileTree>) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
-  
 
- RepositoryFileTree.Builder - Class in org.pentaho.platform.api.repository2.unified
 
-  
 
- RepositoryFileTree.Builder(RepositoryFile, List<RepositoryFileTree.Builder>) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
 
-  
 
- RepositoryFileTree.Builder(RepositoryFile) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
 
- 
Creates a builder with an empty list as children.
 
- RepositoryFileTree.Builder(RepositoryFileTree) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
 
-  
 
- RepositoryLifecycleManagerException - Exception in org.pentaho.platform.api.repository2.unified
 
- 
 
- RepositoryLifecycleManagerException() - Constructor for exception org.pentaho.platform.api.repository2.unified.RepositoryLifecycleManagerException
 
-  
 
- RepositoryLifecycleManagerException(String) - Constructor for exception org.pentaho.platform.api.repository2.unified.RepositoryLifecycleManagerException
 
-  
 
- RepositoryLifecycleManagerException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.RepositoryLifecycleManagerException
 
-  
 
- RepositoryLifecycleManagerException(Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.RepositoryLifecycleManagerException
 
-  
 
- RepositoryRequest - Class in org.pentaho.platform.api.repository2.unified
 
-  
 
- RepositoryRequest() - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
- 
This class encapsulates the parameters received by the "children" and "tree" REST calls.
 
- RepositoryRequest(String, Boolean, Integer, String) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
-  
 
- RepositoryRequest.FILES_TYPE_FILTER - Enum in org.pentaho.platform.api.repository2.unified
 
-  
 
- resetAccessControls(List<IPentahoAclEntry>) - Method in interface org.pentaho.platform.api.engine.IAclHolder
 
- 
Replaces existing access controls with a new list of access controls.
 
- resetAccessControls(List) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
-  
 
- resetBackgroundExecutionAlert() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
 
- 
Toggles off the background execution alert status.
 
- resetParameters() - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
-  
 
- resetSettingsCache() - Method in interface org.pentaho.platform.api.engine.ISystemSettings
 
- 
The SystemSettings object caches each settings document once it's read in.
 
- resolveParameter(String, String, Matcher, int, StringBuffer) - Method in interface org.pentaho.platform.api.engine.IParameterResolver
 
- 
Provides a way for components to inject their own replacements of parameter markers in the provided template.
 
- RESPONSE - Static variable in interface org.pentaho.platform.api.engine.IOutputHandler
 
-  
 
- restoreFileAtVersion(Serializable, Serializable, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
- 
Makes a file, as it was at the given version, the latest version.
 
- RESULT_TYPE_NONE - Static variable in interface org.pentaho.platform.api.engine.ISequenceDefinition
 
- 
result-type value indicating the action should be not be displayed to users during navigation
 
- RESULT_TYPE_PROCESS - Static variable in interface org.pentaho.platform.api.engine.ISequenceDefinition
 
- 
result-type value indicating the action should be be displayed as a process to users during navigation
 
- RESULT_TYPE_REPORT - Static variable in interface org.pentaho.platform.api.engine.ISequenceDefinition
 
- 
result-type value indicating the action should be be displayed as a report to users during navigation
 
- RESULT_TYPE_RULE - Static variable in interface org.pentaho.platform.api.engine.ISequenceDefinition
 
- 
result-type value indicating the action should be be displayed as a business rule to users during navigation
 
- retrieveParent() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
- 
NOTE: This method is named 'retrieveParent' instead of 'getParent' because the generic ISolutionFile type is
 not a 'Hibernate' described type and one of the base classes (RepositoryFile) will fail dependency checking.
 
- retrieveParent() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
-  
 
- ROOT_LOCALE - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
-  
 
- runAsAnonymous(Callable<T>) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
 
- 
Utility method that allows you to run a block of code as the given user.
 
- runAsSystem(Callable<T>) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
 
- 
Runs code as system with full privileges.
 
- runAsUser(String, Callable<T>) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
 
- 
Utility method that allows you to run a block of code as the given user.
 
- runAsUser(String, IParameterProvider, Callable<T>) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
 
-  
 
- RUNTIME_CONTEXT_RESOLVE_FAIL - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
Indicates that parameters for an action could not be resolved.
 
- RUNTIME_CONTEXT_RESOLVE_OK - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
Indicates that the parameters for an action were able to be resolved.
 
- RUNTIME_CONTEXT_VALIDATE_FAIL - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
Indicator of action validation failure
 
- RUNTIME_CONTEXT_VALIDATE_OK - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
Indicator of action validation success
 
- RUNTIME_SOLUTION_NAME - Static variable in interface org.pentaho.platform.api.engine.ISolutionEngine
 
-  
 
- RUNTIME_STATUS_FAILURE - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
Indicator of action failure.
 
- RUNTIME_STATUS_INITIALIZE_FAIL - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
Indicator of initialization failure
 
- RUNTIME_STATUS_INITIALIZE_OK - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
Indicator that initialization happened successfully
 
- RUNTIME_STATUS_NOT_STARTED - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
When beginning execution of an action sequence, the status starts off as not started.
 
- RUNTIME_STATUS_RUNNING - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
As an action sequence begins execution, the status is set to running.
 
- RUNTIME_STATUS_SETUP_FAIL - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
Indicates an invalid instance ID was passed into the execution of an action sequence
 
- RUNTIME_STATUS_SUCCESS - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
 
- 
Indicates that the action executed successfully