Skip navigation links
A B C D E F G H I J K L M N O P Q R S T U V W X _ 

A

accept(ISolutionFile) - Method in interface org.pentaho.platform.api.engine.IFileFilter
 
accept(RepositoryFile) - Method in interface org.pentaho.platform.api.repository2.unified.IFileFilter
 
ACCESS_TO_UNDERLYING_CONNECTION_ALLOWED - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
ACCESS_TYPE_ADMIN - Static variable in interface org.pentaho.platform.api.engine.IAclHolder
Deprecated.
 
ACCESS_TYPE_DELETE - Static variable in interface org.pentaho.platform.api.engine.IAclHolder
Deprecated.
 
ACCESS_TYPE_READ - Static variable in interface org.pentaho.platform.api.engine.IAclHolder
Deprecated.
 
ACCESS_TYPE_UPDATE - Static variable in interface org.pentaho.platform.api.engine.IAclHolder
Deprecated.
 
ACCESS_TYPE_WRITE - Static variable in interface org.pentaho.platform.api.engine.IAclHolder
Deprecated.
 
AccessDeniedException - Exception in org.pentaho.platform.api.engine.security.userroledao
 
AccessDeniedException(String) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.AccessDeniedException
 
AccessDeniedException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.AccessDeniedException
 
ace(RepositoryFileAce) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
Entries inheriting is set to false when this method is called.
ace(RepositoryFileSid, RepositoryFilePermission, RepositoryFilePermission...) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
Entries inheriting is set to false when this method is called.
ace(RepositoryFileSid, EnumSet<RepositoryFilePermission>) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
Entries inheriting is set to false when this method is called.
ace(String, RepositoryFileSid.Type, RepositoryFilePermission, RepositoryFilePermission...) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
Entries inheriting is set to false when this method is called.
ace(String, RepositoryFileSid.Type, EnumSet<RepositoryFilePermission>) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
Entries inheriting is set to false when this method is called.
aces(List<RepositoryFileAce>) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
Replaces the ACEs with the given ACEs.
aclNode(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
action(IRuntimeContext, ISolutionActionDefinition) - Method in interface org.pentaho.platform.api.engine.IExecutionListener
 
ACTION_SEQUENCE_DEFINITION_INVALID_ACTION_DOC - Static variable in interface org.pentaho.platform.api.engine.ISequenceDefinition
return code indicating an action document that does validate against the action document schema
ACTION_SEQUENCE_DEFINITION_INVALID_XML - Static variable in interface org.pentaho.platform.api.engine.ISequenceDefinition
return code indicating a problem with the action sequences's XML
ACTION_SEQUENCE_DEFINITION_OK - Static variable in interface org.pentaho.platform.api.engine.ISequenceDefinition
return code indicating a valid SequenceDefinition
actionComplete(IRuntimeContext) - Method in interface org.pentaho.platform.api.engine.IActionCompleteListener
Invoked when a Component execution has completed
ActionExecutionException - Exception in org.pentaho.platform.api.engine
 
ActionExecutionException() - Constructor for exception org.pentaho.platform.api.engine.ActionExecutionException
 
ActionExecutionException(String) - Constructor for exception org.pentaho.platform.api.engine.ActionExecutionException
 
ActionExecutionException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionExecutionException
 
ActionExecutionException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionExecutionException
 
ActionExecutionException(String, Throwable, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionExecutionException
 
ActionExecutionException(String, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionExecutionException
 
ActionInitializationException - Exception in org.pentaho.platform.api.engine
 
ActionInitializationException() - Constructor for exception org.pentaho.platform.api.engine.ActionInitializationException
 
ActionInitializationException(String) - Constructor for exception org.pentaho.platform.api.engine.ActionInitializationException
 
ActionInitializationException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionInitializationException
 
ActionInitializationException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionInitializationException
 
ActionInitializationException(String, Throwable, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionInitializationException
 
ActionInitializationException(String, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionInitializationException
 
ActionInvocationException - Exception in org.pentaho.platform.api.action
An exception thrown when the invocation of IAction fails.
ActionInvocationException(String) - Constructor for exception org.pentaho.platform.api.action.ActionInvocationException
 
ActionInvocationException(String, Throwable) - Constructor for exception org.pentaho.platform.api.action.ActionInvocationException
 
ActionPreProcessingException - Exception in org.pentaho.platform.api.action
 
ActionPreProcessingException() - Constructor for exception org.pentaho.platform.api.action.ActionPreProcessingException
 
ActionPreProcessingException(String, Throwable) - Constructor for exception org.pentaho.platform.api.action.ActionPreProcessingException
 
ActionPreProcessingException(String) - Constructor for exception org.pentaho.platform.api.action.ActionPreProcessingException
 
ActionPreProcessingException(Throwable) - Constructor for exception org.pentaho.platform.api.action.ActionPreProcessingException
 
ActionSequenceException - Exception in org.pentaho.platform.api.engine
 
ActionSequenceException() - Constructor for exception org.pentaho.platform.api.engine.ActionSequenceException
 
ActionSequenceException(String) - Constructor for exception org.pentaho.platform.api.engine.ActionSequenceException
 
ActionSequenceException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionSequenceException
 
ActionSequenceException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionSequenceException
 
ActionSequenceException(String, Throwable, String, String, String, String, String) - Constructor for exception org.pentaho.platform.api.engine.ActionSequenceException
 
ActionSequenceException(String, Throwable, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionSequenceException
A convenience method for extracting all knowable information from an IActionDefinition
ActionSequenceException(String, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionSequenceException
A convenience method for extracting all knowable information from an IActionDefinition
ActionSequencePromptException - Exception in org.pentaho.platform.api.engine
 
ActionSequencePromptException() - Constructor for exception org.pentaho.platform.api.engine.ActionSequencePromptException
 
ActionSequencePromptException(String) - Constructor for exception org.pentaho.platform.api.engine.ActionSequencePromptException
 
ActionSequencePromptException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionSequencePromptException
 
ActionSequencePromptException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionSequencePromptException
 
ActionSequencePromptException(String, Throwable, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionSequencePromptException
 
ActionSequencePromptException(String, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionSequencePromptException
 
ActionValidationException - Exception in org.pentaho.platform.api.engine
 
ActionValidationException(String) - Constructor for exception org.pentaho.platform.api.engine.ActionValidationException
 
ActionValidationException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionValidationException
 
ActionValidationException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.ActionValidationException
 
ActionValidationException(String, String) - Constructor for exception org.pentaho.platform.api.engine.ActionValidationException
 
ActionValidationException(String, Throwable, String) - Constructor for exception org.pentaho.platform.api.engine.ActionValidationException
 
ActionValidationException(String, Throwable, String, String, String, String, String) - Constructor for exception org.pentaho.platform.api.engine.ActionValidationException
 
ActionValidationException(String, Throwable, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionValidationException
 
ActionValidationException(String, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.ActionValidationException
 
ACTIVITY_LOG - Static variable in interface org.pentaho.platform.api.engine.ILogger
 
addCacheRegion(String) - Method in interface org.pentaho.platform.api.engine.ICacheManager
 
addCacheRegion(String, Properties) - Method in interface org.pentaho.platform.api.engine.ICacheManager
 
addChildFile(IRepositoryFile) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
addConverter(String, Converter) - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryContentConverterHandler
Adds a new converter with the extension to the platform
addEntryPointHandler(IPentahoSystemEntryPoint) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Adds an entry point handler.
addExitPointHandler(IPentahoSystemExitPoint) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Adds an exit point handler.
addInitializationFailureMessage(int, String) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemInitializer
 
addInputParameter(String, IActionParameter) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Adds an input parameter to the list of all inputs for the action sequence
addLifecycleListener(IPluginLifecycleListener) - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Registers a lifecycle listener with this plugin.
addListener(IStreamListener) - Method in interface org.pentaho.platform.api.repository2.unified.ISourcesStreamEvents
 
addLogoutListener(ILogoutListener) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemListeners
 
addMetadataToRepository(String) - Method in interface org.pentaho.platform.api.repository2.unified.IBackingRepositoryLifecycleManager
 
addMimeType(IMimeType) - Method in interface org.pentaho.platform.api.mimetype.IPlatformMimeResolver
 
addNode(String) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
addNode(DataNode) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
addOutputParameters(ISolutionActionDefinition) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
addPluginManagerListener(IPluginManagerListener) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Add a IPluginManagerListener to be notified of IPluginManager events.
addPluginPerspective(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:
   PentahoSystem.registerObject( pluginPerspective );
 
addResource(ThemeResource) - Method in class org.pentaho.platform.api.ui.Theme
 
addTempParameter(String, IActionParameter) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Adds a parameter to the current inputs.
addToAllInputs(String, IActionParameter) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
addToCurrentInputs(String, IActionParameter) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
addToList(Object) - Method in interface org.pentaho.platform.api.engine.IOutputDef
Adds the given value to the value list for this output parameter.
afterUnmarshal(Unmarshaller, Object) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto
 
allowFeedback() - Method in interface org.pentaho.platform.api.engine.IOutputHandler
Determines whether this output handler can send feedback ContentItems or not.
AlreadyExistsException - Exception in org.pentaho.platform.api.engine.security.userroledao
Thrown when an object already exists with the given identifier.
AlreadyExistsException(String) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.AlreadyExistsException
 
AlreadyExistsException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.AlreadyExistsException
 
applyInputsToFormat(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Does parameter substitution on the input string, searching for all parameter declarations in the input string, and substituting the value from the matching input parameter.
applyInputsToFormat(String, IParameterResolver) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Does parameter substitution on the input string, searching for all parameter declarations in the input string, and substituting the value from the matching input parameter.
audit(String, String, String, long) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Writes a message to the audit log.
auditAll(String, String, String, String, String, String, String, String, BigDecimal, double) - Method in interface org.pentaho.platform.api.engine.IAuditEntry
This method will save the information passed as parameters to the audit storage location.
AuditException - Exception in org.pentaho.platform.api.engine
 
AuditException() - Constructor for exception org.pentaho.platform.api.engine.AuditException
 
AuditException(String) - Constructor for exception org.pentaho.platform.api.engine.AuditException
 
AuditException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.AuditException
 
AuditException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.AuditException
 

B

BACKGROUND_ACTION_NAME_STR - Static variable in interface org.pentaho.platform.api.engine.IBackgroundExecution
 
BACKGROUND_SUBMITTED - Static variable in interface org.pentaho.platform.api.engine.IBackgroundExecution
 
backgroundExecuteAction(IPentahoSession, IParameterProvider) - Method in interface org.pentaho.platform.api.engine.IBackgroundExecution
Queues the action specified in the request parameters for execution in the background
BackgroundExecutionException - Exception in org.pentaho.platform.api.scheduler
 
BackgroundExecutionException() - Constructor for exception org.pentaho.platform.api.scheduler.BackgroundExecutionException
 
BackgroundExecutionException(String) - Constructor for exception org.pentaho.platform.api.scheduler.BackgroundExecutionException
 
BackgroundExecutionException(Throwable) - Constructor for exception org.pentaho.platform.api.scheduler.BackgroundExecutionException
 
BackgroundExecutionException(String, Throwable) - Constructor for exception org.pentaho.platform.api.scheduler.BackgroundExecutionException
 
BasicSerializer() - Constructor for class org.pentaho.platform.api.monitoring.snmp.IVariableSerializer.BasicSerializer
 
becomeUser(String) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
Hi-jacks the system for the named user.
becomeUser(String, IParameterProvider) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
Hi-jacks the system for the named user.
breakTemplate(String, String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IUITemplater
 
breakTemplateString(String, String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IUITemplater
 
build() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
build() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
build() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
 
Builder(String) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
Builder(Serializable, String) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
Builder(RepositoryFile) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
Builder(String) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
Creates a Builder where the owner is a RepositoryFileSid.Type.USER.
Builder(RepositoryFileSid) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
Builder(Serializable, RepositoryFileSid) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
Builder(String, RepositoryFileSid.Type) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
Builder(Serializable, String, RepositoryFileSid.Type) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
Builder(RepositoryFileAcl) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
Builder(RepositoryFile, List<RepositoryFileTree.Builder>) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
 
Builder(RepositoryFile) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
Creates a builder with an empty list as children.
Builder(RepositoryFileTree) - Constructor for class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
 

C

cacheEnabled() - Method in interface org.pentaho.platform.api.engine.ICacheManager
Returns the enablement state of the cache.
cacheEnabled(String) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Returns the enablement state of the cache.
cacheStop() - Method in interface org.pentaho.platform.api.engine.ICacheManager
Stops the cache by calling the cacheProvider stop method.
canAccess(RepositoryFile, EnumSet<RepositoryFilePermission>) - Method in interface org.pentaho.platform.api.repository2.unified.IAclNodeHelper
Returns true if the current user has access to repositoryFile by way of ACL node.
canExport() - Method in interface org.pentaho.platform.api.engine.IContentInfo
flags used by export handler to determine if this extension can be used
canImport() - Method in interface org.pentaho.platform.api.engine.IContentInfo
flags used by import handler to determine if this extension can be used
canUnlockFile(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns true if the current user can unlock the file.
child(RepositoryFileTree.Builder) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
 
clearAces() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
clearCache() - Method in interface org.pentaho.platform.api.data.IDBDatasourceService
This method clears the whole JNDI data source cache.
clearCache() - Method in interface org.pentaho.platform.api.engine.ICacheManager
Entirely clears the cache.
clearDataSource(String) - Method in interface org.pentaho.platform.api.data.IDBDatasourceService
This method clears the specified JNDI data source from cache.
clearGlobals() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemStartupActions
 
clearLocalePropertiesMap() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
clearPluginPerspectives() - 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
 
clearRegionCache(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)
clone() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
close() - Method in interface org.pentaho.platform.api.engine.IContentListener
 
closeOutputStream() - Method in interface org.pentaho.platform.api.repository.IContentItem
 
compareTo(Object) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
compareTo(RepositoryFile) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
compareTo(RepositoryFileTree) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
Compare is based on the root file.
ComponentException - Exception in org.pentaho.platform.api.engine
 
ComponentException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.ComponentException
 
ComponentException(String) - Constructor for exception org.pentaho.platform.api.engine.ComponentException
 
ComponentException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.ComponentException
 
ComponentException() - Constructor for exception org.pentaho.platform.api.engine.ComponentException
 
configure(Map<String, String>) - Method in interface org.pentaho.platform.api.engine.IConfiguredPojo
Deprecated.
Sets the configuration settings that were requested via a call to getConfigSettingsPaths().
containsActions() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
CONTENT - Static variable in interface org.pentaho.platform.api.engine.IOutputHandler
 
contentDone() - Method in interface org.pentaho.platform.api.engine.IOutputHandler
Deprecated.
This method could never tell you if the content was actually done. Use IOutputHandler.isResponseExpected() if you need information about a handlers likelihood to generate a response.
ContentException - Exception in org.pentaho.platform.api.repository
 
ContentException(String) - Constructor for exception org.pentaho.platform.api.repository.ContentException
Constructor
ContentException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository.ContentException
Constructor
ContentException(Throwable) - Constructor for exception org.pentaho.platform.api.repository.ContentException
Constructor
contributeAttributes(ISolutionFile, Element) - Method in interface org.pentaho.platform.api.engine.ISolutionAttributeContributor
 
convert(InputStream, String, String) - Method in interface org.pentaho.platform.api.repository2.unified.Converter
 
convert(IRepositoryFileData) - Method in interface org.pentaho.platform.api.repository2.unified.Converter
 
convert(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.Converter
 
Converter - Interface in org.pentaho.platform.api.repository2.unified
Implementations of this interface are responsible for converting between an InputStream and an IRepositoryFileData.
ConverterException - Exception in org.pentaho.platform.api.repository2.unified
An exception that can be thrown from Converter implementations.
ConverterException() - Constructor for exception org.pentaho.platform.api.repository2.unified.ConverterException
 
ConverterException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.ConverterException
 
ConverterException(String) - Constructor for exception org.pentaho.platform.api.repository2.unified.ConverterException
 
ConverterException(Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.ConverterException
 
convertPostRepoSave(RepositoryFile) - Method in interface org.pentaho.platform.api.repository2.unified.Converter
Invoked for further processing of content after it was saved to repository.
copyFile(Serializable, String, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Copies file.
create(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IObjectCreator
Return an implementation for the Class T.
createAuthentication(String) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
Utility method for hydrating a Spring Authentication object (Principal) given just a user name.
createContent() - Method in interface org.pentaho.platform.api.engine.IContentGenerator
the createContent() method is called after the content generator has been initialized appropriately, and is responsible for populating the output handler.
createDatasource(IDatabaseConnection) - Method in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
Creates a JDBC datasource in a given repository and return an id
createdDate(Date) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
createDefaultAcl(RepositoryFile) - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryDefaultAclHandler
 
createFeedbackParameter(IRuntimeContext, String, String, String, Object, List, Map, String, boolean, boolean) - Method in interface org.pentaho.platform.api.engine.ICreateFeedbackParameterCallback
 
createFeedbackParameter(IActionParameter) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Deprecated.
Adds a feedback parameter for prompts based on an Action Parameter. Uses the Selections defined in the Action Parameter for the options and sets the default to the current value
createFeedbackParameter(ISelectionMapper, String, Object) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Adds a feedback parameter (essentially a form input field) for a required input.
createFeedbackParameter(ISelectionMapper, String, Object, boolean) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Adds a feedback parameter (essentially a form input field) for a required input.
createFeedbackParameter(String, String, String, Object, boolean) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Adds a scalar feedback parameter
createFeedbackParameter(String, String, String, Object, boolean, boolean) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Adds a scalar feedback parameter
createFeedbackParameter(String, String, String, Object, List, Map, String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Creates a feedback parameter that uses a list for the values
createFeedbackParameter(String, String, String, Object, List, Map, String, boolean) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Creates a feedback parameter that uses a list for the values
createFile(Serializable, RepositoryFile, IRepositoryFileData, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Creates a file.
createFile(Serializable, RepositoryFile, IRepositoryFileData, RepositoryFileAcl, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Creates a file.
createFolder(Serializable, RepositoryFile, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Creates a folder.
createFolder(Serializable, RepositoryFile, RepositoryFileAcl, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Creates a folder.
createNewInstance(boolean) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Creates a new runtime context that is a child of this instance
createNewInstance(boolean, Map) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Creates a new runtime context that is a child of this instance and sets attributes of the runtime data from the parameter Map
createNewInstance(boolean, Map, boolean) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Creates a new runtime context that is a child of this instance and sets attributes of the runtime data from the parameter Map, and can optionally cause the new instance to be forcibly written to the underlying persistence mechanism.
createObject(String, ILogger) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemHelper
Deprecated.
createObject(String) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemHelper
Deprecated.
createRole(ITenant, String, String, String[]) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Create a role under a specified tenant.
createTempFile(IPentahoSession, String, String, File, boolean) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Creates a temporary file in the specified parent folder and optionally tracks it for deletion on session termination
createTempFile(IPentahoSession, String, String, boolean) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Creates a temporary file in the system/tmp solutions folder
createTenant(ITenant, String, String, String, String) - Method in interface org.pentaho.platform.api.mt.ITenantManager
 
createUser(ITenant, String, String, String, String[]) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Creates user under a specified tenant.
createUserHomeFolder(ITenant, String) - Method in interface org.pentaho.platform.api.mt.ITenantManager
Creates users home folder.
creatorId(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
CsrfProtectionDefinition - Class in org.pentaho.platform.api.engine
This class represents an extension to the contract of a plugin containing CSRF protection information.
CsrfProtectionDefinition() - Constructor for class org.pentaho.platform.api.engine.CsrfProtectionDefinition
 

D

DataNode - Class in org.pentaho.platform.api.repository2.unified.data.node
 
DataNode(String) - Constructor for class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
DataNode.DataPropertyType - Enum in org.pentaho.platform.api.repository2.unified.data.node
 
DataNodeDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
DataNodeDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
DataNodeRef - Class in org.pentaho.platform.api.repository2.unified.data.node
 
DataNodeRef(Serializable) - Constructor for class org.pentaho.platform.api.repository2.unified.data.node.DataNodeRef
 
DataProperty - Class in org.pentaho.platform.api.repository2.unified.data.node
 
DataProperty(String, Object, DataNode.DataPropertyType) - Constructor for class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
DataPropertyDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
DataPropertyDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.DataPropertyDto
 
DatasourceMgmtServiceException - Exception in org.pentaho.platform.api.repository.datasource
 
DatasourceMgmtServiceException() - Constructor for exception org.pentaho.platform.api.repository.datasource.DatasourceMgmtServiceException
 
DatasourceMgmtServiceException(String) - Constructor for exception org.pentaho.platform.api.repository.datasource.DatasourceMgmtServiceException
 
DatasourceMgmtServiceException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository.datasource.DatasourceMgmtServiceException
 
DatasourceMgmtServiceException(Throwable) - Constructor for exception org.pentaho.platform.api.repository.datasource.DatasourceMgmtServiceException
 
DBDatasourceServiceException - Exception in org.pentaho.platform.api.data
 
DBDatasourceServiceException() - Constructor for exception org.pentaho.platform.api.data.DBDatasourceServiceException
 
DBDatasourceServiceException(String) - Constructor for exception org.pentaho.platform.api.data.DBDatasourceServiceException
 
DBDatasourceServiceException(String, Throwable) - Constructor for exception org.pentaho.platform.api.data.DBDatasourceServiceException
 
DBDatasourceServiceException(Throwable) - Constructor for exception org.pentaho.platform.api.data.DBDatasourceServiceException
 
DEBUG - Static variable in interface org.pentaho.platform.api.engine.ILogger
The DEBUG Level designates fine-grained informational events that are most useful to debug an application.
debug(String) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message object with the DEBUG Level.
debug(String, Throwable) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message with the DEBUG level including the stack trace of the Throwable error passed as parameter.
decrypt(String) - Method in interface org.pentaho.platform.api.util.IPasswordService
 
DEFAULT_AUTO_COMMIT - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
DEFAULT_CATALOG - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
DEFAULT_LOCALE - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
DEFAULT_PRIORTIY - Static variable in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
 
DEFAULT_RANKING - Static variable in interface org.pentaho.platform.api.engine.IPentahoObjectReference
 
DEFAULT_READ_ONLY - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
DEFAULT_TRANSACTION_ISOLATION - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
DEFAULT_USER_NAME - Static variable in interface org.pentaho.platform.api.engine.IBackgroundExecution
 
defineInstance(String, Object) - Method in interface org.pentaho.platform.api.engine.IPentahoDefinableObjectFactory
Deprecated.
Defines a new object instance.
defineObject(String, String, IPentahoDefinableObjectFactory.Scope) - Method in interface org.pentaho.platform.api.engine.IPentahoDefinableObjectFactory
Deprecated.
Defines a new object.
defineObject(String, String, IPentahoDefinableObjectFactory.Scope, ClassLoader) - Method in interface org.pentaho.platform.api.engine.IPentahoDefinableObjectFactory
Deprecated.
Defines a new object that must be loaded with a specific classloader
delete(IAction, String, Map<String, Serializable>) - Method in interface org.pentaho.platform.api.action.IActionAdaptor
Delete the request
deleteDatasourceById(String) - Method in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
Permanently deletes a JDBC datasource from a repository by id
deleteDatasourceByName(String) - Method in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
Permanently deletes a JDBC datasource from a repository by name
deletedDate(Date) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
deleteFile(Serializable, boolean, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Deletes a file.
deleteFile(Serializable, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Deletes a file in a recoverable manner.
deleteFileAtVersion(Serializable, Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Permanently deletes a specific version of a file.
deleteLocalePropertiesForFile(RepositoryFile, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
DELETER_SESSION_VARIABLE - Static variable in interface org.pentaho.platform.api.util.ITempFileDeleter
 
deleteRole(IPentahoRole) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Delete the role from the repository
deleteTenant(ITenant) - Method in interface org.pentaho.platform.api.mt.ITenantManager
Deletes the tenant
deleteTenants(List<ITenant>) - Method in interface org.pentaho.platform.api.mt.ITenantManager
Deletes a list of tenants
deleteUser(IPentahoUser) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Delete the user from the repository
deleteUserSettings(String) - Method in interface org.pentaho.platform.api.usersettings.IAnyUserSettingService
Deprecated.
Deletes all user settings for a specified username
deleteUserSettings() - Method in interface org.pentaho.platform.api.usersettings.IUserSettingService
 
description(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
description(String, String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
DESCRIPTION - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
destroy() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Destroys any resources owned by the session object.
dispose() - Method in interface org.pentaho.platform.api.data.IDataComponent
Disposes of resources held by the data component
dispose() - Method in interface org.pentaho.platform.api.data.IPreparedComponent
Disposes of resources held by the prepared component
dispose() - Method in interface org.pentaho.platform.api.engine.IActionParameter
See if we need to do any cleanup here
dispose() - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
dispose(List) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
dispose() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
dispose(List) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
doesMetadataExists(String) - Method in interface org.pentaho.platform.api.repository2.unified.IBackingRepositoryLifecycleManager
 
done() - Method in interface org.pentaho.platform.api.engine.IComponent
Allows the component to perform any cleanup after the execution of the action.
doPreExecution() - Method in interface org.pentaho.platform.api.action.IPreProcessingAction
This method is called on an Action just prior to execution.
doTempFileCleanup() - Method in interface org.pentaho.platform.api.util.ITempFileDeleter
Performs the temp file cleanup.
DuplicateDatasourceException - Exception in org.pentaho.platform.api.repository.datasource
 
DuplicateDatasourceException() - Constructor for exception org.pentaho.platform.api.repository.datasource.DuplicateDatasourceException
 
DuplicateDatasourceException(String) - Constructor for exception org.pentaho.platform.api.repository.datasource.DuplicateDatasourceException
 
DuplicateDatasourceException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository.datasource.DuplicateDatasourceException
 
DuplicateDatasourceException(Throwable) - Constructor for exception org.pentaho.platform.api.repository.datasource.DuplicateDatasourceException
 

E

enableTenant(ITenant, boolean) - Method in interface org.pentaho.platform.api.mt.ITenantManager
Enables/disables the tenant with the paths of tenantPath
enableTenants(List<ITenant>, boolean) - Method in interface org.pentaho.platform.api.mt.ITenantManager
Enables/disables the tenants with paths in the tenantPaths list
encrypt(String) - Method in interface org.pentaho.platform.api.util.IPasswordService
 
entriesInheriting(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
equals(Object) - Method in interface org.pentaho.platform.api.engine.IPentahoAclObjectIdentity
Deprecated.
Refer to the java.lang.Object documentation for the interface contract.
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNodeRef
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAce
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileSid
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.webservices.LocaleMapDto
 
equals(Object) - Method in class org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto
 
equals(Object) - Method in class org.pentaho.platform.api.ui.Theme
 
ERROR - Static variable in interface org.pentaho.platform.api.engine.ILogger
The ERROR level designates error events that might still allow the application to continue running.
error(String) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message object with the ERROR Level.
error(String, Throwable) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message with the ERROR level including the stack trace of the Throwable error passed as parameter.
ExecutableFileTypeDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
ExecutableFileTypeDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
execute() - Method in interface org.pentaho.platform.api.action.IAction
The method in your Action that does the work.
execute(IAction, String, Map<String, Serializable>) - Method in interface org.pentaho.platform.api.action.IActionAdaptor
Execute the request in the orchestration environment
execute() - Method in interface org.pentaho.platform.api.engine.IComponent
Perform the Component execution; logic for what this Component does goes here.
execute() - Method in interface org.pentaho.platform.api.engine.ISimplePojoComponent
Deprecated.
 
execute(String, String, boolean, boolean, String, boolean, Map, IOutputHandler, IActionCompleteListener, IPentahoUrlFactory, List) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
Executes the action sequence specified in the manner described in the parameters
execute(IRuntimeContext, String, String, boolean, boolean, Map, IOutputHandler) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
Executes the action sequence specified
execute(String, String, String, boolean, boolean, String, boolean, Map, IOutputHandler, IActionCompleteListener, IPentahoUrlFactory, List) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
Executes the in memory action sequence specified
executePrepared(Map) - Method in interface org.pentaho.platform.api.data.IPreparedComponent
executes a prepared method that returns a result set executePrepared looks up any "PREPARELATER" params in the preparedParams map.
executeSequence(IActionCompleteListener, IExecutionListener, boolean) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Executes the action sequence.
exists() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
exists() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 

F

FATAL - Static variable in interface org.pentaho.platform.api.engine.ILogger
The FATAL level designates very severe error events that will presumably lead the application to abort.
fatal(String) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message object with the FATAL Level.
fatal(String, Throwable) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message with the FATAL level including the stack trace of the Throwable error passed as parameter.
FEEDBACK_OUTPUT - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
Unused
feedbackAllowed() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
FILE - Static variable in interface org.pentaho.platform.api.engine.IOutputHandler
 
FILE_DESCRIPTION - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
FILE_RESOURCE - Static variable in interface org.pentaho.platform.api.engine.IActionSequenceResource
The resource is an arbitrary file
FILE_TITLE - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
fileCreated(String) - Method in interface org.pentaho.platform.api.repository2.unified.IStreamListener
 
fileSize(long) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
findResources(Class<?>, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
A searching method, yielding a list of plugin-related resources as URLs.
findResources(ClassLoader, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
 
folder(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
forceSave() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Causes an immediate call to the underlying persistence mechanism's write-now method.
forceSaveRuntimeData() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Forces the immediate write of runtime data to underlying persistence mechanism.
formatErrorMessage(String, String, String, StringBuffer) - Method in interface org.pentaho.platform.api.engine.IMessageFormatter
 
formatErrorMessage(String, String, List, StringBuffer) - Method in interface org.pentaho.platform.api.engine.IMessageFormatter
 
formatFailureMessage(String, IRuntimeContext, StringBuffer, List) - Method in interface org.pentaho.platform.api.engine.IMessageFormatter
 
formatFailureMessage(String, IRuntimeContext, StringBuffer, List, boolean) - Method in interface org.pentaho.platform.api.engine.IMessageFormatter
 
formatFailureMessage(String, IRuntimeContext, StringBuffer) - Method in interface org.pentaho.platform.api.engine.IMessageFormatter
 
formatResultSetAsHTMLRows(IPentahoResultSet, StringBuffer) - Method in interface org.pentaho.platform.api.engine.IMessageFormatter
 
formatSuccessMessage(String, IRuntimeContext, StringBuffer, boolean) - Method in interface org.pentaho.platform.api.engine.IMessageFormatter
 
formatSuccessMessage(String, IRuntimeContext, StringBuffer, boolean, boolean) - Method in interface org.pentaho.platform.api.engine.IMessageFormatter
 
fromPentahoRole(String) - Method in interface org.pentaho.platform.api.engine.security.IAuthenticationRoleMapper
Takes a Hitachi Vantara security role and returns the mapped third party role.

G

get(Class<T>, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Retrieves an instance of a Pentaho BI Server API interface using the simple interface name (interfaceClass name without the package) as the object key.
get(Class<T>, String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Retrieves an instance of a Pentaho BI Server API interface by the given object key.
get(Class<T>, IPentahoSession, Map<String, String>) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Retrieves an instance of a Pentaho BI Server API interface using the simple interface name (interfaceClass name without the package) as the object key.
getAccessControls() - Method in interface org.pentaho.platform.api.engine.IAclHolder
Deprecated.
Returns the ACLs on the existing object.
getAces() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl
 
getAces() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
getAcl() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
Ability to use the export manifest during import to apply ACL and File settings
getAcl(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns ACL for file.
getACLFileExtensionList() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemAclHelper
 
getAclFor(RepositoryFile) - Method in interface org.pentaho.platform.api.repository2.unified.IAclNodeHelper
Returns an ACL for repositoryFile.
getAclObjectIdentity() - Method in interface org.pentaho.platform.api.engine.IPentahoBasicAclEntry
Deprecated.
Indicates the domain object instance that is subject of this BasicAclEntry.
getAclObjectParentIdentity() - Method in interface org.pentaho.platform.api.engine.IPentahoBasicAclEntry
Deprecated.
Indicates any ACL parent of the domain object instance.
getActionClass() - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
getActionDefinition() - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
getActionDefinition() - Method in interface org.pentaho.platform.api.engine.IComponent
 
getActionDefinitionsAndSequences() - Method in interface org.pentaho.platform.api.engine.IActionSequence
Returns the list of ActionDefinition objects retrieved from the SequenceDefinition.
getActionInputDefinitions() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns a Map of the input parameters that are defined to this ActionDefinition.
getActionName() - Method in interface org.pentaho.platform.api.engine.IAuditable
Return the name of the action sequence.
getActionName() - Method in interface org.pentaho.platform.api.engine.IComponent
 
getActionName() - Method in interface org.pentaho.platform.api.scheduler.IJobDetail
 
getActionOutputContents() - Method in interface org.pentaho.platform.api.action.IPostProcessingAction
 
getActionOutputDefinitions() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns a Map of the output parameters that are defined for this ActionDefinition.
getActionOutputScope() - Method in interface org.pentaho.platform.api.engine.ISessionStartupAction
 
getActionPath() - Method in interface org.pentaho.platform.api.engine.ISessionStartupAction
 
getActionResourceDefinitionNames() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns a List of the resource parameter names that are defined for this ActionDefinition.
getActionSequence() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getActionSequenceName() - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
getActionTitle() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
During execution of an action sequence, returns the IActionSequence#getTitle().
getActionUrlBuilder() - Method in interface org.pentaho.platform.api.engine.IPentahoUrlFactory
Gets a builder for action URLs.
getActualRequestParameterName(String) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getAddress() - Method in interface org.pentaho.platform.api.engine.IActionSequenceResource
Depending on the resource source type, returns the address to the resource as a path or a URL.
getAdminPlugins() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getAdminRole() - Method in interface org.pentaho.platform.api.engine.IAclVoter
Deprecated.
Gets the role used to determine whether someone is the system-manager.
getAll(Class<T>, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Returns all objects implementing the provided interface or extending the provided class if the Class is not an Interface.
getAll(Class<T>, IPentahoSession, Map<String, String>) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Returns all objects implementing the provided interface or extending the provided class if the Class is not an Interface.
getAllDeletedFiles() - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets all deleted files.
getAllEntriesFromRegionCache(String) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Get a Set of Map.Entry objects from the cache within a specific region
getAllKeysFromRegionCache(String) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Get a Set of Key objects from the cache within a specific region
getAllowedActions(String) - Method in interface org.pentaho.platform.api.engine.IAuthorizationPolicy
Returns all actions in the given namespace that are currently allowed.
getAllParameters() - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getAllRoles() - Method in interface org.pentaho.platform.api.engine.IUserRoleListService
Returns all authorities known to the provider.
getAllRoles(ITenant) - Method in interface org.pentaho.platform.api.engine.IUserRoleListService
Returns all authorities known to the provider for a given tenant.
getAllUsers() - Method in interface org.pentaho.platform.api.engine.IUserRoleListService
Returns all user names known to the provider.
getAllUsers(ITenant) - Method in interface org.pentaho.platform.api.engine.IUserRoleListService
Returns all user names known to the provider for a given tenant.
getAllValuesFromRegionCache(String) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Get a list of values from the cache within a specific region
getApplicationContext() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getApplicationPath(String) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Returns the path to the web application or standalone application.
getArrayParameter(String, Object[]) - Method in interface org.pentaho.platform.api.engine.IParameterProvider
Retrieve the requested parameter as an Object array
getAttribute(String) - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Gets the value of a named session attribute.
getAttributeNames() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Returns an enumeration of the names of the attributes stored in the session.
getAttributes() - Method in interface org.pentaho.platform.api.engine.IPentahoObjectReference
 
getAuthentication() - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
 
getAuthentication(IPentahoSession, boolean) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
Remove this method when data-access is JCR-branched
getAuthor() - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
getAuthor() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the author of the SequenceDefinition, if defined, or null otherwise.
getAuthor() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the author of the ActionDefinition, if defined, or null otherwise.
getAuthor() - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
getAuthor() - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
getAvailableLocalesForFile(RepositoryFile) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
getAvailableLocalesForFileById(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
getAvailableLocalesForFileByPath(String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
getBackgroundContent(String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IBackgroundExecution
Gets the content generated by background execution
getBackgroundExecutedContentList(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IBackgroundExecution
Gets a list of content GUIDs of background executed jobs
getBackgroundExecutionAlert() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Checks the status of a background execution task.
getBaseUrl() - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Deprecated.
Returns a URL to the server application, up to and including the context.

The URL that is returned is derived from the server context, and thus will include the protocol, host name, port, and application context root.

getBean(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
If any plugins have registered a bean by id beanId, this method will return a new instance of the object.
getBeanFactory() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns the Spring application context for this plugin
getBeanFactory(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns a (Spring) bean factory for retrieving plugin-bound objects
getBeanId() - Method in class org.pentaho.platform.api.engine.PluginBeanDefinition
 
getBeans() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns a list of bean configurations for this plugin-in
getBigDecimalProperty(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a BigDecimal property from the Runtime Element.
getBigDecimalProperty(String, BigDecimal) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a BigDecimal property from the Runtime Element.
getBoolean() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
getCachedItems() - Method in interface org.pentaho.platform.api.cache.ICacheExpirationRegistry
Gets a List of all items registered
getCacheKey() - Method in interface org.pentaho.platform.api.cache.ILastModifiedCacheItem
Get the lookup key for this cache item
getCharset() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
Optional character set for the binary InputStream.
getChildBundles() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
This allows for arbitrary parent-child trees to be imported.
getChildNodeFilter() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
getChildNodes() - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
getChildProperties() - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
getChildren(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Deprecated.
getChildren(Serializable, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Deprecated.
getChildren(Serializable, String, Boolean) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Deprecated.
getChildren(RepositoryRequest) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns the children according to the specifications of the RepositoryRequest object
getChildren() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
 
getChildren() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
Children can have one of three values: null: children were not fetched; used for operations that support depth empty list: there are no children for this file (i.e.
getChildren() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto
 
getChildrenFiles() - Method in interface org.pentaho.platform.api.engine.IAclSolutionFile
Deprecated.
Gets the set children IAclSolutionFiles from this IAclSolutionFile.
getChildrenFiles() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getChildTenants(ITenant) - Method in interface org.pentaho.platform.api.mt.ITenantManager
Gets children tenants of the "parent" tenant.
getChildTenants(ITenant, boolean) - Method in interface org.pentaho.platform.api.mt.ITenantManager
Gets children tenants of the "parent" tenant.
getClassLoader(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns the classloader instance that was assigned by the plugin manager to load all classes for the specified plugin.
getClassname() - Method in interface org.pentaho.platform.api.engine.IContentGeneratorInfo
 
getClassname() - Method in class org.pentaho.platform.api.engine.PluginBeanDefinition
 
getComponent() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the Component object that this ActionDefinition belongs to.
getComponentDefinition() - Method in interface org.pentaho.platform.api.engine.IComponent
 
getComponentName() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the Java class name of the Component that this ActionDefinition is created for.
getComponentSection() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the Component definition portion of this ActionDefinition.
getConditionalExecution() - Method in interface org.pentaho.platform.api.engine.IActionSequence
 
getConfigSettingsPaths() - Method in interface org.pentaho.platform.api.engine.IConfiguredPojo
Deprecated.
Returns a list of Strings that define system settings that a POJO component would like read for it.
getConfiguration(String) - Method in interface org.pentaho.platform.api.engine.ISystemConfig
 
getContent(String) - Method in interface org.pentaho.platform.api.ui.IXMLComponent
 
getContentGenerator() - Method in interface org.pentaho.platform.api.engine.IContentGeneratorInvoker
Returns a IContentGenerator
getContentGenerator(String, String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns a IContentGenerator that can render the named perspective (e.g.
getContentGeneratorForType(String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Deprecated.
Use {@link #getContentGenerator(String, String) instead
getContentGenerators() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns the list of content generators for this plug-in
getContentInfos() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns a list of content info objects for this plug-in
getContentOutputHandler(String, String, String, IPentahoSession, IParameterProvider) - Method in interface org.pentaho.platform.api.engine.IBackgroundExecution
Returns the output handler for content, specific to the implementation of the background execution helper.
getContentRef() - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
getContentTypeInfo(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Gets metadata about a particular content type
getContentTypes() - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns a set of the content types that the registered plugins can process.
getContentUrl() - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
getContext() - Method in interface org.pentaho.platform.api.engine.IApplicationContext
 
getContext() - Method in interface org.pentaho.platform.api.engine.IPlatformWebResource
Context associated with this resource.
getContextPath() - Method in interface org.pentaho.platform.api.engine.IPentahoRequestContext
Returns the portion of the request URI that indicates the context of the request.
getConverter() - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
getConverter(String) - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryContentConverterHandler
Retrieves a particular converter based on the extension provided
getConverters() - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryContentConverterHandler
Retrieves a map of content converters.
getCreatedDate() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getCreatedDate() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getCreatorId() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getCreatorId() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getCsrfProtection() - Method in interface org.pentaho.platform.api.engine.IPlatformPluginCsrfProtection
Returns the CSRF protection definition for this plugin.
getCurrentComponentName() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getCurrentInput(String) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getCurrentInputNames() - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getCurrentOutput(String) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getCurrentOutputNames() - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getCurrentResource(String) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getCurrentResourceNames() - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getData() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
getData() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getDataAtVersionForExecute(Serializable, Serializable, Class<T>) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets data at given version for read.
getDataAtVersionForRead(Serializable, Serializable, Class<T>) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets data at given version for read.
getDataForExecute(Serializable, Class<T>) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets data at base version for execute.
getDataForExecuteInBatch(List<RepositoryFile>, Class<T>) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets the data for multiple RepositoryFiles for execute.
getDataForRead(Serializable, Class<T>) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets data at base version for read.
getDataForReadInBatch(List<RepositoryFile>, Class<T>) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets the data for multiple RepositoryFiles for read.
getDataSize() - Method in class org.pentaho.platform.api.repository2.unified.data.node.NodeRepositoryFileData
 
getDataSize() - Method in class org.pentaho.platform.api.repository2.unified.data.sample.SampleRepositoryFileData
 
getDataSize() - Method in class org.pentaho.platform.api.repository2.unified.data.simple.SimpleRepositoryFileData
 
getDataSize() - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryFileData
 
getDataSource(String) - Method in interface org.pentaho.platform.api.data.IDBDatasourceService
Since JNDI is supported in different ways by different application servers, it's nearly impossible to have a standard way to look up a data source.
getDataSource(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Get's the content item associated with the parameter, and returns the content item's datasource
getDataSource() - Method in interface org.pentaho.platform.api.repository.IContentItem
 
getDatasourceById(String) - Method in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
Retrieves a JDBC datasource form the repository by id
getDatasourceByName(String) - Method in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
Retrieves a JDBC datasource form the repository by name
getDatasourceIds() - Method in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
Retrieves all JDBC datasource ids from the repository
getDatasources() - Method in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
Retrieves all JDBC datasources from the repository
getDate() - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
getDate() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
getDate() - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
getDate() - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
getDateParameter(String, Date) - Method in interface org.pentaho.platform.api.engine.IParameterProvider
Retrieve the requested parameter as type java.util.Date.
getDateProperty(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a Date property from the Runtime Element.
getDateProperty(String, Date) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a Date property from the Runtime Element.
getDecimalParameter(String, BigDecimal) - Method in interface org.pentaho.platform.api.engine.IParameterProvider
Retrieve the requested parameter as decimal, returning a java.lang.Object.
getDefaultFrom() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
getDeletedDate() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getDeletedDate() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getDeletedFiles(String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets all deleted files for the current user in this folder.
getDeletedFiles(String, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets all deleted files for the current user in this folder.
getDeletedFiles() - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets all deleted files for the current user.
getDepth() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
getDescription() - Method in interface org.pentaho.platform.api.engine.IContentGeneratorInfo
 
getDescription() - Method in interface org.pentaho.platform.api.engine.IContentInfo
The description of this content type as presented to the user Implementors of this interface should provide localization for the description
getDescription() - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
getDescription() - Method in interface org.pentaho.platform.api.engine.IPentahoPublisher
 
getDescription() - Method in interface org.pentaho.platform.api.engine.IScheduledJob
 
getDescription() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the description of this SequenceDefinition, if defined, or null otherwise.
getDescription() - Method in interface org.pentaho.platform.api.engine.IServiceConfig
Returns the localized title for this web service.
getDescription() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the description of the ActionDefinition, if defined, or null otherwise.
getDescription() - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
getDescription() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoRole
 
getDescription() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoUser
 
getDescription() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getDescription() - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
getDescription() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getDescription() - Method in interface org.pentaho.platform.api.scheduler.IJobDetail
 
getDisplayStyle() - Method in interface org.pentaho.platform.api.engine.ISelectionMapper
 
getDisplayType() - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
getDisplayUrlBuilder() - Method in interface org.pentaho.platform.api.engine.IPentahoUrlFactory
Returns a URL builder for contructing URLs that are generated for user feedback (e.g.
getDouble() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
getDSBoundName(String) - Method in interface org.pentaho.platform.api.data.IDBDatasourceService
Since JNDI is supported in different ways by different application servers, it's nearly impossible to have a standard way to look up a data source.
getDSUnboundName(String) - Method in interface org.pentaho.platform.api.data.IDBDatasourceService
Since JNDI is supported in different ways by different application servers, it's nearly impossible to have a standard way to look up a data source.
getEditUrlPattern() - Method in interface org.pentaho.platform.api.ui.IFileTypePlugin
return the edit url pattern.
getEffectiveAccessControls() - Method in interface org.pentaho.platform.api.engine.IAclHolder
Deprecated.
Examines whether the existing object has ACLs.
getEffectiveAces(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns the list of access control entries (ACEs) that will be used to make an access control decision.
getEffectiveAces(Serializable, boolean) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns the list of access control entries (ACEs) that will be used to make an access control decision.
getEffectiveAcl(IPentahoSession, IAclHolder) - Method in interface org.pentaho.platform.api.engine.IAclVoter
Deprecated.
This returns the effective ACL for the piece of content for the given user.
getEffectiveAcls(IPentahoSession, IAclHolder) - Method in interface org.pentaho.platform.api.engine.IAclVoter
Deprecated.
Returns an array of the authorities from the IAclHolder that apply to the provided authentication object.
getEffectivePermissions(Object) - Method in interface org.pentaho.platform.api.engine.IPermissionMgr
Deprecated.
Returns permission map containing access control entries that are defined directly on this domainInstance.
getElementCountInGlobalCache() - Method in interface org.pentaho.platform.api.engine.ICacheManager
Counts the items in the global cache
getElementCountInRegionCache(String) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Counts the items in the region cache
getElementCountInSessionCache() - Method in interface org.pentaho.platform.api.engine.ICacheManager
Counts the items in the session cache
getEmailConfig() - Method in interface org.pentaho.platform.api.email.IEmailService
Retrieves the current email configuration
getEnabledOptions() - Method in interface org.pentaho.platform.api.ui.IFileTypePlugin
return a comma separated list of commands supported by this plugin
getEncoding() - Method in class org.pentaho.platform.api.repository2.unified.data.simple.SimpleRepositoryFileData
Returns the character encoding of the bytes in the data stream.
getEndpointImpl() - Method in interface org.pentaho.platform.api.websocket.IWebsocketEndpointConfig
The class that implements this websocket endpoint.
getErrorMessage() - Method in interface org.pentaho.platform.api.engine.IScheduledJob
 
getEtcFolderName() - Method in interface org.pentaho.platform.api.repository.IClientRepositoryPathsStrategy
 
getEtcFolderPath() - Method in interface org.pentaho.platform.api.repository.IClientRepositoryPathsStrategy
 
getExcludeMemberSet() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
getExecutionContext() - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
 
getExecutionState() - Method in interface org.pentaho.platform.api.engine.IScheduledJob
 
getExtension() - Method in interface org.pentaho.platform.api.engine.IContentInfo
The extension of files that generate this content type.
getExtension() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
getExtension() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getExtension() - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
getExtensions() - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
getExternalResourcesForContext(String) - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Return a List of scripts registered for a given context.
getExternalResourcesForContext(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Return a List of scripts registered for a given context.
getExtraClasses() - Method in interface org.pentaho.platform.api.engine.IServiceConfig
 
getExtraClasses() - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
getFeedbackContentItem() - Method in interface org.pentaho.platform.api.engine.IOutputHandler
Retrieve the ContentItem that describes the request interface for additional or missing information (missing from the original request)
getFeedbackContentItem() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Interfaces to the current output handler to get the content item that is handling feedback (i.e.
getFile(String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets file.
getFile(String, boolean) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Same as IUnifiedRepository.getFile(String) except that if loadMaps is true, the maps for localized strings will be loaded as well.
getFile(String, IPentahoLocale) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Like IUnifiedRepository.getFile(String, boolean) except that the maps which are pulled back are slimmed down to only contain the localized strings
getFile(String, boolean, IPentahoLocale) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Retrieves a file at its given version
getFile() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree.Builder
 
getFile() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
getFile() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto
 
getFileAtVersion(Serializable, Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets file as it was at the given version.
getFileById(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets file.
getFileById(Serializable, boolean) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Same as IUnifiedRepository.getFile(String) except that if loadMaps is true, the maps for localized strings will be loaded as well.
getFileById(Serializable, IPentahoLocale) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Same as IUnifiedRepository.getFile(String, IPentahoLocale) except that the Serializable file id is required
getFileById(Serializable, boolean, IPentahoLocale) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Retrieves a file at its given version by its id
getFileExtension() - Method in interface org.pentaho.platform.api.ui.IFileTypePlugin
return the file extension this plugin supports
getFileId() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getFileInfoGeneratorClassname() - Method in interface org.pentaho.platform.api.engine.IContentGeneratorInfo
Deprecated.
file info generators or solution file meta providers are now associated with content types, not content generators. This method is not called from within the platform.
getFileMetadata(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets a metadata for the given fileid
getFileName() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
getFileName() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getFileOutputContentItem() - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
Returns a content item that can be used to stream content to a destination of some kind
getFileOutputPath(String) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Used for content output (temporary and otherwise), returns a fully qualified path suitable for creating a File object from.
getFileSize() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getFileSize() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getFirstError(List) - Method in interface org.pentaho.platform.api.engine.IMessageFormatter
If PentahoMessenger.getUserString("ERROR") returns the string: "Error: {0} ({1})" (which is the case for English) Find the substring before the first "{".
getFromGlobalCache(Object) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Gets an object from the cache without translating the passed in key.
getFromName() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
getFromRegionCache(String, Object) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Gets an object from the cache within a specific region
getFromSessionCache(IPentahoSession, String) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Gets an object from the user session specific cache.
getFullName() - Method in interface org.pentaho.platform.api.scheduler.IJobDetail
 
getFullname() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getFullPath() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
getFullPath() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getFullyQualifiedServerURL() - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Returns a fully qualified URL to the server application, up to and including the context.
getGlobalParameters() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemStartupActions
 
getGlobalUserSetting(String, String) - Method in interface org.pentaho.platform.api.usersettings.IUserSettingService
 
getGlobalUserSettings() - Method in interface org.pentaho.platform.api.usersettings.IUserSettingService
 
getGroupName() - Method in interface org.pentaho.platform.api.scheduler.IJobDetail
 
getHandle() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Returns the unique context identifier.
getHandlerId() - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
getHelp() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the URL to the Help page for this definition.
getHelp() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the URL to the Help page for this definition.
getHomeFolderName() - Method in interface org.pentaho.platform.api.repository.IClientRepositoryPathsStrategy
 
getHomeFolderPath() - Method in interface org.pentaho.platform.api.repository.IClientRepositoryPathsStrategy
 
getIcon() - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
getIcon() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the path to the icon for this SequenceDefinition.
getIconUrl() - Method in interface org.pentaho.platform.api.engine.IContentInfo
Returns an url to an icon for this content type
getIconUrl() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the URL to the icon for this definition.
getId() - Method in interface org.pentaho.platform.api.engine.IAuditable
Returns a unique id (across classes and instances) for this auditable object.
getId() - Method in interface org.pentaho.platform.api.engine.IConfiguration
 
getId() - Method in interface org.pentaho.platform.api.engine.IContentGeneratorInfo
 
getId() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Gets the ID for this session.
getId() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns the unique ID of this plugin
getId() - Method in interface org.pentaho.platform.api.engine.IPluginOperation
Gets the id for this operation.
getId() - Method in interface org.pentaho.platform.api.engine.IServiceConfig
Returns the unique id of this web service.
getId() - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
getId() - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
getId() - Method in interface org.pentaho.platform.api.monitoring.IMonitoringEvent
 
getId() - Method in interface org.pentaho.platform.api.mt.ITenant
The method is used for retrieving ID of the tenant.
getId() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
getId() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNodeRef
 
getId() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getId() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl
 
getId() - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
getId() - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
getId() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
getId() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getId() - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
getId() - Method in class org.pentaho.platform.api.ui.Theme
 
getImplementingClass(String) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Provides the concrete Class defined for the given object key.
getIncludeMemberSet() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
getInitializationFailureMessages() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemInitializer
 
getInitializedOK() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemInitializer
 
getInitializedStatus() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemInitializer
 
getInput(String) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getInputDefinitions() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns a Map of the input parameters that are defined to this SequenceDefinition.
getInputDefinitionsForParameterProvider(String) - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns a Map of the input parameters that are defined to this SequenceDefinition for a specific parameter provider.
getInputNames() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getInputParameter(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Returns the named input parameter.
getInputParameterStringValue(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Gets the value of the specified input parameter as a String.
getInputParameterValue(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Gets the value of the specified input parameter.
getInputStream(RepositoryFilePermission, Locale) - Method in interface org.pentaho.platform.api.engine.IActionSequenceResource
 
getInputStream(RepositoryFilePermission) - Method in interface org.pentaho.platform.api.engine.IActionSequenceResource
 
getInputStream(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Returns an input stream from an input parameter, if the input parameter is a content item.
getInputStream() - Method in interface org.pentaho.platform.api.repository.IContentItem
Gets an input stream from the Content item.
getInputStream() - Method in class org.pentaho.platform.api.repository2.unified.data.simple.SimpleRepositoryFileData
Returns a stream for reading the data in this file.
getInputStream() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
Optional InputStream for content with a binary component.
getInputStream(InputStream, InputStream) - Method in interface org.pentaho.platform.api.repository2.unified.MondrianSchemaAnnotator
 
getInstanceId() - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
getInstanceId() - Method in interface org.pentaho.platform.api.engine.IComponent
 
getInstanceId() - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
getInstanceId() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Returns the unique execution instance.
getInstanceId() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
getIsOriginAllowedPredicate() - Method in interface org.pentaho.platform.api.websocket.IWebsocketEndpointConfig
Gets the predicate which evaluates if a origin is allowed for the websocket.
getItemName() - Method in interface org.pentaho.platform.api.engine.IContentGenerator
Get the name of the output content item for this content generator
getJobDescription() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getJobGroup() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getJobName() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getKey() - Method in class org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto
 
getLabels() - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
getLabels() - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
getLastModified() - Method in interface org.pentaho.platform.api.cache.ILastModifiedCacheItem
Get the timestamp of the last time this cache item was modified
getLastModified() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
getLastModified() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getLastModifiedDate() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getLastModifiedDate() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getLastTriggerTime() - Method in interface org.pentaho.platform.api.engine.IScheduledJob
 
getLayoutPriority() - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
getLifecycleDetails() - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent
Returns details related to the current IWorkItemLifecyclePhase
getLifecycleListenerClassname() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns the fully qualified name of the lifecycle listener class defined by this plugin.
getListProperty(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a List property from the Runtime Element
getLoaded() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
getLoaderType() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Indicates what kind of classloader should be used to load classes and resources from this plugin.
getLocale() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Gets the locale of the session.
getLocale() - Method in interface org.pentaho.platform.api.locale.IPentahoLocale
Returns a single Locale object
getLocale() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getLocale() - Method in class org.pentaho.platform.api.repository2.unified.webservices.LocaleMapDto
 
getLocale() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getLocalePropertiesForFile(RepositoryFile, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
getLocalePropertiesForFileById(Serializable, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
getLocalePropertiesForFileByPath(String, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
getLocalePropertiesMap() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getLocalePropertiesMapEntries() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getLocalizedDisplayName(String) - Method in interface org.pentaho.platform.api.engine.IAuthorizationAction
Get the localized display name of action for a specific locale.
getLocation() - Method in interface org.pentaho.platform.api.engine.IPlatformWebResource
Location relative to the root of the server.
getLocation() - Method in class org.pentaho.platform.api.ui.ThemeResource
 
getLockDate() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getLockDate() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getLockMessage() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getLockMessage() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getLockOwner() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getLockOwner() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getLoggingLevel() - Method in interface org.pentaho.platform.api.engine.ILogger
Return the logging level for this Logger.
getLoggingLevel() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getLoggingLevel() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Get the logging level for this SequenceDefinition.
getLoggingLevel() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Get the logging level for this ActionDefinition.
getLoggingLevel() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
getLong() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
getLongParameter(String, long) - Method in interface org.pentaho.platform.api.engine.IParameterProvider
Retrieve the requested parameter as primitive Java type long.
getLongProperty(String, Long) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a Long property from the Runtime Element.
getLongProperty(String, long) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a property from the paramMap as a long using a default value if it doesn't exist in the map
getLoopIndex() - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
getLoopParameter() - Method in interface org.pentaho.platform.api.engine.IActionSequence
If the ActionSequence contains a loop, returns the parameter that the execution should loop on.
getLoopParameter(String) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
getLoopUsingPeek() - Method in interface org.pentaho.platform.api.engine.IActionSequence
If the ActionSequence contains a loop, returns the parameter that the execution should loop on.
getMappedInputName(String) - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document
getMappedOutputName(String) - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document
getMappedResourceName(String) - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the name of the parameter that the passed in name is mapped to in the Action Sequence Document
getMapProperty(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a Map property from the Runtime Element Special implementation note - Null values aren't supported in the Map.
getMask() - Method in interface org.pentaho.platform.api.engine.IPentahoBasicAclEntry
Deprecated.
Access control lists in this package are based on bit masking.
getMask() - Method in interface org.pentaho.platform.api.engine.IPermissionMask
Deprecated.
 
getMaxMessageBytesLength() - Method in interface org.pentaho.platform.api.websocket.IWebsocketEndpointConfig
Gets the maximum message length in bytes.
getMaxMessagePropertyName() - Method in interface org.pentaho.platform.api.websocket.IWebsocketEndpointConfig
Get the maximum message property.
getMessage() - Method in exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryCreateFileException
 
getMessage() - Method in exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryUpdateFileException
 
getMessage() - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
getMessage() - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
getMessages() - Method in interface org.pentaho.platform.api.engine.IActionRequestHandler
As the execution happens, the action handler is responsible for storing a list of all the messages that occur in the case of component failure.
getMessages() - Method in interface org.pentaho.platform.api.engine.IComponent
 
getMessages() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getMetaProviderMap() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
The storage mechanism for a plugin to know what ISolutionFileMetaProvider class should be used for a particular content type.
getMethods() - Method in class org.pentaho.platform.api.engine.RequestMatcherDefinition
Returns the request methods.
getMimeType(String) - Method in interface org.pentaho.platform.api.action.IStreamingAction
Requests the mimetype of the content that the Action will write to the provided stream name.
getMimeType() - Method in interface org.pentaho.platform.api.engine.IActionSequenceResource
Returns the mime type of the resource.
getMimeType() - Method in interface org.pentaho.platform.api.engine.IContentInfo
Deprecated.
Don't Use - this is way too early to know the mime type
getMimeType() - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
getMimeType() - Method in interface org.pentaho.platform.api.engine.IStreamingPojo
Deprecated.
Gets the mimetype of the content that this object will write to the output stream
getMimeType() - Method in interface org.pentaho.platform.api.repository.IContentItem
 
getMimeType() - Method in class org.pentaho.platform.api.repository2.unified.data.simple.SimpleRepositoryFileData
Returns the MIME type of the data in this file.
getMimeType() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
mime-type to be used to resolve an IPlatformImportHandler.
getMimeTypeListener() - Method in interface org.pentaho.platform.api.engine.IOutputHandler
 
getModule() - Method in class org.pentaho.platform.api.ui.ModuleThemeInfo
 
getModuleTheme(String, String) - Method in interface org.pentaho.platform.api.ui.IThemeManager
Returns the named local theme for the given named module or null if either is not found
getModuleThemeInfo(String) - Method in interface org.pentaho.platform.api.ui.IThemeManager
Returns the MoudleThemeInfo object containing all themes for the given module name or null if not found.
getModuleThemes() - Method in interface org.pentaho.platform.api.ui.IThemeResolver
Return a map of ModuleThemeInfo objects keyed by module name.
getModuleThemes() - Method in class org.pentaho.platform.api.ui.ModuleThemeInfo
 
getName() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Get the name, or the key for this ActionParameter.
getName() - Method in interface org.pentaho.platform.api.engine.IActionSequenceResource
Return the xml node name of the resource
getName() - Method in interface org.pentaho.platform.api.engine.IAuthorizationAction
Get the name of the action
getName() - Method in interface org.pentaho.platform.api.engine.IOutputDef
Retrieves the name of the output parameter.
getName() - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Return the name for this factory.
getName() - Method in interface org.pentaho.platform.api.engine.IPentahoPublisher
 
getName() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Gets the name for this session, for example if this is an authenticated HTTP or Portlet session, the name will be the name of the user.
getName() - Method in interface org.pentaho.platform.api.engine.IPermissionRecipient
Deprecated.
 
getName() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoRole
 
getName() - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
getName() - Method in interface org.pentaho.platform.api.mt.ITenant
This method gets the tenant's name.
getName() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
getName() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
getName() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
Optional content name.
getName() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getName() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileSid
 
getName() - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
getName() - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataPropertyDto
 
getName() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getName() - Method in interface org.pentaho.platform.api.scheduler.IJobDetail
 
getName() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getName() - Method in class org.pentaho.platform.api.ui.Theme
 
getNextFireTime() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getNextTriggerTime() - Method in interface org.pentaho.platform.api.engine.IScheduledJob
 
getNode() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
 
getNode(String) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
getNode() - Method in class org.pentaho.platform.api.repository2.unified.data.node.NodeRepositoryFileData
 
getNode() - Method in class org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto
 
getNodes() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
getObject() - Method in interface org.pentaho.platform.api.engine.IPentahoObjectReference
 
getObjectClass() - Method in interface org.pentaho.platform.api.engine.IPentahoObjectReference
Get the declared type of the Object described/supplied by this reference.
getObjectName() - Method in interface org.pentaho.platform.api.engine.IAuditable
Returns the Java class name for this object.
getObjectReference(Class<T>, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
getObjectReference(Class<T>, IPentahoSession, Map<String, String>) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
getObjectReferences(Class<T>, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
getObjectReferences(Class<T>, IPentahoSession, Map<String, String>) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Returns an IPentahoObjectReference for the requested Object containing registered Object Properties.
getOpenUrlPattern() - Method in interface org.pentaho.platform.api.ui.IFileTypePlugin
return the open url pattern.
getOperations() - Method in interface org.pentaho.platform.api.engine.IContentInfo
Returns a list of the operations that are available for this content type
getOriginalParentFolderPath() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getOriginalParentFolderPath() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getOutputContentItem(String, String, String, String) - Method in interface org.pentaho.platform.api.engine.IOutputHandler
Retrieve the ContentItem that describes the output from this request's component execution.
getOutputContentItem(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Interfaces to the current output handler to get the content item that describes the output from this request's component execution.
getOutputContentItem(String, String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Interfaces to the current output handler to get the named content item from this request's component execution.
getOutputContentItems() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Interfaces to the current context to get the content items which was generated
getOutputDefinitions() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns a Map of the output parameters that are defined to this SequenceDefinition.
getOutputDestinationFromContentRef(String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemHelper
 
getOutputItem(String, String, String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Returns an output stream for writing.
getOutputNames() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getOutputParameter(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Returns the named output parameter.
getOutputPreference() - Method in interface org.pentaho.platform.api.engine.IOutputHandler
Gets the output type prefered by the handler.
getOutputPreference() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Gets the output type prefered by the handler.
getOutputs() - Method in interface org.pentaho.platform.api.engine.IProducesRuntimeOutputs
Deprecated.
 
getOutputStream() - Method in interface org.pentaho.platform.api.engine.IOutputDef
Retrieve the OutputStream associated with this output parameter.
getOutputStream(String) - Method in interface org.pentaho.platform.api.repository.IContentItem
The behavior of this method depends upon it's write mode (defined only at construction).
getOverlays() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns a list of overlays for this plug-in
getOverlays() - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns a list of the XUL overlays that are defined by all the plug-ins.
getOverlays() - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
getOwner() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl
 
getOwner() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
getOwner() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getOwnerTenantPath() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getOwnerType() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
getOwnerType() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getParameter(String) - Method in interface org.pentaho.platform.api.engine.IParameterProvider
Gets the named parameter from the provider as it's native type
getParameterManager() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getParameterName() - Method in exception org.pentaho.platform.api.engine.UnresolvedParameterException
 
getParameterNames() - Method in interface org.pentaho.platform.api.engine.IParameterProvider
Return list of all avialable parameter names in this provider
getParameterNames() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
getParameterProviders() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getParameterType(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets the type of the parameter
getParent() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getParentId() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
getParentType() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
getPassword() - Method in interface org.pentaho.platform.api.action.IWorkerNodeCredential
 
getPassword() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
getPassword() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoUser
 
getPath() - Method in interface org.pentaho.platform.api.repository.IContentItem
 
getPath() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
Path which may be used to indicate where a bundle belongs in the repository.
getPath() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getPath() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
getPath() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getPattern() - Method in class org.pentaho.platform.api.engine.RequestMatcherDefinition
Returns the request pattern.
getPentahoObjectFactory() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getPentahoServerName() - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Retrieves the descriptive name of the platform application.
getPentahoSystemAclHelper() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getPentahoSystemHelper() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getPentahoSystemInitializer() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getPermissions(Object) - Method in interface org.pentaho.platform.api.engine.IPermissionMgr
Deprecated.
Returns permission map containing access control entries that are defined directly on this domainInstance.
getPermissions() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAce
 
getPermissions() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
getPerspective() - Method in interface org.pentaho.platform.api.engine.IPluginOperation
Gets the resource perspective to launch for this operation
getPhraseSearchQueryName() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getPhraseSearchQueryName() - Method in interface org.pentaho.platform.api.repository.ISearchable
 
getPluginId() - Method in interface org.pentaho.platform.api.util.IWadlDocumentResource
Gets the pluginId where the SpringResource is being retrieved
getPluginIdForClassLoader(ClassLoader) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Each plugin is loaded on its own classloader, we can use this to find the plugin for which the classloader is serving
getPluginIdForType(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns the plugin (IPlatformPlugin) that handles requests for files of type contentType
getPluginPerspectives() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns a list of perspective objects for this plug-in
getPluginPerspectives() - Method in interface org.pentaho.platform.api.engine.perspective.IPluginPerspectiveManager
 
getPluginRESTPerspectivesForId(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns the Plugin perspectives for a plugin of specific id
getPluginRESTPerspectivesForType(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns the Plugin perspectives for files of type contentType
getPlugins(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPluginProvider
Returns a list of IPlatformPlugins defined by this plugin provider.
getPluginSetting(String, String, String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Retrieves a plugin setting for a given plugin and key.
getPluginSetting(Class<?>, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
Searches for the plugin setting with the specified key.
getPluginSetting(Class<?>, String, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
Searches for the plugin setting with the specified key.
getPluginSetting(ClassLoader, String, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
Searches for the plugin setting with the specified key.
getPostExecuteAuditList() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the list of input and output parameters that will be audited after component execution.
getPreExecuteAuditList() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns the list of input and output parameters that will be audited before component execution.
getPreviousFireTime() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getPrincipleId(ITenant, String) - Method in interface org.pentaho.platform.api.mt.ITenantedPrincipleNameResolver
Constructs a principle ID from tenant and principle name.
getPrincipleName(String) - Method in interface org.pentaho.platform.api.mt.ITenantedPrincipleNameResolver
Extracts the principle name from the principleId.
getProcessId() - Method in interface org.pentaho.platform.api.engine.IAuditable
Return the id for the execution of a given action sequence document.
getProcessId() - Method in interface org.pentaho.platform.api.engine.IComponent
 
getPromptStatus() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Returns the prompt status for this parameter.
getProperties() - Method in interface org.pentaho.platform.api.engine.IConfiguration
 
getProperties() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
getProperties() - Method in class org.pentaho.platform.api.repository2.unified.webservices.LocaleMapDto
 
getProperty(String) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
If there were any other properties set (for example, initParams in the servlet context), this will let you have access to all of those properties that are set.
getProperty(String, String) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
If there were any other properties set (for example, initParams in the servlet context), this will let you have access to all of those properties that are set.
getProperty(String) - Method in interface org.pentaho.platform.api.engine.ISystemConfig
 
getProperty(String) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
getProperty(String) - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
Convenience method for extra properties.
getProtectedRequestMatchers() - Method in class org.pentaho.platform.api.engine.CsrfProtectionDefinition
Returns the collection of request matcher specifications that identify CSRF protected endpoints for this plug-in.
getProvider() - Method in class org.pentaho.platform.api.engine.IServerStatusProvider.Locator
 
getPublicFolderName() - Method in interface org.pentaho.platform.api.repository.IClientRepositoryPathsStrategy
 
getPublicFolderPath() - Method in interface org.pentaho.platform.api.repository.IClientRepositoryPathsStrategy
 
getPublisherList() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemAdminPlugins
 
getPublishersDocument() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemAdminPlugins
 
getRanking() - Method in interface org.pentaho.platform.api.engine.IPentahoObjectReference
Returns the ranking of the reference.
getRecipient() - Method in interface org.pentaho.platform.api.engine.IPentahoBasicAclEntry
Deprecated.
A domain object instance will usually have multiple BasicAclEntrys.
getRecipient() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
getRecipientType() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
getRef() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
getReferrers(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Get a list of RepositoryFiles that reference the RepositoryFile identified by fileId.
getRegExPattern() - Static method in enum org.pentaho.platform.api.repository2.unified.RepositoryRequest.FILES_TYPE_FILTER
 
getRegisteredPlugins() - Method in interface org.pentaho.platform.api.engine.IPluginManager
Lists the ids of available plugins.
getRepositoryFileAclDto() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getRequestContext() - Method in interface org.pentaho.platform.api.engine.IPentahoRequestContextHolderStrategy
Returns the current request context.
getRequiredSecurityActions() - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
getReservedChars() - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns a list of characters which cannot be used in file/folder names.
getResourceAsBytes(Class<? extends Object>, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
Gets a plugin-related resource in the form of an array of bytes.
getResourceAsDocument(IActionSequenceResource) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Gets the named resource as a Document.
getResourceAsStream(Class<?>, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
Gets a plugin-related resource in the form of an InputStream.
getResourceAsStream(ClassLoader, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
Gets a plugin-related resource in the form of an InputStream.
getResourceAsStream() - Method in interface org.pentaho.platform.api.util.IWadlDocumentResource
Gets the InputStream of the referenced SpringResource
getResourceAsString(Class<? extends Object>, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
Gets a plugin-related resource in the form of a String.
getResourceAsString(Class<? extends Object>, String, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
Gets a plugin-related resource in the form of a String.
getResourceAsString(IActionSequenceResource) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Gets the named resource as a String.
getResourceBundle(Class<?>, String) - Method in interface org.pentaho.platform.api.engine.IPluginResourceLoader
Retrieves a localized resource bundle for the plugin represented by pluginClass.
getResourceBundleUri() - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
getResourceDataSource(IActionSequenceResource) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Gets the named resource as a DataSource.
getResourceDefinitions() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the sequence's resource definitions as a Map.
getResourceDefintion(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Gets the named resource definition from the executing action sequence.
getResourceInputStream(IActionSequenceResource) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Gets the named resource as an InputStream.
getResourceNames() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getResources() - Method in class org.pentaho.platform.api.ui.Theme
 
getResultSet() - Method in interface org.pentaho.platform.api.data.IDataComponent
 
getResultType() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the type of the overall result of executing the action sequence document that this SequenceDefinition came from.
getReturnParameters() - Method in interface org.pentaho.platform.api.engine.IParameterManager
Returns a mapping of output parameters and the value and destination.
getRevision() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getRevision() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
getRole(ITenant, String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieves the role with a given name from the specified tenant.
getRoleMembers(ITenant, String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieves the list of users associated to a particular role in a given tenant.
getRoles() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieve all the role from the default tenant
getRoles(ITenant) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieve all the role from the specified tenant.
getRoles(ITenant, boolean) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieve all the roles from the specified tenant.
getRoles() - Method in class org.pentaho.platform.api.engine.security.userroledao.UserRoleInfo
 
getRolesForUser(ITenant, String) - Method in interface org.pentaho.platform.api.engine.IUserRoleListService
Returns all authorities granted for a specified user.
getRootCause() - Method in exception org.pentaho.platform.api.util.PentahoChainedException
Gets the root cause of the exception.
getRootCause() - Method in exception org.pentaho.platform.api.util.PentahoCheckedChainedException
Gets the root cause of the exception.
getRootFolderAbsolutePath() - Method in interface org.pentaho.platform.api.mt.ITenant
The method gets the absolute path to the tenant root folder.
getRootFolderPath() - Method in interface org.pentaho.platform.api.repository.IClientRepositoryPathsStrategy
 
getRuntime(String) - Method in interface org.pentaho.platform.api.engine.IActionRequestHandler
Gets the runtime.
getRuntimeContext() - Method in interface org.pentaho.platform.api.engine.IComponent
 
getSampleBoolean() - Method in class org.pentaho.platform.api.repository2.unified.data.sample.SampleRepositoryFileData
 
getSampleInteger() - Method in class org.pentaho.platform.api.repository2.unified.data.sample.SampleRepositoryFileData
 
getSampleString() - Method in class org.pentaho.platform.api.repository2.unified.data.sample.SampleRepositoryFileData
 
getScheduledAndExecutingBackgroundJobs(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IBackgroundExecution
Gets the list of items scheduled for background execution, and those currently executing
getScript() - Method in interface org.pentaho.platform.api.engine.IConditionalExecution
 
getSearchableColumns() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getSearchableColumns() - Method in interface org.pentaho.platform.api.repository.ISearchable
 
getSearchableTable() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getSearchableTable() - Method in interface org.pentaho.platform.api.repository.ISearchable
 
getSelectionDisplayName() - Method in interface org.pentaho.platform.api.engine.IActionParameter
The display name to use when building a prompt.
getSelectionDisplayName() - Method in interface org.pentaho.platform.api.engine.ISelectionMapper
 
getSelectionNameForValue(String) - Method in interface org.pentaho.platform.api.engine.IActionParameter
When building a parameter prompt page, what is the name of the prompt
getSelectionNameForValue(String) - Method in interface org.pentaho.platform.api.engine.ISelectionMapper
 
getSelectionNameMap() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Deprecated.
Unused in the platform
getSelectionNameMap() - Method in interface org.pentaho.platform.api.engine.ISelectionMapper
 
getSelectionValues() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Deprecated.
Unused in the platform
getSelectionValues() - Method in interface org.pentaho.platform.api.engine.ISelectionMapper
 
getSequenceName() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the document name of the action sequence document that this SequenceDefinition came from.
getServiceBean(String, String) - Method in interface org.pentaho.platform.api.engine.IServiceManager
Returns an instance of a registered servicing object.
getServiceBeanId() - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
getServiceClass() - Method in interface org.pentaho.platform.api.engine.IServiceConfig
Returns the web service bean class
getServiceClass() - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
getServiceConfig(String, String) - Method in interface org.pentaho.platform.api.engine.IServiceManager
Gets the configuration for the requested service.
getServicePlugin(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Deprecated.
This method may not work correctly for plugins in Sugar or later releases, in which a plugin does not provide the URL by which to access the resource. Use IPluginManager.isPublic(String, String) if you want to determine if a particular plugin dir is accessable through the plugin resources REST service.
getServices() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns the list of the webservices defined by this plugin.
getServiceType() - Method in interface org.pentaho.platform.api.engine.IServiceConfig
 
getServletContextPathPropertyName() - Method in interface org.pentaho.platform.api.websocket.IWebsocketEndpointConfig
Get the servlet context path property.
getSession() - Method in interface org.pentaho.platform.api.engine.IComponent
 
getSession() - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
getSession() - Method in interface org.pentaho.platform.api.engine.IOutputHandler
 
getSession() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getSessionId() - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
getSessionType() - Method in interface org.pentaho.platform.api.engine.ISessionStartupAction
 
getSettingName() - Method in interface org.pentaho.platform.api.usersettings.pojo.IUserSetting
 
getSettingValue() - Method in interface org.pentaho.platform.api.usersettings.pojo.IUserSetting
 
getSid() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAce
 
getSmtpHost() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
getSmtpPort() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
getSmtpProtocol() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
getSolution() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
getSolution() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getSolutionId() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
getSolutionName() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the solution name, which is the name at the root level of the solution path.
getSolutionPath(String) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Retrieves the fully qualified path to the location of the Hitachi Vantara solution, appending the path given in the parameter.
getSolutionPath() - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
getSolutionPath() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getSolutionPath() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the path relative to the solution name that will lead to this definition
getSolutionPath() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
getSolutionPath() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
getSolutionRootPath() - Method in interface org.pentaho.platform.api.engine.IApplicationContext
 
getSourceDescription() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
A short description of where this plugin came from, e.g.
getSourceHostIp() - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent
Returns the ip of the host where the event originated.
getSourceHostName() - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent
Returns the hostname of the host where the event originated.
getSourceTimestamp() - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent
Returns the Date when the event occured.
getSourceType() - Method in interface org.pentaho.platform.api.engine.IActionSequenceResource
Get the type of external resource that this ActionResource is derived from.
getStartupActions() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getStaticResource(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Deprecated.
This method may not work correctly for plugins in Sugar or later releases, in which a plugin does not provide the URL by which to access the resource. Use IPluginManager.isPublic(String, String) if you want to determine if a particular plugin dir is accessable through the plugin resources REST service.
getStaticResourceMap() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
Returns a list of static resource paths for this plugin-in
getStatus() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
getStatus() - Method in interface org.pentaho.platform.api.engine.IServerStatusProvider
 
getStatus() - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
 
getStatus() - Method in class org.pentaho.platform.api.engine.ServerStatusProvider
 
getStatusMessages() - Method in interface org.pentaho.platform.api.engine.IServerStatusProvider
 
getStatusMessages() - Method in class org.pentaho.platform.api.engine.ServerStatusProvider
 
getStepDescription() - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
getStepNumber() - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
getStream() - Method in class org.pentaho.platform.api.repository2.unified.data.simple.SimpleRepositoryFileData
Deprecated.
Use SimpleRepositoryFileData.getInputStream() instead. Proguard likes to obfuscate any method named getStream that returns an InputStream, even if you tell it not to via keep rules.
getStreamProvider() - Method in interface org.pentaho.platform.api.action.IActionInvokeStatus
Returns the object representing the stream provider containing the file associated with the given action.
getString() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
getStringArrayParameter(String, String[]) - Method in interface org.pentaho.platform.api.engine.IParameterProvider
Retrieve the requested parameter as a String array
getStringParameter(String, String) - Method in interface org.pentaho.platform.api.engine.IParameterProvider
Retrieve the requested parameter as type java.lang.String
getStringProperty(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a string property from the Runtime Element.
getStringProperty(String, String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Gets a string property from the Runtime Element.
getStringValue() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Get the value for this ActionParameter as type String.
getSubmissionDate() - Method in interface org.pentaho.platform.api.scheduler.IJobDetail
 
getSubProtocolAccepted() - Method in interface org.pentaho.platform.api.websocket.IWebsocketEndpointConfig
Gets the list of sub protocols that this web socket will accept.
getSubscriberId() - Method in interface org.pentaho.platform.api.monitoring.IMonitoringSubscriber
 
getSubscribers() - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEventPublisher
Returns the List of IWorkItemLifecycleEventSubscribers that wish to listen for IWorkItemLifecycleEvents.
getSyncPreference() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Returns boolean value regarding whether this action is set to execute synchronous or asynchronously.
getSystemCfgSourceName() - Method in interface org.pentaho.platform.api.engine.ISystemSettings
Gets the name of the source of the system configurations.
getSystemListeners() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getSystemName() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemHelper
 
getSystemRoles() - Method in interface org.pentaho.platform.api.engine.IUserRoleListService
Returns all system authorities known to the provider.
getSystemSetting(String, String, String) - Method in interface org.pentaho.platform.api.engine.ISystemSettings
Gets a system setting from the system path
getSystemSetting(String, String) - Method in interface org.pentaho.platform.api.engine.ISystemSettings
Gets a system setting from the system configuration file
getSystemSettings(String, String) - Method in interface org.pentaho.platform.api.engine.ISystemSettings
Gets a section from the specified settings document
getSystemSettings(String) - Method in interface org.pentaho.platform.api.engine.ISystemSettings
Gets a section from the system system configuration file
getSystemSettingsDocument(String) - Method in interface org.pentaho.platform.api.engine.ISystemSettings
Returns a Document object containing the settings document within the path specified by actionPath.
getSystemSettingsProperties(String) - Method in interface org.pentaho.platform.api.engine.ISystemSettings
Gets a properties file from the solution.
getSystemSettingsService() - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
getSystemTheme(String) - Method in interface org.pentaho.platform.api.ui.IThemeManager
Returns the named theme or null if not found.
getSystemThemeIds() - Method in interface org.pentaho.platform.api.ui.IThemeManager
Return a list of available system themes.
getSystemThemes() - Method in interface org.pentaho.platform.api.ui.IThemeResolver
Return a map of system themes keyed by theme name.
getSystemThemes() - Method in class org.pentaho.platform.api.ui.ModuleThemeInfo
 
getTemplate(String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IUITemplater
 
getTenant() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoRole
 
getTenant() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoUser
 
getTenant(String) - Method in interface org.pentaho.platform.api.mt.ITenantedPrincipleNameResolver
Extracts the tenant from the principleId.
getTenant(String) - Method in interface org.pentaho.platform.api.mt.ITenantManager
 
getTenantByRootFolderPath(String) - Method in interface org.pentaho.platform.api.mt.ITenantManager
 
getTenantPath() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
getTenantPath() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
getTenantRootFolder(ITenant) - Method in interface org.pentaho.platform.api.mt.ITenantManager
 
getTheme() - Method in class org.pentaho.platform.api.ui.ThemeResource
 
getThemeRootDir() - Method in class org.pentaho.platform.api.ui.Theme
 
getThrowable() - Method in interface org.pentaho.platform.api.action.IActionInvokeStatus
Returns a Throwable instance, if any occurred when the IAction was being invoked.
getTitle() - Method in interface org.pentaho.platform.api.engine.IContentGeneratorInfo
 
getTitle() - Method in interface org.pentaho.platform.api.engine.IContentInfo
The title of this content type as presented to the user Implementors of this interface should provide localization for the title e.g.
getTitle() - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
getTitle() - Method in interface org.pentaho.platform.api.engine.ISequenceDefinition
Returns the title of this SequenceDefinition, if defined, or null otherwise.
getTitle() - Method in interface org.pentaho.platform.api.engine.IServiceConfig
Returns the localized title for this web service.
getTitle() - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
getTitle() - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
getTitle() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
Returns title for current locale or file name if not available.
getTitle() - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
getTitle() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getTree(String, int, String, boolean) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Deprecated.
getTree(RepositoryRequest) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Gets a tree rooted at path.
getTriggerGroup() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getTriggerName() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getTriggerState() - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
getType() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Return the value type as one of the constants available in this class.
getType() - Method in interface org.pentaho.platform.api.engine.IContentGeneratorInfo
 
getType() - Method in interface org.pentaho.platform.api.engine.IOutputDef
Retrieves the type of the output parameter.
getType() - Method in class org.pentaho.platform.api.engine.RequestMatcherDefinition
Returns the type of request matcher.
getType() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
getType() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileSid
 
getType() - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataPropertyDto
 
getTypes() - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
getTypes() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
getUniqueId() - Method in interface org.pentaho.platform.api.engine.IScheduledJob
 
getUrl() - Method in interface org.pentaho.platform.api.engine.IContentGeneratorInfo
Deprecated.
URL is determined by the system
getUrl() - Method in interface org.pentaho.platform.api.engine.IPentahoUrl
 
getUrlFactory() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
The Url Factory is used for building URL's that link to this or another application
getUrlSufix() - Method in interface org.pentaho.platform.api.websocket.IWebsocketEndpointConfig
Get the URL sufix where the websocket will be available.
getUser(ITenant, String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieve the user from a specified tenant of the repository.
getUserHomeFolder(ITenant, String) - Method in interface org.pentaho.platform.api.mt.ITenantManager
Retrieves users home folder.
getUserHomeFolderName(String) - Method in interface org.pentaho.platform.api.repository.IClientRepositoryPathsStrategy
 
getUserHomeFolderPath(String) - Method in interface org.pentaho.platform.api.repository.IClientRepositoryPathsStrategy
 
getUserId() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
getUsername() - Method in interface org.pentaho.platform.api.action.IWorkerNodeCredential
 
getUsername() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoUser
 
getUsername() - Method in interface org.pentaho.platform.api.usersettings.pojo.IUserSetting
 
getUserParameters(String) - Method in interface org.pentaho.platform.api.util.IPdiContentProvider
lists user input parameters for a given a ktr/kjb filePath
getUserRoles(ITenant, String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieves the list of roles associated to a particular user in a given tenant.
getUsers() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieve all the users from the default tenant of a repository.
getUsers(ITenant) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieve all the users from the specified tenant of a repository.
getUsers(ITenant, boolean) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Retrieve all the users from the specified tenant of a repository .
getUsers() - Method in class org.pentaho.platform.api.engine.security.userroledao.UserRoleInfo
 
getUserSetting(String, String, String) - Method in interface org.pentaho.platform.api.usersettings.IAnyUserSettingService
Deprecated.
Gets a particular user setting for a specified username
getUserSetting(String, String) - Method in interface org.pentaho.platform.api.usersettings.IUserSettingService
 
getUserSettings(String) - Method in interface org.pentaho.platform.api.usersettings.IAnyUserSettingService
Deprecated.
Gets a list of all user settings for a specified username
getUserSettings() - Method in interface org.pentaho.platform.api.usersettings.IUserSettingService
 
getUsersInRole(ITenant, String) - Method in interface org.pentaho.platform.api.engine.IUserRoleListService
Returns all known users in the specified role.
getValue() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Get the value for this ActionParameter as a generic Java Object.
getValue() - Method in enum org.pentaho.platform.api.repository2.unified.RepositoryFileSid.Type
 
getValue() - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataPropertyDto
 
getValue() - Method in class org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto
 
getValueAsList() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Get the value for this ActionParameter as a java.util.List.
getValueAsResultSet() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Get the value for this ActionParameter as a IPentahoResultSet
getValueAt(int) - Method in interface org.pentaho.platform.api.engine.ISelectionMapper
 
getVariables() - Method in interface org.pentaho.platform.api.engine.IActionParameter
 
getVersionCommentEnabled() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
getVersionCommentEnabled() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getVersionedFileId() - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
getVersionedFileId() - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
getVersionId() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
getVersionId() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getVersionInformation() - Method in interface org.pentaho.platform.api.util.IVersionHelper
 
getVersionInformation(Class) - Method in interface org.pentaho.platform.api.util.IVersionHelper
 
getVersioningEnabled() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
getVersioningEnabled() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
getVersionSummaries(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns a list of version summary instances.
getVersionSummary(Serializable, Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns a version summary for the given file id and version id.
getVersionSummaryInBatch(List<RepositoryFile>) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns a version summary for every RepositoryFile provided.
getWorkItemDetails() - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent
Returns the work item details.
getWorkItemLifecyclePhase() - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent
Returns the current IWorkItemLifecyclePhase for the work item.
getWorkItemUid() - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEvent
Returns the unique id of a work item.
getXmlContent() - Method in interface org.pentaho.platform.api.ui.IXMLComponent
 
GLOBAL - Static variable in interface org.pentaho.platform.api.engine.ICacheManager
 
globalStartup() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemStartupActions
 
globalStartup(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemStartupActions
 

H

handleActionAsyncRequest() - Method in interface org.pentaho.platform.api.engine.IActionRequestHandler
Executes an action sequence asynchronously.
handleActionRequest(int, int) - Method in interface org.pentaho.platform.api.engine.IActionRequestHandler
Responsible for executing the action using the solution engine.
handleEvent(IWorkItemLifecycleEvent) - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEventSubscriber
Handler for the IWorkItemLifecycleEvent.
handleRequest(OutputStream, IActionRequestHandler, String, HashMap) - Method in interface org.pentaho.platform.api.ui.IUIComponent
 
hasAccess(IPentahoSession, IAclHolder, int) - Method in interface org.pentaho.platform.api.engine.IAclVoter
Deprecated.
Determines whether the user (auth) has the requested authority (mask) based on the list of effective authorities from the holder.
hasAccess(IAclHolder, int, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
Deprecated.
hasAccess(RepositoryFile, RepositoryFilePermission, RepositoryFileAcl, IPentahoSession) - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryAccessVoter
Determines whether the user has access to perform a specific operation on a particular file in the repository.
hasAccess(RepositoryFile, RepositoryFilePermission, RepositoryFileAcl, IPentahoSession) - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryAccessVoterManager
Evaluate if the current caller has access to the perform given operation on the current repository item
hasAccess(String, EnumSet<RepositoryFilePermission>) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Returns true if user has all permissions given.
hasActionResources() - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
 
hasDefaultValue() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Check if this ActionParameter has a default value set.
hasExtension() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
hashCode() - Method in interface org.pentaho.platform.api.engine.IPentahoAclObjectIdentity
Deprecated.
Refer to the java.lang.Object documentation for the interface contract.
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNodeRef
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAce
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileSid
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.webservices.LocaleMapDto
 
hashCode() - Method in class org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto
 
hashCode() - Method in class org.pentaho.platform.api.ui.Theme
 
hasLoop() - Method in interface org.pentaho.platform.api.engine.IActionSequence
Returns whether the ActionSequence has a loop in its definition.
hasNode(String) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
hasParameter(String) - Method in interface org.pentaho.platform.api.engine.IParameterProvider
 
hasProperty(String) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
hasSelections() - Method in interface org.pentaho.platform.api.engine.IActionParameter
 
hasTempFile(String) - Method in interface org.pentaho.platform.api.util.ITempFileDeleter
Returns true if the specified file is being tracked by the deleter
hasText(String) - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
hasUserParameters(String) - Method in interface org.pentaho.platform.api.util.IPdiContentProvider
given a ktr/kjb filePath, looks in its metadata for the existence of user input parameters, required to properly execute
hasValue() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Check to se if a value has been set for this parameter.
hasValue(String) - Method in interface org.pentaho.platform.api.engine.ISelectionMapper
 
hidden(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
HIDDEN_BY_DEFAULT - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
HIDDEN_KEY - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 

I

IAcceptsRuntimeInputs - Interface in org.pentaho.platform.api.engine
Deprecated.
Pojo components are deprecated, use IAction
IAclEntry - Interface in org.pentaho.platform.api.engine
This is a port from spring-security 2.0.8.RELEASE
IAclHolder - Interface in org.pentaho.platform.api.engine
Deprecated.
IAclNodeHelper - Interface in org.pentaho.platform.api.repository2.unified
The interface for operations over ACL nodes.
IAclSolutionFile - Interface in org.pentaho.platform.api.engine
Deprecated.
IAclVoter - Interface in org.pentaho.platform.api.engine
Deprecated.
IAction - Interface in org.pentaho.platform.api.action
Actions are the lightweight alternative to platform components (see IComponent).
IActionAdaptor - Interface in org.pentaho.platform.api.action
This interface will provide a way to create an adaptor between IAction and any orchestration tool like for example Mesos or Kubernetes etc.
IActionCompleteListener - Interface in org.pentaho.platform.api.engine
The listener interface for receiving notification when a Component execution has completed.
IActionInvoker - Interface in org.pentaho.platform.api.action
The purpose of this interface is to provide functionality needed to invoke an IAction instance in a generic fashion.
IActionInvokeStatus - Interface in org.pentaho.platform.api.action
An API for the object representation of action invocation status, allows us to pass back status of action invocation, whether any exceptions occurred during invocation and whether the action needs to be retired.
IActionParameter - Interface in org.pentaho.platform.api.engine
An IActionParameter represents one input or output in an IActionSequence.
IActionRequestHandler - Interface in org.pentaho.platform.api.engine
The basic interface for requests to execute actions .
IActionSequence - Interface in org.pentaho.platform.api.engine
An ActionSequence is the functional object that wraps a SequenceDefinition for processing by the RuntimeContext.
IActionSequenceResource - Interface in org.pentaho.platform.api.engine
The ActionResource interface represents one resource in an ActionSequence.
IAnyUserSettingService - Interface in org.pentaho.platform.api.usersettings
Deprecated.
IApplicationContext - Interface in org.pentaho.platform.api.engine
Defines a set of methods to retrieve information about the application environment.
IAuditable - Interface in org.pentaho.platform.api.engine
Any subsystem that implements the IAuditable interface is candidate for auditing within the platform.
IAuditEntry - Interface in org.pentaho.platform.api.engine
An implementation of the IAuditEntry interface describes the method by which audit messages are recorded and what destination storage they are recorded to.
IAuthenticationRoleMapper - Interface in org.pentaho.platform.api.engine.security
Maps LDAP roles to pentaho security roles using the map defined in the spring configuration file (applicationContext-spring-security-ldap.xml).
IAuthorizationAction - Interface in org.pentaho.platform.api.engine
Represents a Logical Role name used by some IAuthorizationPolicy implementations.
IAuthorizationPolicy - Interface in org.pentaho.platform.api.engine
An access control policy.
IBackgroundExecution - Interface in org.pentaho.platform.api.engine
 
IBackingRepositoryLifecycleManager - Interface in org.pentaho.platform.api.repository2.unified
Allows external code to do initialization work on the backing repository at certain lifecycle milestones.
ICacheExpirationRegistry - Interface in org.pentaho.platform.api.cache
This interface defines the API for a registry of ILastModifiedCacheItem's.
ICacheManager - Interface in org.pentaho.platform.api.engine
 
IClientRepositoryPathsStrategy - Interface in org.pentaho.platform.api.repository
 
IComponent - Interface in org.pentaho.platform.api.engine
A Component is the smallest module in the platform architecture and represents a unit of work, or an action to be performed.
IConditionalExecution - Interface in org.pentaho.platform.api.engine
This interface supports conditional execution of action sequence 'actions' blocks
IConfiguration - Interface in org.pentaho.platform.api.engine
User: nbaker Date: 4/2/13
IConfiguredPojo - Interface in org.pentaho.platform.api.engine
Deprecated.
Pojo components are deprecated, use IAction
IConnectionUserRoleMapper - Interface in org.pentaho.platform.api.engine
This interface provides for mapping a Platform user to a connection user, or a users' roles to known/valid roles for a connection.
IContentGenerator - Interface in org.pentaho.platform.api.engine
This interface is implemented by bi-platform plugins, and is instantiated for each content request made to the plugin system via the IPluginManager API.
IContentGeneratorInfo - Interface in org.pentaho.platform.api.engine
This should only be used internally by the plugin manager
IContentGeneratorInvoker - Interface in org.pentaho.platform.api.engine
 
IContentInfo - Interface in org.pentaho.platform.api.engine
Describes a content type.
IContentItem - Interface in org.pentaho.platform.api.repository
Construction of a new ContentItem is managed by ContentLocation.newContentItem.
IContentListener - Interface in org.pentaho.platform.api.engine
 
IContentOutputHandler - Interface in org.pentaho.platform.api.engine
Interface for a class used to stream contents from a Hitachi Vantara action sequence to a destination of some kind, e.g.
ICreateFeedbackParameterCallback - Interface in org.pentaho.platform.api.engine
 
id(Serializable) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
id(Serializable) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 
IDataComponent - Interface in org.pentaho.platform.api.data
The data component interface extends component, and adds a single method - getResultSet().
IDatasourceMgmtService - Interface in org.pentaho.platform.api.repository.datasource
Service to manage JDBC datasources in the platform.
IDATASOURCEMGMTSERVICE - Static variable in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
 
IDBDATASOURCE_SERVICE - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
IDBDatasourceService - Interface in org.pentaho.platform.api.data
This interface defines Pentaho's DatasourceService API.
IDefinitionAwareAction - Interface in org.pentaho.platform.api.action
Makes an Action privy to certain details about the action definition that is responsible for executing it.
IDocumentResourceLoader - Interface in org.pentaho.platform.api.engine
 
IEmailConfiguration - Interface in org.pentaho.platform.api.email
 
IEmailService - Interface in org.pentaho.platform.api.email
The Email Service used in the Pentaho Platform
IExecutionListener - Interface in org.pentaho.platform.api.engine
 
IFileFilter - Interface in org.pentaho.platform.api.engine
 
IFileFilter - Interface in org.pentaho.platform.api.repository2.unified
 
IFileInfo - Interface in org.pentaho.platform.api.engine
 
IFileTypePlugin - Interface in org.pentaho.platform.api.ui
This interface defines a file type plugin, which specifies the behavior for viewing and editing specific file types
IFileVersioningConfiguration - Interface in org.pentaho.platform.api.repository2.unified
Represents versioning information about a repository file.
IJndiDatasourceService - Interface in org.pentaho.platform.api.data
This interface defines Pentaho's ExtendedDatasourceService API.
IJobDetail - Interface in org.pentaho.platform.api.scheduler
 
IJobSchedule - Interface in org.pentaho.platform.api.scheduler
 
ILastModifiedCacheItem - Interface in org.pentaho.platform.api.cache
API for cached items that contain a last modified timestamp
ILoggablePojo - Interface in org.pentaho.platform.api.engine
Deprecated.
Pojo components are deprecated, use IAction
ILogger - Interface in org.pentaho.platform.api.engine
The Logger is the main interface into the platform's logging subsystem.
ILoggingAction - Interface in org.pentaho.platform.api.action
The interface for an Action that wants to be provided with a logger.
ILogoutListener - Interface in org.pentaho.platform.api.engine
 
IMessageFormatter - Interface in org.pentaho.platform.api.engine
 
IMimeType - Interface in org.pentaho.platform.api.mimetype
 
IMimeTypeListener - Interface in org.pentaho.platform.api.engine
 
IMonitoringEvent - Interface in org.pentaho.platform.api.monitoring
top-most signature for any event being published to monitoring's event bus
IMonitoringService - Interface in org.pentaho.platform.api.monitoring
 
IMonitoringSubscriber - Interface in org.pentaho.platform.api.monitoring
top-most signature for any event handler being subscribed onto monitoring's event bus
INFO - Static variable in interface org.pentaho.platform.api.engine.ILogger
The INFO level designates informational messages that highlight the progress of the application at coarse-grained level.
info(String) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message object with the INFO Level.
info(String, Throwable) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message with the INFO level including the stack trace of the Throwable error passed as parameter.
init() - Method in interface org.pentaho.platform.api.engine.IComponent
Initialize the Component.
init(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoInitializer
Simplifier for initialization of objects from the PentahoSystem object
init(String, Object) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Initialize the factory with optional configuration file and runtime context.
init(IApplicationContext, Map) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemInitializer
 
init() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
 
init() - Method in interface org.pentaho.platform.api.engine.IPluginLifecycleListener
Called just prior to the plugin being registered with the platform.
init(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
Initialize the SolutionEngine.
INITIAL_SIZE - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
initServices() - Method in interface org.pentaho.platform.api.engine.IServiceManager
Activates the services that have been registered with the service manager.
INSTANCE_LOG - Static variable in interface org.pentaho.platform.api.engine.ILogger
 
internalAddNode(DataNode) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
InvalidParameterException - Exception in org.pentaho.platform.api.engine
This exception just signals that an exception occurred initializing parameters for an adcion-definition
InvalidParameterException() - Constructor for exception org.pentaho.platform.api.engine.InvalidParameterException
 
InvalidParameterException(String) - Constructor for exception org.pentaho.platform.api.engine.InvalidParameterException
 
invokeAction(IAction, String, Map<String, Serializable>) - Method in interface org.pentaho.platform.api.action.IActionInvoker
Invokes the IAction action.
invokeEntryPoints() - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Invokes all entry point handlers.
invokeExitPoints() - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Invokes all exit point handlers.
invokeLogoutListeners(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemListeners
 
IObjectCreator<T> - Interface in org.pentaho.platform.api.engine
A simple creator interface.
IOutputDef - Interface in org.pentaho.platform.api.engine
An OutputDef represents one output parameter in a SequenceDefinition or ActionDefinition.
IOutputHandler - Interface in org.pentaho.platform.api.engine
An OutputHandler manages the content generated from a Component execution.
IParameterManager - Interface in org.pentaho.platform.api.engine
 
IParameterProvider - Interface in org.pentaho.platform.api.engine
A ParameterProvider is a source for input, output or resource parameters for a given action.
IParameterResolver - Interface in org.pentaho.platform.api.engine
 
IParameterSetter - Interface in org.pentaho.platform.api.engine
Augments the parameter provider by adding settings for the parameters.
IPASSWORD_SERVICE - Static variable in interface org.pentaho.platform.api.util.IPasswordService
 
IPasswordService - Interface in org.pentaho.platform.api.util
 
IPdiContentProvider - Interface in org.pentaho.platform.api.util
 
IPentahoAclEntry - Interface in org.pentaho.platform.api.engine
Deprecated.
IPentahoAclObjectIdentity - Interface in org.pentaho.platform.api.engine
Deprecated.
IPentahoBasicAclEntry - Interface in org.pentaho.platform.api.engine
Deprecated.
IPentahoDefinableObjectFactory - Interface in org.pentaho.platform.api.engine
Deprecated.
Use the new IPentahoRegistrableObjectFactory facilities available in PentahoSystem
IPentahoDefinableObjectFactory.Scope - Enum in org.pentaho.platform.api.engine
Deprecated.
The different object scopes that are supported
IPentahoInitializer - Interface in org.pentaho.platform.api.engine
 
IPentahoJCRPrivilege - Interface in org.pentaho.platform.api.repository2.unified
 
IPentahoLocale - Interface in org.pentaho.platform.api.locale
 
IPentahoObjectFactory - Interface in org.pentaho.platform.api.engine
The way the BI platform creates and manages system objects.
IPentahoObjectReference<T> - Interface in org.pentaho.platform.api.engine
User: nbaker Date: 1/16/13

IPentahoObjectReference objects represent a pointer to an available object in the IPentahoObjectFactory and contains all attributes associated with that object (priority, adhoc attributes).

IPentahoObjectRegistration - Interface in org.pentaho.platform.api.engine
A handle for a registered IPentahoObjectReference allowing the removal from the registered IPentahoRegistrableObjectFactory

Created by nbaker on 4/18/14.

IPentahoPublisher - Interface in org.pentaho.platform.api.engine
Defines the interface for getting objects published in the platform.
IPentahoRegistrableObjectFactory - Interface in org.pentaho.platform.api.engine
Supports the registration of new implementations with the IPentahoObjectFactory at runtime.
IPentahoRegistrableObjectFactory.Types - Enum in org.pentaho.platform.api.engine
The types that the Object instance or IPentahoObjectReference can be registered under.
IPentahoRequestContext - Interface in org.pentaho.platform.api.engine
Manages Hitachi Vantara Request Context
IPentahoRequestContextHolderStrategy - Interface in org.pentaho.platform.api.engine
A strategy for storing an IPentahoRequestContext against a thread.
IPentahoRole - Interface in org.pentaho.platform.api.engine.security.userroledao
A role in the Pentaho platform.
IPentahoSession - Interface in org.pentaho.platform.api.engine
Provides an overall representation of the concept of a session.
IPentahoSystem - Interface in org.pentaho.platform.api.engine
 
IPentahoSystemAclHelper - Interface in org.pentaho.platform.api.engine
 
IPentahoSystemAdminPlugins - Interface in org.pentaho.platform.api.engine
 
IPentahoSystemEntryPoint - Interface in org.pentaho.platform.api.engine
System Entry Point implementors get called upon entry to the system after they've been registered with the ApplicationContext (IApplicationContext).
IPentahoSystemExitPoint - Interface in org.pentaho.platform.api.engine
System Exit Point implementors are called with the action on a thread completes.
IPentahoSystemHelper - Interface in org.pentaho.platform.api.engine
 
IPentahoSystemInitializer - Interface in org.pentaho.platform.api.engine
 
IPentahoSystemListener - Interface in org.pentaho.platform.api.engine
Classes that implement this interface can be notified about key system events, in order to perform one-time operations such as initialization, maintenance or other tasks.
IPentahoSystemListeners - Interface in org.pentaho.platform.api.engine
 
IPentahoSystemStartupActions - Interface in org.pentaho.platform.api.engine
 
IPentahoUrl - Interface in org.pentaho.platform.api.engine
Provides a simple interface for Portlet URL's (PortletURL objects).
IPentahoUrlFactory - Interface in org.pentaho.platform.api.engine
Provides an interface around getting a URL object which can be used to construct a URL managing the parameters that need to be built up.
IPentahoUser - Interface in org.pentaho.platform.api.engine.security.userroledao
A user of the Pentaho platform.
IPermissionMask - Interface in org.pentaho.platform.api.engine
Deprecated.
IPermissionMgr - Interface in org.pentaho.platform.api.engine
Deprecated.
IPermissionRecipient - Interface in org.pentaho.platform.api.engine
Deprecated.
IPlatformImportBundle - Interface in org.pentaho.platform.api.repository2.unified
A struct-like object for bundling related objects together for import into the platform.
IPlatformMimeResolver - Interface in org.pentaho.platform.api.mimetype
Implementations of this class compute mime-types based on the given IPlatformImportBundle.
IPlatformPlugin - Interface in org.pentaho.platform.api.engine
This interface represents the contract for the specification of a plugin.
IPlatformPlugin.ClassLoaderType - Enum in org.pentaho.platform.api.engine
 
IPlatformPluginCsrfProtection - Interface in org.pentaho.platform.api.engine
This interface represents an extension to the contract of a plugin containing CSRF protection information.
IPlatformReadyListener - Interface in org.pentaho.platform.api.engine
This interface is meant to augment IPluginLifecycleListener.
IPlatformWebResource - Interface in org.pentaho.platform.api.engine
Simple interface representing a Web Resource Created by nbaker on 9/8/16.
IPluginLifecycleListener - Interface in org.pentaho.platform.api.engine
This interface provides entry points to the plugin manager for plugin loading, and unloading.
IPluginManager - Interface in org.pentaho.platform.api.engine
The contract API between the platform and BIServer plugins.
IPluginManagerListener - Interface in org.pentaho.platform.api.engine
A sinple listener for the IPluginManager.
IPluginOperation - Interface in org.pentaho.platform.api.engine
 
IPluginPerspective - Interface in org.pentaho.platform.api.engine.perspective.pojo
 
IPluginPerspectiveManager - Interface in org.pentaho.platform.api.engine.perspective
 
IPluginProvider - Interface in org.pentaho.platform.api.engine
A plugin provider is responsible for serving up IPlatformPlugins to whoever is asking, typically IPluginManager.
IPluginResourceLoader - Interface in org.pentaho.platform.api.engine
This class presents an abstraction layer for accessing resources from within a platform plugin.
IPooledDatasourceService - Interface in org.pentaho.platform.api.data
This interface defines Pentaho's ExtendedDatasourceService API.
IPostProcessingAction - Interface in org.pentaho.platform.api.action
The interface for Actions that allows caller get information from Action
IPreparedComponent - Interface in org.pentaho.platform.api.data
The prepared component interface extends component, allowing components to go into a prepared state vs.
IPreProcessingAction - Interface in org.pentaho.platform.api.action
Allows an Action to do some preliminary work prior to execution.
IProducesRuntimeOutputs - Interface in org.pentaho.platform.api.engine
Deprecated.
Pojo components are deprecated, use IAction
IRepositoryAccessVoter - Interface in org.pentaho.platform.api.repository2.unified
Repository voter to add custom security to the repository.
IRepositoryAccessVoterManager - Interface in org.pentaho.platform.api.repository2.unified
Repository voter manager to store list of repository access voters
IRepositoryContentConverterHandler - Interface in org.pentaho.platform.api.repository2.unified
Repository Content Converter Handler manages the repository content converter in the platform
IRepositoryDefaultAclHandler - Interface in org.pentaho.platform.api.repository2.unified
Supply the default ACL intended to be used when none exist
IRepositoryFile - Interface in org.pentaho.platform.api.repository
 
IRepositoryFileData - Interface in org.pentaho.platform.api.repository2.unified
The data or payload of a RepositoryFile.
IRepositoryVersionManager - Interface in org.pentaho.platform.api.repository2.unified
 
IRuntimeContext - Interface in org.pentaho.platform.api.engine
This interface defines methods and constants that are used during action execution to resolve parameters, inputs and outputs, resources, and persist the runtime data.
IRuntimeElement - Interface in org.pentaho.platform.api.repository
 
IRuntimeRepository - Interface in org.pentaho.platform.api.repository
 
isAclNode() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
isAclNode() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
isAclOnlyChange() - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
isAclOnlyChange() - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
isAllowed(String) - Method in interface org.pentaho.platform.api.engine.IAuthorizationPolicy
Returns true if the the action should be allowed.
isApplyAclSettings() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
 
isAuthenticate() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
isAuthenticated() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Gets whether the session is known to be authenticated or not.
isBeanRegistered(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns true if a bean with id beanId has been registered with the plugin manager, i.e.
isCanEdit() - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
isCanSchedule() - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
IScheduledJob - Interface in org.pentaho.platform.api.engine
 
isCsrfProtectionEnabled(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Gets a value that indicates if CSRF protection is enabled for the system and a given plugin.
isDebug() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
isDefaultValue() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Check to see if the value returned from thisActionParameter is indeed the default value instead of a value that was set.
isDirectory() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
isDirectory() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
ISearchable - Interface in org.pentaho.platform.api.repository
 
ISecurityHelper - Interface in org.pentaho.platform.api.engine
Interface for a utility class with several methods that are used to either bind the Authentication to the IPentahoSession, retrieve the Authentication from the IPentahoSession, and other various helper functions.
ISelectionMapper - Interface in org.pentaho.platform.api.engine
 
isEnabled() - Method in interface org.pentaho.platform.api.engine.IServiceConfig
Returns the enabled state of this service
isEnabled() - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoUser
 
isEnabled() - Method in interface org.pentaho.platform.api.mt.ITenant
The method validates whether the tenant is enabled or not.
isEntriesInheriting() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl
 
isEntriesInheriting() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
ISequenceDefinition - Interface in org.pentaho.platform.api.engine
The SequenceDefinition represents the definition of several consecutive action definitions that comprise an ActionSequence object, which is the runtime equivalent of an action sequence document.
IServerStatusChangeListener - Interface in org.pentaho.platform.api.engine
This is a listener for the IServerStatusProvider which should call onStatusChange whenever the values of the ServerStatus or status message change value.
IServerStatusProvider - Interface in org.pentaho.platform.api.engine
Provides a facility that reports the current status of the server.
IServerStatusProvider.Locator - Class in org.pentaho.platform.api.engine
 
IServerStatusProvider.ServerStatus - Enum in org.pentaho.platform.api.engine
 
IServiceConfig - Interface in org.pentaho.platform.api.engine
The configuration spec for a platform managed service
IServiceManager - Interface in org.pentaho.platform.api.engine
A service manager allows a POJO to be exposed as various types of services by constructing a simple ServiceConfig and calling #registerService(ServiceConfig).
ISessionAwareAction - Interface in org.pentaho.platform.api.action
The interface for an Action that wants to be provided with a session.
ISessionContainer - Interface in org.pentaho.platform.api.engine
A "something" that refers to a session.
ISessionStartupAction - Interface in org.pentaho.platform.api.engine
 
isExecutionSuccessful() - Method in interface org.pentaho.platform.api.action.IAction
Provide the execution status of last Action.
isExecutionSuccessful() - Method in interface org.pentaho.platform.api.action.IActionInvokeStatus
Return the success/failure of the execution.
isFolder() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
isFolder() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
isFromPlugin() - Method in interface org.pentaho.platform.api.util.IWadlDocumentResource
Identifies if the resource we are fetching is from a plugin or not
isGranted(IPentahoSession, GrantedAuthority) - Method in interface org.pentaho.platform.api.engine.IAclVoter
Deprecated.
Returns true if the user is a member of the specified role
isGranted(IPentahoSession, GrantedAuthority) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
Utility method that communicates with the installed ACLVoter to determine whether a particular role is granted to the specified user.
isHidden() - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
isHidden() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
isHidden() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
isHidden() - Method in class org.pentaho.platform.api.ui.Theme
 
ISimplePojoComponent - Interface in org.pentaho.platform.api.engine
Deprecated.
Pojo components are deprecated, use IAction
isIncludeAcls() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
isIncludeSystemFolders() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
isList() - Method in interface org.pentaho.platform.api.engine.IOutputDef
Determine whether the value associated with this parameter is a list or not.
isLocale() - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
isLocked() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
isLocked() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
isModifiable() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
isNotSchedulable() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
isNull() - Method in interface org.pentaho.platform.api.engine.IActionParameter
Check to see if the value (includes the default value) is null.
ISolutionActionDefinition - Interface in org.pentaho.platform.api.engine
The ActionDefinition represents the definition and metadata for a single action execution, which is equivalent to one execution of any given Component.
ISolutionAttributeContributor - Interface in org.pentaho.platform.api.engine
 
ISolutionEngine - Interface in org.pentaho.platform.api.engine
The Solution Engine handles loading and launching execution of solutions and action sequences.
ISolutionFile - Interface in org.pentaho.platform.api.engine
A solution file is an abstract represention of either a file or a directory.
ISolutionFilter - Interface in org.pentaho.platform.api.engine
 
ISourcesStreamEvents - Interface in org.pentaho.platform.api.repository2.unified
 
isOutputParameter() - Method in interface org.pentaho.platform.api.engine.IActionParameter
 
isOverwriteAclSettings() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
 
isPentahoAdministrator(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IAclVoter
Deprecated.
Determines whether the user is a super-manager of Hitachi Vantara.
isPentahoAdministrator(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.ISecurityHelper
Deprecated.
use SystemUtils.canAdminister() instead
isPermitted(int) - Method in interface org.pentaho.platform.api.engine.IPentahoBasicAclEntry
Deprecated.
Determine if the mask of this entry includes this permission or not
isPreserveDsw() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
Preserve DSW OLAP model data
isPromptPending() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Tells if a component is waiting for a prompt
isPublic(String, String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns true if the resource specified by path is publicly available, meaning this resource can be accessed by HTTP GET requests
isResponseExpected() - Method in interface org.pentaho.platform.api.engine.IOutputHandler
Indicates whether or not the handler is expected to have data written to a response output stream managed by the handler.
isRetainOwnership() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
 
isRoot() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
isRoot() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
isSchedulable() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
isShowHidden() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
isSmtpQuitWait() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
isStaticResource(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Deprecated.
This method may not work correctly for plugins in Sugar or later releases, in which a plugin does not provide the URL by which to access the resource. Use IPluginManager.isPublic(String, String) if you want to determine if a particular plugin dir is accessable through the plugin resources REST service.
isSubTenant(ITenant, ITenant) - Method in interface org.pentaho.platform.api.mt.ITenantManager
 
isSupportedAction(IAction) - Method in interface org.pentaho.platform.api.action.IActionInvoker
Predicate that tells whether an IActionInvoker can handle a given IAction
isSupportedContent(String) - Method in interface org.pentaho.platform.api.engine.IContentGeneratorInvoker
Predicate that answers whether the related IContentGenerator is able to support the content identified by a contentTypeId contentTypeId is usually the aggregation of a content type ( such as ktr, prpt, ...
IStreamingAction - Interface in org.pentaho.platform.api.action
The interface for Actions that want to stream content to the caller.
IStreamingPojo - Interface in org.pentaho.platform.api.engine
Deprecated.
Pojo components are deprecated, use IAction
IStreamingPojoComponent - Interface in org.pentaho.platform.api.engine
 
IStreamListener - Interface in org.pentaho.platform.api.repository2.unified
 
IStreamProcessingAction - Interface in org.pentaho.platform.api.action
The interface for Actions that want to process the contents of a stream provided by the caller.
isUseSsl() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
isUseStartTls() - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
isValid() - Method in interface org.pentaho.platform.api.email.IEmailService
 
isValid(String) - Method in interface org.pentaho.platform.api.mt.ITenantedPrincipleNameResolver
Returns flag indicating that principleId is a valid tenanted string.
isVersionCommentEnabled() - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
isVersionCommentEnabled() - Method in interface org.pentaho.platform.api.repository2.unified.IFileVersioningConfiguration
True if the UI should prompt for a version comment when the file is created/saved.
isVersionCommentEnabled(String) - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryVersionManager
 
isVersioned() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
isVersioned() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
isVersionEnabled() - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
isVersioningEnabled() - Method in interface org.pentaho.platform.api.repository2.unified.IFileVersioningConfiguration
True if new versions should be created when saved.
isVersioningEnabled(String) - Method in interface org.pentaho.platform.api.repository2.unified.IRepositoryVersionManager
 
ISystemConfig - Interface in org.pentaho.platform.api.engine
User: nbaker Date: 4/2/13
ISystemSettings - Interface in org.pentaho.platform.api.engine
The SystemSettings manages the platform's overall configuration settings.
ITempFileDeleter - Interface in org.pentaho.platform.api.util
 
ITenant - Interface in org.pentaho.platform.api.mt
A tenant of the Pentaho platform.
ITenantedPrincipleNameResolver - Interface in org.pentaho.platform.api.mt
Utility to go between principal IDs (user/role IDs) and principal name and tenant.
ITenantManager - Interface in org.pentaho.platform.api.mt
 
IThemeManager - Interface in org.pentaho.platform.api.ui
Class responsible for collecting information about all available system module local themes.
IThemeResolver - Interface in org.pentaho.platform.api.ui
Theme Resolvers provide information on available themes and their resources.
IUIComponent - Interface in org.pentaho.platform.api.ui
 
IUITemplater - Interface in org.pentaho.platform.api.engine
 
IUnifiedRepository - Interface in org.pentaho.platform.api.repository2.unified
Entry point into the unified repository.
IUserRoleDao - Interface in org.pentaho.platform.api.engine.security.userroledao
Contract for data access objects that read and write users and roles.
IUserRoleListService - Interface in org.pentaho.platform.api.engine
 
IUserSetting - Interface in org.pentaho.platform.api.usersettings.pojo
 
IUserSettingService - Interface in org.pentaho.platform.api.usersettings
 
IVarArgsAction - Interface in org.pentaho.platform.api.action
Allows an Action to accept inputs from the action sequence that are unspecified by the Action itself.
IVariableSerializer - Interface in org.pentaho.platform.api.monitoring.snmp
Created by nbaker on 9/3/14.
IVariableSerializer.BasicSerializer - Class in org.pentaho.platform.api.monitoring.snmp
 
IVersionHelper - Interface in org.pentaho.platform.api.util
 
IWadlDocumentResource - Interface in org.pentaho.platform.api.util
Exposes a SpringResource Interface to access wadl extension files
IWebsocketEndpointConfig - Interface in org.pentaho.platform.api.websocket
 
IWorkerNodeCredential - Interface in org.pentaho.platform.api.action
Interface that provide the access to user credentials
IWorkItemLifecycleEvent - Interface in org.pentaho.platform.api.workitem
Encapsulates all information pertaining to a "work item" at a specific point in its lifecycle.
IWorkItemLifecycleEventPublisher - Interface in org.pentaho.platform.api.workitem
Responsible for publishing IWorkItemLifecycleEvents.
IWorkItemLifecycleEventSubscriber - Interface in org.pentaho.platform.api.workitem
A common interface for components wishing to listen for IWorkItemLifecycleEvents.
IWorkItemLifecyclePhase - Interface in org.pentaho.platform.api.workitem
A common interface for work item lifecycle phases.
IXMLComponent - Interface in org.pentaho.platform.api.ui
 

J

JDBC_DATASOURCE - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
JDBC_POOL - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 

K

keepFile(ISolutionFile, int) - Method in interface org.pentaho.platform.api.engine.ISolutionFilter
 
killSessionCache(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Removes any session-based data for the specified IPentahoSession.
killSessionCaches() - Method in interface org.pentaho.platform.api.engine.ICacheManager
Removes all cached items that are session-based.

L

lastModificationDate(Date) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
listConfigurations() - Method in interface org.pentaho.platform.api.engine.ISystemConfig
 
listFiles() - Method in interface org.pentaho.platform.api.engine.ISolutionFile
If this is a directory, will list all children files/directories for hierarchical navigation.
listFiles(IFileFilter) - Method in interface org.pentaho.platform.api.engine.ISolutionFile
 
listFiles(IFileFilter) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
listFiles() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
listRepositoryFiles() - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
loadClass(String) - Method in interface org.pentaho.platform.api.engine.IPluginManager
Returns a loaded class for the bean registered as beanId.
loaded(IRuntimeContext) - Method in interface org.pentaho.platform.api.engine.IExecutionListener
 
loaded() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
 
loaded() - Method in interface org.pentaho.platform.api.engine.IPluginLifecycleListener
Called after the plugin has been registered with the platform, i.e.
loadElementById(String, Collection) - Method in interface org.pentaho.platform.api.repository.IRuntimeRepository
Loads a runtimeElement by it's ID.
loadXsl(String) - Method in interface org.pentaho.platform.api.engine.IDocumentResourceLoader
 
locale(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
LocaleMapDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
LocaleMapDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.LocaleMapDto
 
LocaleMapDto(String, List<StringKeyStringValueDto>) - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.LocaleMapDto
 
localeProperties(String, Properties) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
localePropertiesMap(Map<String, Properties>) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
LOCATOR - Static variable in interface org.pentaho.platform.api.engine.IServerStatusProvider
 
Locator() - Constructor for class org.pentaho.platform.api.engine.IServerStatusProvider.Locator
 
lockDate(Date) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
locked(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
lockFile(Serializable, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Locks a file.
lockMessage(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
lockOwner(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
LOG_ABANDONED - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
loop(IRuntimeContext, long) - Method in interface org.pentaho.platform.api.engine.IExecutionListener
 

M

mapConnectionRoles(IPentahoSession, String) - Method in interface org.pentaho.platform.api.engine.IConnectionUserRoleMapper
Provides a mapping from the roles defined for a user, and roles appropriate for the connection Rules: - If the user has no rights to the specified connectionContextName, you must throw PentahoAccessControlException - If null or empty array is returned, then no mapping is required, and connection can use defaults
mapConnectionUser(IPentahoSession, String) - Method in interface org.pentaho.platform.api.engine.IConnectionUserRoleMapper
Maps the user from the given IPentahoSession into a user (or credential) appropriate for the connection Rules: - If the user has no rights to the specified connectionContextName, you must throw PentahoAccessControlException - If null or empty array is returned, then no mapping is required, and connection can use defaults
MAX_ACTIVE_KEY - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
MAX_IDLE_KEY - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
MAX_OPEN_PREPARED_STATEMENTS - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
MAX_WAIT_KEY - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
MIN_IDLE_KEY - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
ModuleThemeInfo - Class in org.pentaho.platform.api.ui
ModuleThemeInfo holds theme information for a platform module such as a plugin or other area.
ModuleThemeInfo(String) - Constructor for class org.pentaho.platform.api.ui.ModuleThemeInfo
Constructs a new ModuleThemeInfo object parented to the given ThemeModule
MondrianSchemaAnnotator - Interface in org.pentaho.platform.api.repository2.unified
Provides interface for applying model annotations to a Mondrian schema.
moveFile(Serializable, String, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Moves and/or renames file.

N

name(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
newRuntimeElement(String, String, boolean) - Method in interface org.pentaho.platform.api.repository.IRuntimeRepository
Constructs a new Runtime Element.
newRuntimeElement(String, String, String, boolean) - Method in interface org.pentaho.platform.api.repository.IRuntimeRepository
Constructs a new Runtime Element.
newTenant(ITenant) - Method in interface org.pentaho.platform.api.repository2.unified.IBackingRepositoryLifecycleManager
To be called before any users belonging to a particular tenant interact with the backing repository.
newTenant() - Method in interface org.pentaho.platform.api.repository2.unified.IBackingRepositoryLifecycleManager
To be called before any users belonging to the current tenant interact with the backing repository.
newUser(ITenant, String) - Method in interface org.pentaho.platform.api.repository2.unified.IBackingRepositoryLifecycleManager
To be called before user indicated by username interacts with the backing repository.
newUser() - Method in interface org.pentaho.platform.api.repository2.unified.IBackingRepositoryLifecycleManager
To be called before current user interacts with the backing repository.
NODE_CONTENT_TYPE - Static variable in interface org.pentaho.platform.api.repository2.unified.IRepositoryFileData
 
NodeRepositoryFileData - Class in org.pentaho.platform.api.repository2.unified.data.node
 
NodeRepositoryFileData(DataNode) - Constructor for class org.pentaho.platform.api.repository2.unified.data.node.NodeRepositoryFileData
 
NodeRepositoryFileData(DataNode, long) - Constructor for class org.pentaho.platform.api.repository2.unified.data.node.NodeRepositoryFileData
 
NodeRepositoryFileDataDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
NodeRepositoryFileDataDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto
 
NonExistingDatasourceException - Exception in org.pentaho.platform.api.repository.datasource
 
NonExistingDatasourceException() - Constructor for exception org.pentaho.platform.api.repository.datasource.NonExistingDatasourceException
 
NonExistingDatasourceException(String) - Constructor for exception org.pentaho.platform.api.repository.datasource.NonExistingDatasourceException
 
NonExistingDatasourceException(Throwable) - Constructor for exception org.pentaho.platform.api.repository.datasource.NonExistingDatasourceException
 
NonExistingDatasourceException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository.datasource.NonExistingDatasourceException
 
NotFoundException - Exception in org.pentaho.platform.api.engine.security.userroledao
Thrown when no object exists with the given identifier.
NotFoundException(String) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.NotFoundException
 
NotFoundException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.NotFoundException
 
notifySystemListenersOfStartup() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemListeners
 

O

objectDefined(String) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Checks if the implementation for the given interface is defined.
objectDefined(Class<?>) - Method in interface org.pentaho.platform.api.engine.IPentahoObjectFactory
Checks if the implementation for the given interface is defined.
ObjectFactoryException - Exception in org.pentaho.platform.api.engine
 
ObjectFactoryException() - Constructor for exception org.pentaho.platform.api.engine.ObjectFactoryException
 
ObjectFactoryException(String) - Constructor for exception org.pentaho.platform.api.engine.ObjectFactoryException
 
ObjectFactoryException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.ObjectFactoryException
 
ObjectFactoryException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.ObjectFactoryException
 
onLogout(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.ICacheManager
 
onLogout(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.ILogoutListener
 
onReload() - Method in interface org.pentaho.platform.api.engine.IPluginManagerListener
Called when the IPluginManager is reloaded.
onStatusChange() - Method in interface org.pentaho.platform.api.engine.IServerStatusChangeListener
Called whenever the IServerStatusProvider changes status, or status messages.
org.pentaho.platform.api.action - package org.pentaho.platform.api.action
 
org.pentaho.platform.api.cache - package org.pentaho.platform.api.cache
 
org.pentaho.platform.api.data - package org.pentaho.platform.api.data
 
org.pentaho.platform.api.email - package org.pentaho.platform.api.email
 
org.pentaho.platform.api.engine - package org.pentaho.platform.api.engine
 
org.pentaho.platform.api.engine.perspective - package org.pentaho.platform.api.engine.perspective
 
org.pentaho.platform.api.engine.perspective.pojo - package org.pentaho.platform.api.engine.perspective.pojo
 
org.pentaho.platform.api.engine.security - package org.pentaho.platform.api.engine.security
 
org.pentaho.platform.api.engine.security.userroledao - package org.pentaho.platform.api.engine.security.userroledao
 
org.pentaho.platform.api.locale - package org.pentaho.platform.api.locale
 
org.pentaho.platform.api.mimetype - package org.pentaho.platform.api.mimetype
 
org.pentaho.platform.api.monitoring - package org.pentaho.platform.api.monitoring
 
org.pentaho.platform.api.monitoring.snmp - package org.pentaho.platform.api.monitoring.snmp
 
org.pentaho.platform.api.mt - package org.pentaho.platform.api.mt
 
org.pentaho.platform.api.repository - package org.pentaho.platform.api.repository
 
org.pentaho.platform.api.repository.datasource - package org.pentaho.platform.api.repository.datasource
 
org.pentaho.platform.api.repository2.unified - package org.pentaho.platform.api.repository2.unified
 
org.pentaho.platform.api.repository2.unified.data.node - package org.pentaho.platform.api.repository2.unified.data.node
 
org.pentaho.platform.api.repository2.unified.data.sample - package org.pentaho.platform.api.repository2.unified.data.sample
 
org.pentaho.platform.api.repository2.unified.data.simple - package org.pentaho.platform.api.repository2.unified.data.simple
 
org.pentaho.platform.api.repository2.unified.webservices - package org.pentaho.platform.api.repository2.unified.webservices
 
org.pentaho.platform.api.scheduler - package org.pentaho.platform.api.scheduler
 
org.pentaho.platform.api.ui - package org.pentaho.platform.api.ui
 
org.pentaho.platform.api.usersettings - package org.pentaho.platform.api.usersettings
 
org.pentaho.platform.api.usersettings.pojo - package org.pentaho.platform.api.usersettings.pojo
 
org.pentaho.platform.api.util - package org.pentaho.platform.api.util
 
org.pentaho.platform.api.websocket - package org.pentaho.platform.api.websocket
 
org.pentaho.platform.api.workitem - package org.pentaho.platform.api.workitem
 
originalParentFolderPath(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
OUTPUT_TYPE_CONTENT - Static variable in interface org.pentaho.platform.api.engine.IOutputHandler
 
OUTPUT_TYPE_DEFAULT - Static variable in interface org.pentaho.platform.api.engine.IOutputHandler
 
OUTPUT_TYPE_PARAMETERS - Static variable in interface org.pentaho.platform.api.engine.IOutputHandler
 
overwriteInRepository() - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
pass in flag to allow overwrite in repository (if exists)
owner(RepositoryFileSid) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl.Builder
 

P

PARAMETERS_FAIL - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
Currently only used as an indicator that BIRT report specification parameters could not be read.
PARAMETERS_OK - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
Currently only used as an indicator that BIRT report specification parameters could be read properly.
PARAMETERS_UI_NEEDED - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
Indicates that parameters are required by an action, and the parameters aren't available so they need to be prompted for.
PasswordServiceException - Exception in org.pentaho.platform.api.util
 
PasswordServiceException() - Constructor for exception org.pentaho.platform.api.util.PasswordServiceException
 
PasswordServiceException(String) - Constructor for exception org.pentaho.platform.api.util.PasswordServiceException
 
PasswordServiceException(String, Throwable) - Constructor for exception org.pentaho.platform.api.util.PasswordServiceException
 
PasswordServiceException(Throwable) - Constructor for exception org.pentaho.platform.api.util.PasswordServiceException
 
path(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
PATH_SEPARATOR - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
PentahoAccessControlException - Exception in org.pentaho.platform.api.engine
 
PentahoAccessControlException() - Constructor for exception org.pentaho.platform.api.engine.PentahoAccessControlException
 
PentahoAccessControlException(String) - Constructor for exception org.pentaho.platform.api.engine.PentahoAccessControlException
 
PentahoAccessControlException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.PentahoAccessControlException
 
PentahoAccessControlException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.PentahoAccessControlException
 
PentahoChainedException - Exception in org.pentaho.platform.api.util
This is the base Hitachi Vantara Exception class that handles chained exceptions.
PentahoChainedException() - Constructor for exception org.pentaho.platform.api.util.PentahoChainedException
 
PentahoChainedException(String) - Constructor for exception org.pentaho.platform.api.util.PentahoChainedException
Constructor
PentahoChainedException(String, Throwable) - Constructor for exception org.pentaho.platform.api.util.PentahoChainedException
Constructor
PentahoChainedException(Throwable) - Constructor for exception org.pentaho.platform.api.util.PentahoChainedException
Constructor
PentahoCheckedChainedException - Exception in org.pentaho.platform.api.util
 
PentahoCheckedChainedException() - Constructor for exception org.pentaho.platform.api.util.PentahoCheckedChainedException
 
PentahoCheckedChainedException(String) - Constructor for exception org.pentaho.platform.api.util.PentahoCheckedChainedException
Constructor
PentahoCheckedChainedException(String, Throwable) - Constructor for exception org.pentaho.platform.api.util.PentahoCheckedChainedException
Constructor
PentahoCheckedChainedException(Throwable) - Constructor for exception org.pentaho.platform.api.util.PentahoCheckedChainedException
Constructor
PentahoSystemException - Exception in org.pentaho.platform.api.engine
 
PentahoSystemException() - Constructor for exception org.pentaho.platform.api.engine.PentahoSystemException
 
PentahoSystemException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.PentahoSystemException
 
PentahoSystemException(String) - Constructor for exception org.pentaho.platform.api.engine.PentahoSystemException
 
PentahoSystemException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.PentahoSystemException
 
PERM_ADMIN_ALL - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Do not use this constant; instead use FULL_CONTROL for truly inclusive all access. Old ADMIN_ALL (ie, WRITE) combination (31)
PERM_ADMINISTRATION - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Administration access (60)
PERM_CREATE - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Create access (4)
PERM_DELETE - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Delete (16)
PERM_EXECUTE - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Execute access (1)
PERM_EXECUTE_ADMINISTRATION - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Execute and administration (61)
PERM_EXECUTE_SUBSCRIBE - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Execute and subscribe (3)
PERM_FULL_CONTROL - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
All possible permissions (all ones; 0xffffffff; a negative number)
PERM_NOTHING - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
No access (0)
PERM_SUBSCRIBE - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Subscribe access (2)
PERM_SUBSCRIBE_ADMINISTRATION - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Subscribe and administration (62)
PERM_UPDATE - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Update access (8)
PERM_UPDATE_PERMS - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
Manage perms (32)
PERMISSION_PREFIX - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
 
PERMISSIONS_LIST_ALL - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
 
PERMISSIONS_LIST_SOLUTIONS - Static variable in interface org.pentaho.platform.api.engine.IPentahoAclEntry
Deprecated.
 
PHO_ACLMANAGEMENT - Static variable in interface org.pentaho.platform.api.repository2.unified.IPentahoJCRPrivilege
A constant representing pho:aclManagement (in expanded form), the privilege to be able to perform acl management in the repository
PlatformPluginRegistrationException - Exception in org.pentaho.platform.api.engine
An exception raised when an IPlatformPlugin fails to register.
PlatformPluginRegistrationException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.PlatformPluginRegistrationException
 
PlatformPluginRegistrationException(String) - Constructor for exception org.pentaho.platform.api.engine.PlatformPluginRegistrationException
 
PluginBeanDefinition - Class in org.pentaho.platform.api.engine
 
PluginBeanDefinition(String, String) - Constructor for class org.pentaho.platform.api.engine.PluginBeanDefinition
 
PluginBeanException - Exception in org.pentaho.platform.api.engine
 
PluginBeanException() - Constructor for exception org.pentaho.platform.api.engine.PluginBeanException
 
PluginBeanException(String) - Constructor for exception org.pentaho.platform.api.engine.PluginBeanException
 
PluginBeanException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.PluginBeanException
 
PluginBeanException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.PluginBeanException
 
PluginLifecycleException - Exception in org.pentaho.platform.api.engine
 
PluginLifecycleException() - Constructor for exception org.pentaho.platform.api.engine.PluginLifecycleException
 
PluginLifecycleException(String) - Constructor for exception org.pentaho.platform.api.engine.PluginLifecycleException
 
PluginLifecycleException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.PluginLifecycleException
 
PluginLifecycleException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.PluginLifecycleException
 
PluginServiceDefinition - Class in org.pentaho.platform.api.engine
 
PluginServiceDefinition() - Constructor for class org.pentaho.platform.api.engine.PluginServiceDefinition
 
POOL_PREPARED_STATEMENTS - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
post(T) - Method in interface org.pentaho.platform.api.monitoring.IMonitoringService
all subscribers of this event type will be triggered
PREFIX - Static variable in exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryCreateFileException
 
PREFIX - Static variable in exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryUpdateFileException
 
PREPARE_LATER_INTER_PREFIX - Static variable in interface org.pentaho.platform.api.data.IPreparedComponent
this is an intermediate term used when resolving parameters in the executePrepared call
PREPARE_LATER_PLACEHOLDER - Static variable in interface org.pentaho.platform.api.data.IPreparedComponent
A placeholder for template strings and potential prepared lists, so template fields can be replaced on the fly vs.
PREPARE_LATER_PREFIX - Static variable in interface org.pentaho.platform.api.data.IPreparedComponent
this term may appear when resolving parameters "{PREPARELATER:PARAM_NAME}"
PREPARED_COMPONENT_NAME - Static variable in interface org.pentaho.platform.api.data.IPreparedComponent
The name of the output.
PREPARED_OUTPUT_TYPE - Static variable in interface org.pentaho.platform.api.data.IPreparedComponent
The type of the output.
printActionExecutionStack(PrintWriter) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
printStackTrace(PrintWriter) - Method in exception org.pentaho.platform.api.util.PentahoChainedException
Prints the exception trace to the specified print writer
printStackTrace(PrintStream) - Method in exception org.pentaho.platform.api.util.PentahoChainedException
Prints the exception trace to the specified print stream.
printStackTrace(PrintWriter) - Method in exception org.pentaho.platform.api.util.PentahoCheckedChainedException
Prints the exception trace to the specified print writer
printStackTrace(PrintStream) - Method in exception org.pentaho.platform.api.util.PentahoCheckedChainedException
Prints the exception trace to the specified print stream.
processTemplate(String, String, String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IUITemplater
 
processTemplate(String, String, IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IUITemplater
 
PROMPT_ALLOWED - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
This parameter allows prompting
PROMPT_NEEDED - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
This parameter needs to be prompted for a value
PROMPT_NEVER - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
This parameter does not allow prompting
PROMPT_NO - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
Indicates that no parameter prompts are pending.
PROMPT_NOW - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
Indicates that we need to prompt immediately for parameters.
PROMPT_PENDING - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
A component has already specified a prompt for this parameter
PROMPT_WAITING - Static variable in interface org.pentaho.platform.api.engine.IRuntimeContext
Indicates that parameter prompts are pending.
promptNeeded() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Sets the prompt flag but continue processing Actions
promptNow() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Forces the runtime to stop processing Actions and return to prompt
PROTECTED_PARAMETER_PREFIX - Static variable in interface org.pentaho.platform.api.util.IPdiContentProvider
When a user creates a input parameter but does not want it to be written by others, it uses the syntax of an "_" (underscore) as prefix; so, if a user creates input parameter "_name", then the other users looking at it will know that they should not change it.
publish(IPentahoSession, int) - Method in interface org.pentaho.platform.api.engine.IPentahoPublisher
Called when the publish is requested.
publish(IPentahoSession, String) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemAdminPlugins
 
publish(IWorkItemLifecycleEvent) - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEventPublisher
putInGlobalAttributesMap(Object, Object) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemStartupActions
 
putInGlobalCache(Object, Object) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Puts an object directly into the cache without translating the passed in key.
putInRegionCache(String, Object, Object) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Puts an object directly into the cache of a specific region
putInSessionCache(IPentahoSession, String, Object) - Method in interface org.pentaho.platform.api.engine.ICacheManager
Puts an object in the session-specific cache.

Q

QUERY_KEY - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 

R

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
register(T) - Method in interface org.pentaho.platform.api.monitoring.IMonitoringService
register a subscriber ( a.k.a.
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.
registerServerStatusChangeListener(IServerStatusChangeListener) - Method in interface org.pentaho.platform.api.engine.IServerStatusProvider
 
registerServerStatusChangeListener(IServerStatusChangeListener) - Method in class org.pentaho.platform.api.engine.ServerStatusProvider
 
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
Deprecated.
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.
removeServerStatusChangeListener(IServerStatusChangeListener) - Method in interface org.pentaho.platform.api.engine.IServerStatusProvider
 
removeServerStatusChangeListener(IServerStatusChangeListener) - Method in class org.pentaho.platform.api.engine.ServerStatusProvider
 
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, 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, 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(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
Deprecated.
RepositoryFile.Builder - Class in org.pentaho.platform.api.repository2.unified
 
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
 
RepositoryFileAclAceDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
RepositoryFileAclAceDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
RepositoryFileAclDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
RepositoryFileAclDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
RepositoryFileDto - Class in org.pentaho.platform.api.repository2.unified.webservices
JAXB-safe version of RepositoryFile.
RepositoryFileDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
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
Creates a new Sid with given name and type of RepositoryFileSid.Type.USER.
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
 
RepositoryFileTreeDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
RepositoryFileTreeDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto
 
RepositoryLifecycleManagerException - Exception in org.pentaho.platform.api.repository2.unified
Exception thrown from a IBackingRepositoryLifecycleManager method that fails
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
 
RequestMatcherDefinition - Class in org.pentaho.platform.api.engine
This class represents a request matcher that identifies one or more endpoints.
RequestMatcherDefinition() - Constructor for class org.pentaho.platform.api.engine.RequestMatcherDefinition
 
RequestMatcherDefinition(String, String) - Constructor for class org.pentaho.platform.api.engine.RequestMatcherDefinition
 
RequestMatcherDefinition(String, String, Collection<String>) - Constructor for class org.pentaho.platform.api.engine.RequestMatcherDefinition
 
requiresUpdate() - Method in interface org.pentaho.platform.api.action.IActionInvokeStatus
Returns true if the IAction that was just invoked needs to be resubmitted.
resetAccessControls(List<IPentahoAclEntry>) - Method in interface org.pentaho.platform.api.engine.IAclHolder
Deprecated.
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.
resolveMimeForBundle(IPlatformImportBundle) - Method in interface org.pentaho.platform.api.mimetype.IPlatformMimeResolver
 
resolveMimeForFileName(String) - Method in interface org.pentaho.platform.api.mimetype.IPlatformMimeResolver
 
resolveMimeTypeForFileName(String) - Method in interface org.pentaho.platform.api.mimetype.IPlatformMimeResolver
 
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

S

SAMPLE_CONTENT_TYPE - Static variable in interface org.pentaho.platform.api.repository2.unified.IRepositoryFileData
 
SampleRepositoryFileData - Class in org.pentaho.platform.api.repository2.unified.data.sample
An IRepositoryFileData for illustrative purposes.
SampleRepositoryFileData(String, boolean, int) - Constructor for class org.pentaho.platform.api.repository2.unified.data.sample.SampleRepositoryFileData
 
schedulable(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
SCHEDULABLE_BY_DEFAULT - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
SCHEDULABLE_KEY - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
schedule(IAction, String, Map<String, Serializable>) - Method in interface org.pentaho.platform.api.action.IActionAdaptor
Schedule the request for execution in the orchestration environment in future
SCOPE_REQUEST - Static variable in interface org.pentaho.platform.api.engine.IParameterProvider
 
SCOPE_SESSION - Static variable in interface org.pentaho.platform.api.engine.IParameterProvider
 
SEARCH_TYPE_PHRASE - Static variable in interface org.pentaho.platform.api.repository.ISearchable
SEARCH_TYPE_PHRASE Searches for the exact phrase
SEARCH_TYPE_WORDS_AND - Static variable in interface org.pentaho.platform.api.repository.ISearchable
SEARCH_TYPE_WORDS_AND Searches for each word with each column using an AND connector
SEARCH_TYPE_WORDS_OR - Static variable in interface org.pentaho.platform.api.repository.ISearchable
SEARCH_TYPE_WORDS_OR Searches for each word with each column using an OR connector
selectionCount() - Method in interface org.pentaho.platform.api.engine.ISelectionMapper
 
sendEmailTest(IEmailConfiguration) - Method in interface org.pentaho.platform.api.email.IEmailService
Generates a test email via the specficied email configuration
sendFeedbackForm() - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Generates a parameter acquisition form for required parameters.
SEPARATOR - Static variable in interface org.pentaho.platform.api.repository.IRepositoryFile
 
SEPARATOR - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
serializeToInt(Object) - Method in class org.pentaho.platform.api.monitoring.snmp.IVariableSerializer.BasicSerializer
 
serializeToInt(Object) - Method in interface org.pentaho.platform.api.monitoring.snmp.IVariableSerializer
 
serializeToString(Object) - Method in class org.pentaho.platform.api.monitoring.snmp.IVariableSerializer.BasicSerializer
 
serializeToString(Object) - Method in interface org.pentaho.platform.api.monitoring.snmp.IVariableSerializer
 
ServerStatusProvider - Class in org.pentaho.platform.api.engine
This is the default implementation of server status log message provider.
ServerStatusProvider() - Constructor for class org.pentaho.platform.api.engine.ServerStatusProvider
 
ServiceException - Exception in org.pentaho.platform.api.engine
 
ServiceException() - Constructor for exception org.pentaho.platform.api.engine.ServiceException
 
ServiceException(String) - Constructor for exception org.pentaho.platform.api.engine.ServiceException
 
ServiceException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.ServiceException
 
ServiceException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.ServiceException
 
ServiceInitializationException - Exception in org.pentaho.platform.api.engine
 
ServiceInitializationException() - Constructor for exception org.pentaho.platform.api.engine.ServiceInitializationException
 
ServiceInitializationException(String) - Constructor for exception org.pentaho.platform.api.engine.ServiceInitializationException
 
ServiceInitializationException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.ServiceInitializationException
 
ServiceInitializationException(Throwable) - Constructor for exception org.pentaho.platform.api.engine.ServiceInitializationException
 
SESSION - Static variable in interface org.pentaho.platform.api.engine.ICacheManager
 
SESSION_LOG - Static variable in interface org.pentaho.platform.api.engine.ILogger
 
SESSION_ROLES - Static variable in interface org.pentaho.platform.api.engine.IPentahoSession
Roles that are authorized in current session.
sessionStartup(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemStartupActions
 
sessionStartup(IPentahoSession, IParameterProvider) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemStartupActions
 
setAccessControls(List<IPentahoAclEntry>) - Method in interface org.pentaho.platform.api.engine.IAclHolder
Deprecated.
Sets the access controls on this specific object.
setAccessControls(List) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
This method's purpose is to allow Hibernate to initialize the ACLs from the data-store.
setAces(List<RepositoryFileAclAceDto>, boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
setAces(List<RepositoryFileAclAceDto>) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
Deprecated.
setAcl(RepositoryFileAcl) - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
 
setAclFor(RepositoryFile, RepositoryFileAcl) - Method in interface org.pentaho.platform.api.repository2.unified.IAclNodeHelper
Sets acl for repositoryFile.
setAclNode(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setAclObjectIdentity(IPentahoAclObjectIdentity) - Method in interface org.pentaho.platform.api.engine.IPentahoBasicAclEntry
Deprecated.
This setter should only be used by DAO implementations.
setAclObjectParentIdentity(IPentahoAclObjectIdentity) - Method in interface org.pentaho.platform.api.engine.IPentahoBasicAclEntry
Deprecated.
This setter should only be used by DAO implementations.
setAclOnlyChange(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
setActionClass(String) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
setActionDefinition(IActionDefinition) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
setActionDefinition(IActionDefinition) - Method in interface org.pentaho.platform.api.engine.IComponent
 
setActionName(String) - Method in interface org.pentaho.platform.api.engine.IComponent
 
setActionName(String) - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Sets the name of the action sequence document that the session is currently performing.
setActionOutputScope(String) - Method in interface org.pentaho.platform.api.engine.ISessionStartupAction
 
setActionPath(String) - Method in interface org.pentaho.platform.api.engine.ISessionStartupAction
 
setActionSequence(IActionSequence) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Sets the current action sequence
setActionSequenceName(String) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
setAdministrationPlugins(List<IPentahoPublisher>) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemAdminPlugins
Registers administrative capabilities that can be invoked later via PentahoSystem#publish(IPentahoSession, String)
setAdminPlugins(IPentahoSystemAdminPlugins) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setAdminRole(GrantedAuthority) - Method in interface org.pentaho.platform.api.engine.IAclVoter
Deprecated.
Sets the role used to determine whether someone is the system-manager.
setAllowableAttributeNames(Collection) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
setApplicationContext(IApplicationContext) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setApplyAclSettings(boolean) - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
use the import manfiest file to apply ACL settings to files and folders
setAttribute(String, Object) - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Sets the value of the session attribute.
setAuthenticate(boolean) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setAuthenticated(String) - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Sets the name of the session and indicates that the session is authenticated.
setAuthor(String) - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
setAuthor(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
setBackgroundExecutionAlert() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Toggles on an alert condition indicating that the background execution of a task has completed during this session.
setBaseUrl(String) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
Deprecated. 
setBeanId(String) - Method in class org.pentaho.platform.api.engine.PluginBeanDefinition
 
setBigDecimalProperty(String, BigDecimal) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Sets a BigDecimal property in the Runtime Element.
setCallbacks(List<Object>) - Method in interface org.pentaho.platform.api.engine.IContentGenerator
this method is not used at this time
setCanEdit(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
setCanSchedule(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
setChildNodeFilter(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
setChildNodes(List<DataNodeDto>) - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
setChildProperties(List<DataPropertyDto>) - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
setChildren(List<RepositoryFileTreeDto>) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto
 
setChildrenFiles(Set) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
setClassname(String) - Method in class org.pentaho.platform.api.engine.PluginBeanDefinition
 
setComponent(IComponent) - Method in interface org.pentaho.platform.api.engine.ISolutionActionDefinition
Sets the Component object that this definition will belong to.
setComponentDefinition(Node) - Method in interface org.pentaho.platform.api.engine.IComponent
 
setComponentDefinitionMap(Map<String, String>) - Method in interface org.pentaho.platform.api.engine.IComponent
 
setConditionalExecution(IConditionalExecution) - Method in interface org.pentaho.platform.api.engine.IActionSequence
Sets the ConditionalExecution object that determines whether a set of actions will be executed.
setContentRef(String) - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
setContentUrl(String) - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
setContext(Object) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
 
setConverter(Converter) - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
setCreatedDate(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setCreateFeedbackParameterCallback(ICreateFeedbackParameterCallback) - Method in interface org.pentaho.platform.api.engine.IActionRequestHandler
 
setCreateFeedbackParameterCallback(ICreateFeedbackParameterCallback) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
 
setCreateFeedbackParameterCallback(ICreateFeedbackParameterCallback) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
 
setCreatorId(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setCurrentParameters(ISolutionActionDefinition) - Method in interface org.pentaho.platform.api.engine.IParameterManager
 
setData(byte[]) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
setDate(Date) - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
setDateProperty(String, Date) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Sets a Date property in the Runtime Element.
setDebug(boolean) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setDefaultFrom(String) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setDeletedDate(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setDepth(Integer) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
setDescription(String) - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
setDescription(String) - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
setDescription(String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoRole
 
setDescription(String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoUser
 
setDescription(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
setDescription(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setDisplayType(String) - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
setEmailConfig(IEmailConfiguration) - Method in interface org.pentaho.platform.api.email.IEmailService
Saves the email configuration
setEnabled(boolean) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoUser
 
setEntriesInheriting(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
setExcludeMemberSet(Set<String>) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
setExecutionStatus(boolean) - Method in interface org.pentaho.platform.api.action.IActionInvokeStatus
Set the execution status.
setExtension(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
setExtensions(List<String>) - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
setExtraClasses(Collection<String>) - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
setFile(RepositoryFileDto) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto
 
setFileMetadata(Serializable, Map<String, Serializable>) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Sets a metadata object for the given fileid
setFileSize(long) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setFolder(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setForcePrompt(boolean) - Method in interface org.pentaho.platform.api.engine.IActionRequestHandler
Sets whether to force the generation of a prompt page
setForcePrompt(boolean) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
Sets if the promp page should be forced
setFromName(String) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setFullname(String) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setFullyQualifiedServerURL(String) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
 
setGlobalUserSetting(String, String) - Method in interface org.pentaho.platform.api.usersettings.IUserSettingService
 
setHandlerId(String) - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
setHeaderContent(String) - Method in interface org.pentaho.platform.api.engine.IUITemplater
 
setHidden(boolean) - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
setHidden(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setHidden(boolean) - Method in class org.pentaho.platform.api.ui.Theme
 
setIcon(String) - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
setId(String) - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
setId(String) - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
setId(Serializable) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
setId(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
setId(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
setId(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setId(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
setId(String) - Method in class org.pentaho.platform.api.ui.Theme
 
setIncludeAcls(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
setIncludeMemberSet(Set<String>) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
setIncludeSystemFolders(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
setInputNames(List<String>) - Method in interface org.pentaho.platform.api.action.IDefinitionAwareAction
Informs the Action of the inputs that will be given to it, as specified in the action definition.
setInputs(Map<String, Object>) - Method in interface org.pentaho.platform.api.engine.IAcceptsRuntimeInputs
Deprecated.
 
setInputStream(InputStream) - Method in interface org.pentaho.platform.api.action.IStreamProcessingAction
Sets the input stream containing the contents to be processed.
setInstanceId(String) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
setInstanceId(String) - Method in interface org.pentaho.platform.api.engine.IComponent
 
setInstanceId(String) - Method in interface org.pentaho.platform.api.engine.IContentGenerator
this method is not used at this time
setInstanceId(String) - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
setInstanceId(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
setItemName(String) - Method in interface org.pentaho.platform.api.engine.IContentGenerator
Set the name of the output content item for the content generator
setJobDescription(String) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setJobGroup(String) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setJobName(String) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setKey(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto
 
setLabels(List<String>) - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
setLastModified(long) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
setLastModifiedDate(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setLayoutPriority(int) - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
setlistener(IActionCompleteListener) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
Sets the action complete listener which will be called when the action is complete
setlistener(IExecutionListener) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
 
setListProperty(String, List) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Sets a List Property in the Runtime Element
setLoaded(boolean) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
setLocale(boolean) - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
setLocale(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.LocaleMapDto
 
setLocale(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setLocalePropertiesForFile(RepositoryFile, String, Properties) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
setLocalePropertiesForFileById(Serializable, String, Properties) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
setLocalePropertiesForFileByPath(String, String, Properties) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
setLocalePropertiesMapEntries(List<LocaleMapDto>) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setLocation(String) - Method in class org.pentaho.platform.api.ui.ThemeResource
 
setLockDate(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setLocked(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setLockMessage(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setLockOwner(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setLogger(Log) - Method in interface org.pentaho.platform.api.action.ILoggingAction
Sets an apache commons logger for the Action component to use
setLogger(ILogger) - Method in interface org.pentaho.platform.api.engine.ILoggablePojo
Deprecated.
Sets the logger for the POJO component to use
setLoggingLevel(int) - Method in interface org.pentaho.platform.api.engine.ILogger
Set the logging level for this Logger.
setLoggingLevel(int) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setLongProperty(String, Long) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Sets a Long property in the Runtime Element.
setLongProperty(String, long) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Sets a Long property in the Runtime Element.
setLoopIndex(Integer) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
setMapProperty(String, Map) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Sets a Map Property in the Runtime Element Special implementation note - Null values aren't supported in the Map.
setMask(int) - Method in interface org.pentaho.platform.api.engine.IPentahoBasicAclEntry
Deprecated.
This setter should only be used by DAO implementations.
setMessage(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
setMessages(List) - Method in interface org.pentaho.platform.api.engine.IComponent
 
setMessagesList(List<String>) - Method in interface org.pentaho.platform.api.engine.IContentGenerator
called before createContent(), this method is not used by the content generator system at this time.
setMethods(Collection<String>) - Method in class org.pentaho.platform.api.engine.RequestMatcherDefinition
Sets the request methods.
setMimeType(String) - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
setMimeType(String) - Method in interface org.pentaho.platform.api.engine.IMimeTypeListener
 
setMimeType(String) - Method in interface org.pentaho.platform.api.repository.IContentItem
Sets the mime type
setMimeTypeListener(IMimeTypeListener) - Method in interface org.pentaho.platform.api.engine.IOutputHandler
 
setModifiable(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
setName(String) - Method in interface org.pentaho.platform.api.engine.IMimeTypeListener
 
setName(String) - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
setName(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
setName(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataPropertyDto
 
setName(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setName(String) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setName(String) - Method in class org.pentaho.platform.api.ui.Theme
 
setNextFireTime(Date) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setNode(DataNodeDto) - Method in class org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto
 
setNotAuthenticated() - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Sets the indication that the user is no longer authenticated.
setNotSchedulable(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setOriginalParentFolderPath(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setOutput(String, Object) - Method in interface org.pentaho.platform.api.engine.IOutputHandler
Sets an output of the handler.
setOutputHandler(IOutputHandler) - Method in interface org.pentaho.platform.api.engine.IContentGenerator
called before createContent(), the IOutputHandler is the API that defines how to write content back to the client.
setOutputHandler(IOutputHandler) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Sets the output handler for the runtime context
setOutputNames(List<String>) - Method in interface org.pentaho.platform.api.action.IDefinitionAwareAction
Informs the Action of the outputs that will be expected of it, as specified in the action definition.
setOutputPreference(int) - Method in interface org.pentaho.platform.api.engine.IOutputHandler
Sets the output type that is wanted by the handler.
setOutputStream(OutputStream) - Method in interface org.pentaho.platform.api.action.IStreamingAction
 
setOutputStream(OutputStream) - Method in interface org.pentaho.platform.api.engine.IStreamingPojo
Deprecated.
Sets the outputstream that the component can stream content to
setOutputValue(String, Object) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Sets the value of a named output parameter
setOverlays(ArrayList<XulOverlay>) - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
setOverwriteAclSettings(boolean) - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
use the import manifest ACL settings and overwrite existing settings
setOwner(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
setOwner(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setOwnerTenantPath(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setOwnerType(int) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
setOwnerType(int) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setParameter(String, String) - Method in interface org.pentaho.platform.api.engine.IParameterSetter
Sets a named parameter to a String value
setParameter(String, long) - Method in interface org.pentaho.platform.api.engine.IParameterSetter
Sets a named parameter to a long value
setParameter(String, Date) - Method in interface org.pentaho.platform.api.engine.IParameterSetter
Sets a named parameter to a Date value
setParameter(String, Object) - Method in interface org.pentaho.platform.api.engine.IParameterSetter
Sets a named parameter to a Object value
setParameter(String, String) - Method in interface org.pentaho.platform.api.engine.IPentahoUrl
Sets a URL parameter.
setParameterName(String) - Method in exception org.pentaho.platform.api.engine.UnresolvedParameterException
 
setParameterProvider(String, IParameterProvider) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
Sets the source for input parameters.
setParameterProviders(Map<String, IParameterProvider>) - Method in interface org.pentaho.platform.api.engine.IContentGenerator
called before createContent(), the parameterProviders list contain the available parameters.
setParameterTarget(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Sets the target window that the content will be displayed in.
setParameterXsl(String) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Sets the xsl file to be used to generate the parameter page for the current component.
setParameterXsl(String) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
Sets the xsl file to be used to generate the parameter page for the current component.
setParamSelections(List, Map, String) - Method in interface org.pentaho.platform.api.engine.IActionParameter
Deprecated.
Unused in the platform
setParent(IRepositoryFile) - Method in interface org.pentaho.platform.api.repository.IRepositoryFile
 
setParentId(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
setParentType(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
setPassword(String) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setPassword(String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IPentahoUser
 
setPassword(ITenant, String, String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Update the password of an existing user under a specified tenant.
setPath(String) - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
Path which may be used to indicate where a bundle belongs in the repository.
setPath(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
setPath(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setPattern(String) - Method in class org.pentaho.platform.api.engine.RequestMatcherDefinition
Sets the request pattern.
setPentahoObjectFactory(IPentahoObjectFactory) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setPentahoSystemAclHelper(IPentahoSystemAclHelper) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setPentahoSystemHelper(IPentahoSystemHelper) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setPentahoSystemInitializer(IPentahoSystemInitializer) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setPermission(IPermissionRecipient, IPermissionMask, Object) - Method in interface org.pentaho.platform.api.engine.IPermissionMgr
Deprecated.
TODO mlowery This is really addPermission.
setPermissions(Map<IPermissionRecipient, IPermissionMask>, Object) - Method in interface org.pentaho.platform.api.engine.IPermissionMgr
Deprecated.
 
setPermissions(List<Integer>) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
setPreserveDsw(boolean) - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
Preserve DSW OLAP model data
setPreviousFireTime(Date) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setProcessId(String) - Method in interface org.pentaho.platform.api.engine.IComponent
 
setProcessId(String) - Method in interface org.pentaho.platform.api.engine.IPentahoSession
Sets the name of the process for which an action sequence is being performed.
setPromptStatus(int) - Method in interface org.pentaho.platform.api.engine.IActionParameter
Sets the prompt status for this parameter.
setPromptStatus(int) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Sets the default prompt status PROMPT_NO, PROMPT_WAITING, PROMPT_NOW
setProperties(List<StringKeyStringValueDto>) - Method in class org.pentaho.platform.api.repository2.unified.webservices.LocaleMapDto
 
setProperty(String, String) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
setProperty(String, boolean) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
setProperty(String, double) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
setProperty(String, long) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
setProperty(String, Date) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
setProperty(String, DataNodeRef) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
setProtectedRequestMatchers(Collection<RequestMatcherDefinition>) - Method in class org.pentaho.platform.api.engine.CsrfProtectionDefinition
Sets the list of request matcher specifications that identify CSRF protected endpoints for this plug-in.
setRecipient(Object) - Method in interface org.pentaho.platform.api.engine.IPentahoBasicAclEntry
Deprecated.
This setter should only be used by DAO implementations.
setRecipient(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
setRecipientType(int) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
setRepositoryFileAclDto(RepositoryFileAclDto) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setRequestContext(IPentahoRequestContext) - Method in interface org.pentaho.platform.api.engine.IPentahoRequestContextHolderStrategy
Sets the current request context.
setRequiredSecurityActions(ArrayList<String>) - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
setRequiresUpdate(boolean) - Method in interface org.pentaho.platform.api.action.IActionInvokeStatus
 
setResourceBundleUri(String) - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
setResources(Set<ThemeResource>) - Method in class org.pentaho.platform.api.ui.Theme
 
setRetainOwnership(boolean) - Method in interface org.pentaho.platform.api.repository2.unified.IPlatformImportBundle
retain the file metadata ownership
setRoleDescription(ITenant, String, String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Update the role description of a given role under a specific tenant.
setRoleMembers(ITenant, String, String[]) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Assign list of user names to a particular role in a specified tenant.
setRoles(List<String>) - Method in class org.pentaho.platform.api.engine.security.userroledao.UserRoleInfo
 
setRuntimeContext(IRuntimeContext) - Method in interface org.pentaho.platform.api.engine.IComponent
 
setScript(String) - Method in interface org.pentaho.platform.api.engine.IConditionalExecution
Sets the script that will be executed in shouldExecute to evaluate condition
setServiceBeanId(String) - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
setServiceClass(String) - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
setSession(IPentahoSession) - Method in interface org.pentaho.platform.api.action.ISessionAwareAction
 
setSession(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IComponent
 
setSession(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IContentGenerator
called before createContent(), this is the users session object.
setSession(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
setSession(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IOutputHandler
 
setSession(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.ISessionContainer
Set the session for this session container.
setSession(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.ISolutionEngine
Sets the session in the solution engine
setSessionId(String) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
setSessionStartupActions(List<ISessionStartupAction>) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemStartupActions
Registers server actions that will be invoked when a session is created.
setSessionType(String) - Method in interface org.pentaho.platform.api.engine.ISessionStartupAction
 
setSettingName(String) - Method in interface org.pentaho.platform.api.usersettings.pojo.IUserSetting
 
setSettingValue(String) - Method in interface org.pentaho.platform.api.usersettings.pojo.IUserSetting
 
setShowHidden(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
 
setSmtpHost(String) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setSmtpPort(Integer) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setSmtpProtocol(String) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setSmtpQuitWait(boolean) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setSolutionId(String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
setSolutionPath(String) - Method in interface org.pentaho.platform.api.engine.IContentOutputHandler
 
setSolutionRootPath(String) - Method in interface org.pentaho.platform.api.engine.IApplicationContext
 
setStartupActions(IPentahoSystemStartupActions) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setStatus(IServerStatusProvider.ServerStatus) - Method in interface org.pentaho.platform.api.engine.IServerStatusProvider
 
setStatus(IServerStatusProvider.ServerStatus) - Method in class org.pentaho.platform.api.engine.ServerStatusProvider
 
setStatusMessages(String[]) - Method in interface org.pentaho.platform.api.engine.IServerStatusProvider
 
setStatusMessages(String[]) - Method in class org.pentaho.platform.api.engine.ServerStatusProvider
 
setStepDescription(String) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
setStepNumber(Integer) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
setStreamProvider(Object) - Method in interface org.pentaho.platform.api.action.IActionInvokeStatus
 
setStringProperty(String, String) - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
Sets a string property in the Runtime Element.
setSubscribers(List<IWorkItemLifecycleEventSubscriber>) - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecycleEventPublisher
Sets the List of IWorkItemLifecycleEventSubscribers that wish to listen for IWorkItemLifecycleEvents.
setSystemListeners(IPentahoSystemListeners) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setSystemListeners(List<IPentahoSystemListener>) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemListeners
Registers custom handlers that are notified of both system startup and system shutdown events.
setSystemSettingsService(ISystemSettings) - Method in interface org.pentaho.platform.api.engine.IPentahoSystem
 
setTenantPath(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
setTenantPath(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
setTheme(Theme) - Method in class org.pentaho.platform.api.ui.ThemeResource
 
setThemeResolvers(List<IThemeResolver>) - Method in interface org.pentaho.platform.api.ui.IThemeManager
Set the collection of IThemeResolver objects used to find available themes
setThrowable(Throwable) - Method in interface org.pentaho.platform.api.action.IActionInvokeStatus
 
setTitle(String) - Method in interface org.pentaho.platform.api.engine.IFileInfo
 
setTitle(String) - Method in interface org.pentaho.platform.api.engine.perspective.pojo.IPluginPerspective
 
setTitle(String) - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
setTitle(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.ExecutableFileTypeDto
 
setTitle(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setTriggerGroup(String) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setTriggerName(String) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setTriggerState(int) - Method in interface org.pentaho.platform.api.scheduler.IJobSchedule
 
setType(String) - Method in class org.pentaho.platform.api.engine.RequestMatcherDefinition
Sets the request matcher type.
setType(int) - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataPropertyDto
 
setTypes(String[]) - Method in class org.pentaho.platform.api.engine.PluginServiceDefinition
 
setTypes(RepositoryRequest.FILES_TYPE_FILTER) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryRequest
Sets whether files, folders, or both are returned: ( FILES | FOLDERS | [default] FILES_FOLDERS )
setUrlFactory(IPentahoUrlFactory) - Method in interface org.pentaho.platform.api.engine.IContentGenerator
called before createContent(), this is used to build URLs
setUserDescription(ITenant, String, String) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Update the user description of an existing user under a speficied tenant.
setUserId(String) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setUsername(String) - Method in interface org.pentaho.platform.api.usersettings.pojo.IUserSetting
 
setUserRoles(ITenant, String, String[]) - Method in interface org.pentaho.platform.api.engine.security.userroledao.IUserRoleDao
Assign a list of roles to a particular user in a specified tenant.
setUsers(List<String>) - Method in class org.pentaho.platform.api.engine.security.userroledao.UserRoleInfo
 
setUserSetting(String, String, String) - Method in interface org.pentaho.platform.api.usersettings.IAnyUserSettingService
Deprecated.
Sets a user setting for a specified username
setUserSetting(String, String) - Method in interface org.pentaho.platform.api.usersettings.IUserSettingService
 
setUseSsl(boolean) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setUseStartTls(boolean) - Method in interface org.pentaho.platform.api.email.IEmailConfiguration
 
setValue(Object) - Method in interface org.pentaho.platform.api.engine.IActionParameter
Sets the value object for this ActionParameter.
setValue(Object) - Method in interface org.pentaho.platform.api.engine.IOutputDef
Sets the value of the output parameter.
setValue(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataPropertyDto
 
setValue(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto
 
setVarArgs(Map<String, Object>) - Method in interface org.pentaho.platform.api.action.IVarArgsAction
Inputs from an action sequence that cannot be set on an Action by Java bean convention will be passed in through this map.
setVersionCommentEnabled(boolean) - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
setVersionCommentEnabled(Boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
setVersionCommentEnabled(Boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setVersioned(boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setVersionedFileId(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
setVersionEnabled(boolean) - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
setVersionId(String) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
setVersioningEnabled(Boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
setVersioningEnabled(Boolean) - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
shareConnection() - Method in interface org.pentaho.platform.api.data.IPreparedComponent
exposes the connection object for others to use.
shouldExecute(Map, Log) - Method in interface org.pentaho.platform.api.engine.IConditionalExecution
Uses current inputs, and the set script to "decide" whether to execute the current block of actions.
shutdown() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemListener
Notification of system shutdown.
shutdown() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemListeners
 
shutdown() - Method in interface org.pentaho.platform.api.repository2.unified.IBackingRepositoryLifecycleManager
To be called on repository shutdown.
SIMPLE_CONTENT_TYPE - Static variable in interface org.pentaho.platform.api.repository2.unified.IRepositoryFileData
 
SimpleRepositoryFileData - Class in org.pentaho.platform.api.repository2.unified.data.simple
A IRepositoryFileData that has an input stream, encoding, and optional MIME type.
SimpleRepositoryFileData(InputStream, String, String) - Constructor for class org.pentaho.platform.api.repository2.unified.data.simple.SimpleRepositoryFileData
 
SnmpTrapEvent - Annotation Type in org.pentaho.platform.api.monitoring.snmp
Marks a class as an SNMP Trap entity.
SnmpVariable - Annotation Type in org.pentaho.platform.api.monitoring.snmp
Marks a field to be converted to a SNMP VariableBinding for a Trap event.
SnmpVariable.TYPE - Enum in org.pentaho.platform.api.monitoring.snmp
 
SOLUTION_FILE_RESOURCE - Static variable in interface org.pentaho.platform.api.engine.IActionSequenceResource
The Resource is a solution file
SOLUTION_LOG - Static variable in interface org.pentaho.platform.api.engine.ILogger
 
SolutionRepositoryException - Exception in org.pentaho.platform.api.repository
 
SolutionRepositoryException() - Constructor for exception org.pentaho.platform.api.repository.SolutionRepositoryException
 
SolutionRepositoryException(String) - Constructor for exception org.pentaho.platform.api.repository.SolutionRepositoryException
 
SolutionRepositoryException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository.SolutionRepositoryException
 
SolutionRepositoryException(Throwable) - Constructor for exception org.pentaho.platform.api.repository.SolutionRepositoryException
 
SolutionRepositoryServiceException - Exception in org.pentaho.platform.api.repository
 
SolutionRepositoryServiceException() - Constructor for exception org.pentaho.platform.api.repository.SolutionRepositoryServiceException
 
SolutionRepositoryServiceException(String) - Constructor for exception org.pentaho.platform.api.repository.SolutionRepositoryServiceException
 
SolutionRepositoryServiceException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository.SolutionRepositoryServiceException
 
SolutionRepositoryServiceException(Throwable) - Constructor for exception org.pentaho.platform.api.repository.SolutionRepositoryServiceException
 
startup(IPentahoSession) - Method in interface org.pentaho.platform.api.engine.IPentahoSystemListener
Notification of system startup.
startup() - Method in interface org.pentaho.platform.api.repository2.unified.IBackingRepositoryLifecycleManager
To be called before any (non-admin) users interact with the backing repository.
STATE_BLOCKED - Static variable in interface org.pentaho.platform.api.engine.IScheduledJob
A ScheduledJob arrives at the blocked state when the job that it is associated with is a StatefulJob and it is currently executing.
STATE_COMPLETE - Static variable in interface org.pentaho.platform.api.engine.IScheduledJob
The trigger has no remaining fire-times in its schedule.
STATE_ERROR - Static variable in interface org.pentaho.platform.api.engine.IScheduledJob
A ScheduledJob arrives at the error state when the scheduler attempts to fire it, but cannot due to an error creating and executing its related job.
STATE_NONE - Static variable in interface org.pentaho.platform.api.engine.IScheduledJob
Indicates that the ScheduledJob does not exist.
STATE_NORMAL - Static variable in interface org.pentaho.platform.api.engine.IScheduledJob
 
STATE_PAUSED - Static variable in interface org.pentaho.platform.api.engine.IScheduledJob
 
STRING - Static variable in interface org.pentaho.platform.api.engine.IActionSequenceResource
The resource type is an embedded string
StringKeyStringValueDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
StringKeyStringValueDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto
 
StringKeyStringValueDto(String, String) - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto
 
SYSTEM_FOLDER - Static variable in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
 
systemEntryPoint() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemEntryPoint
Perform operations necessary upon entry to the system.
systemExitPoint() - Method in interface org.pentaho.platform.api.engine.IPentahoSystemExitPoint
Perform any system cleanup actions after the thread executes.

T

TENANT_ENABLED - Static variable in interface org.pentaho.platform.api.mt.ITenantManager
 
TENANT_ID_KEY - Static variable in interface org.pentaho.platform.api.engine.IPentahoSession
Key for searching the tenant ID.
TENANT_ROOT - Static variable in interface org.pentaho.platform.api.mt.ITenantManager
 
TEST_ON_BORROW - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
TEST_ON_RETURN - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
TEST_WHILE_IDLE - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
Theme - Class in org.pentaho.platform.api.ui
Theme encapsulates a collection of ThemeResources and a root directory to access them from.
Theme(String, String, String) - Constructor for class org.pentaho.platform.api.ui.Theme
 
ThemeResource - Class in org.pentaho.platform.api.ui
User: nbaker Date: 5/15/11
ThemeResource(Theme, String) - Constructor for class org.pentaho.platform.api.ui.ThemeResource
 
TIME_BETWEEN_EVICTION_RUNS_MILLIS - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
title(String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
title(String, String) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
TITLE - Static variable in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
toPentahoRole(String) - Method in interface org.pentaho.platform.api.engine.security.IAuthenticationRoleMapper
Takes a string name of third party role and returns the mapped Hitachi Vantara security role.
toString() - Method in interface org.pentaho.platform.api.engine.ISelectionMapper
 
toString() - Method in interface org.pentaho.platform.api.mimetype.IMimeType
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
toString(int) - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNode
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataNodeRef
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.data.node.DataProperty
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.data.simple.SimpleRepositoryFileData
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAce
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileAcl
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileSid
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
toString(int) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFileTree
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.VersionSummary
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataNodeDto
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.DataPropertyDto
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.LocaleMapDto
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.NodeRepositoryFileDataDto
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclAceDto
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileAclDto
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileDto
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.RepositoryFileTreeDto
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.StringKeyStringValueDto
 
toString() - Method in class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 
toString() - Method in interface org.pentaho.platform.api.workitem.IWorkItemLifecyclePhase
Returns the string representation of this phase.
toXML() - Method in interface org.pentaho.platform.api.repository.IRuntimeElement
 
TRACE - Static variable in interface org.pentaho.platform.api.engine.ILogger
The TRACE has the lowest possible rank and is intended to turn on all logging.
trace(String) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message object with the TRACE Level.
trace(String, Throwable) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message with the TRACE level including the stack trace of the Throwable error passed as parameter.
trackBackgroundExecution(IPentahoSession, String) - Method in interface org.pentaho.platform.api.engine.IBackgroundExecution
This provides an entry point for tracking the created background execution task
trackTempFile(File) - Method in interface org.pentaho.platform.api.util.ITempFileDeleter
Adds the provided file to the list of files being tracked
TRANSACTION_ISOLATION_NONE_VALUE - Static variable in interface org.pentaho.platform.api.data.IDBDatasourceService
 
TYPE_CONTENT - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
Parameter type indicating streamable content.
TYPE_DATE - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
Parameter type of Date
TYPE_DECIMAL - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
Parameter type of BigDecimal
TYPE_INTEGER - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
Parameter type of int
TYPE_LIST - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
Parameter type of List.
TYPE_OBJECT - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
Parameter type indicating any type of Object
TYPE_RESULT_SET - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
Parameter type of IPentahoResultSet
TYPE_STRING - Static variable in interface org.pentaho.platform.api.engine.IActionParameter
Parameter type of String

U

UIException - Exception in org.pentaho.platform.api.ui
 
UIException() - Constructor for exception org.pentaho.platform.api.ui.UIException
 
UIException(String) - Constructor for exception org.pentaho.platform.api.ui.UIException
 
UIException(String, Throwable) - Constructor for exception org.pentaho.platform.api.ui.UIException
 
UIException(Throwable) - Constructor for exception org.pentaho.platform.api.ui.UIException
 
UncategorizedUserRoleDaoException - Exception in org.pentaho.platform.api.engine.security.userroledao
Represents some other, usually fatal, exception.
UncategorizedUserRoleDaoException(String) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.UncategorizedUserRoleDaoException
 
UncategorizedUserRoleDaoException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.UncategorizedUserRoleDaoException
 
undeleteFile(Serializable, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Recovers a deleted file if it was not permanently deleted.
UnifiedRepositoryAccessDeniedException - Exception in org.pentaho.platform.api.repository2.unified
An exception that can be thrown from IUnifiedRepository implementations.
UnifiedRepositoryAccessDeniedException() - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryAccessDeniedException
 
UnifiedRepositoryAccessDeniedException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryAccessDeniedException
 
UnifiedRepositoryAccessDeniedException(String) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryAccessDeniedException
 
UnifiedRepositoryAccessDeniedException(Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryAccessDeniedException
 
UnifiedRepositoryCreateFileException - Exception in org.pentaho.platform.api.repository2.unified
An exception that can be thrown from IUnifiedRepository implementations.
UnifiedRepositoryCreateFileException() - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryCreateFileException
 
UnifiedRepositoryCreateFileException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryCreateFileException
 
UnifiedRepositoryCreateFileException(String) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryCreateFileException
 
UnifiedRepositoryCreateFileException(Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryCreateFileException
 
UnifiedRepositoryException - Exception in org.pentaho.platform.api.repository2.unified
An exception that can be thrown from IUnifiedRepository implementations.
UnifiedRepositoryException() - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryException
 
UnifiedRepositoryException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryException
 
UnifiedRepositoryException(String) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryException
 
UnifiedRepositoryException(Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryException
 
UnifiedRepositoryFileExistsException - Exception in org.pentaho.platform.api.repository2.unified
An exception that can be thrown from IUnifiedRepository implementations.
UnifiedRepositoryFileExistsException() - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryFileExistsException
 
UnifiedRepositoryFileExistsException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryFileExistsException
 
UnifiedRepositoryFileExistsException(String) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryFileExistsException
 
UnifiedRepositoryFileExistsException(Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryFileExistsException
 
UnifiedRepositoryMalformedNameException - Exception in org.pentaho.platform.api.repository2.unified
An exception that can be thrown from IUnifiedRepository implementations.
UnifiedRepositoryMalformedNameException() - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryMalformedNameException
 
UnifiedRepositoryMalformedNameException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryMalformedNameException
 
UnifiedRepositoryMalformedNameException(String) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryMalformedNameException
 
UnifiedRepositoryMalformedNameException(Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryMalformedNameException
 
UnifiedRepositoryReferentialIntegrityException - Exception in org.pentaho.platform.api.repository2.unified
An exception that can be thrown from IUnifiedRepository implementations.
UnifiedRepositoryReferentialIntegrityException() - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryReferentialIntegrityException
 
UnifiedRepositoryReferentialIntegrityException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryReferentialIntegrityException
 
UnifiedRepositoryReferentialIntegrityException(String) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryReferentialIntegrityException
 
UnifiedRepositoryReferentialIntegrityException(Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryReferentialIntegrityException
 
UnifiedRepositoryUpdateFileException - Exception in org.pentaho.platform.api.repository2.unified
An exception that can be thrown from IUnifiedRepository implementations.
UnifiedRepositoryUpdateFileException() - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryUpdateFileException
 
UnifiedRepositoryUpdateFileException(String, Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryUpdateFileException
 
UnifiedRepositoryUpdateFileException(String) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryUpdateFileException
 
UnifiedRepositoryUpdateFileException(Throwable) - Constructor for exception org.pentaho.platform.api.repository2.unified.UnifiedRepositoryUpdateFileException
 
UNKNOWN - Static variable in interface org.pentaho.platform.api.engine.ILogger
 
UNKNOWN_RESOURCE - Static variable in interface org.pentaho.platform.api.engine.IActionSequenceResource
The resource type is unknown
unloadAllPlugins() - Method in interface org.pentaho.platform.api.engine.IPluginManager
Unloads all the plugins.
unLoaded() - Method in interface org.pentaho.platform.api.engine.IPlatformPlugin
 
unLoaded() - Method in interface org.pentaho.platform.api.engine.IPluginLifecycleListener
Called when the plugin needs to be unloaded.
unlockFile(Serializable) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Unlocks a file.
unRegister(ILastModifiedCacheItem) - Method in interface org.pentaho.platform.api.cache.ICacheExpirationRegistry
.
unregister(T) - Method in interface org.pentaho.platform.api.monitoring.IMonitoringService
unregister a subscriber ( a.k.a.
UnresolvedParameterException - Exception in org.pentaho.platform.api.engine
 
UnresolvedParameterException() - Constructor for exception org.pentaho.platform.api.engine.UnresolvedParameterException
 
UnresolvedParameterException(String) - Constructor for exception org.pentaho.platform.api.engine.UnresolvedParameterException
 
UnresolvedParameterException(String, String) - Constructor for exception org.pentaho.platform.api.engine.UnresolvedParameterException
 
UnresolvedParameterException(String, Throwable, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.UnresolvedParameterException
 
UnresolvedParameterException(String, String, String, String, IActionDefinition) - Constructor for exception org.pentaho.platform.api.engine.UnresolvedParameterException
 
update(Properties) - Method in interface org.pentaho.platform.api.engine.IConfiguration
 
updateAcl(RepositoryFileAcl) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Updates an ACL.
updateDatasourceById(String, IDatabaseConnection) - Method in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
Updates a given JDBC datasource by id
updateDatasourceByName(String, IDatabaseConnection) - Method in interface org.pentaho.platform.api.repository.datasource.IDatasourceMgmtService
Updates a given JDBC datasource by name
updateFile(RepositoryFile, IRepositoryFileData, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Updates a file and/or the data of a file.
updateFolder(RepositoryFile, String) - Method in interface org.pentaho.platform.api.repository2.unified.IUnifiedRepository
Updates a file and/or the data of a file.
updateTentant(String, Map<String, Serializable>) - Method in interface org.pentaho.platform.api.mt.ITenantManager
Updates tenant with the items in tenant info.
URL_RESOURCE - Static variable in interface org.pentaho.platform.api.engine.IActionSequenceResource
The resource is a URL
UserRoleDaoException - Exception in org.pentaho.platform.api.engine.security.userroledao
Superclass of all exception types thrown by IUserRoleDao implementations.
UserRoleDaoException(String) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.UserRoleDaoException
 
UserRoleDaoException(String, Throwable) - Constructor for exception org.pentaho.platform.api.engine.security.userroledao.UserRoleDaoException
 
UserRoleInfo - Class in org.pentaho.platform.api.engine.security.userroledao
 
UserRoleInfo() - Constructor for class org.pentaho.platform.api.engine.security.userroledao.UserRoleInfo
 
usesHibernate() - Method in interface org.pentaho.platform.api.repository.IRuntimeRepository
 

V

validate() - Method in interface org.pentaho.platform.api.engine.IComponent
Validate that the Component has all the necessary inputs, outputs and resources it needs to execute successfully.
validate() - Method in interface org.pentaho.platform.api.engine.ISimplePojoComponent
Deprecated.
 
validate() - Method in interface org.pentaho.platform.api.ui.IUIComponent
 
validate(IPentahoSession, IActionRequestHandler) - Method in interface org.pentaho.platform.api.ui.IUIComponent
Set the userSession member, generate a Log Id, set the requestHandler, and validate the component's configuration.
validated(IRuntimeContext) - Method in interface org.pentaho.platform.api.engine.IExecutionListener
 
validateSequence(String, IExecutionListener) - Method in interface org.pentaho.platform.api.engine.IRuntimeContext
Validates the action sequence for consistency
valueOf(String) - Static method in enum org.pentaho.platform.api.engine.IPentahoDefinableObjectFactory.Scope
Deprecated.
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory.Types
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pentaho.platform.api.engine.IPlatformPlugin.ClassLoaderType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pentaho.platform.api.engine.IServerStatusProvider.ServerStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pentaho.platform.api.monitoring.snmp.SnmpVariable.TYPE
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pentaho.platform.api.repository2.unified.data.node.DataNode.DataPropertyType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pentaho.platform.api.repository2.unified.RepositoryFilePermission
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pentaho.platform.api.repository2.unified.RepositoryFileSid.Type
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.pentaho.platform.api.repository2.unified.RepositoryRequest.FILES_TYPE_FILTER
Returns the enum constant of this type with the specified name.
values() - Static method in enum org.pentaho.platform.api.engine.IPentahoDefinableObjectFactory.Scope
Deprecated.
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pentaho.platform.api.engine.IPentahoRegistrableObjectFactory.Types
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pentaho.platform.api.engine.IPlatformPlugin.ClassLoaderType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pentaho.platform.api.engine.IServerStatusProvider.ServerStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pentaho.platform.api.monitoring.snmp.SnmpVariable.TYPE
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pentaho.platform.api.repository2.unified.data.node.DataNode.DataPropertyType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pentaho.platform.api.repository2.unified.RepositoryFilePermission
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pentaho.platform.api.repository2.unified.RepositoryFileSid.Type
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.pentaho.platform.api.repository2.unified.RepositoryRequest.FILES_TYPE_FILTER
Returns an array containing the constants of this enum type, in the order they are declared.
versioned(boolean) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
versionId(Serializable) - Method in class org.pentaho.platform.api.repository2.unified.RepositoryFile.Builder
 
VersionSummary - Class in org.pentaho.platform.api.repository2.unified
Immutable version summary for a RepositoryFile.
VersionSummary(Serializable, Serializable, boolean, Date, String, String, List<String>) - Constructor for class org.pentaho.platform.api.repository2.unified.VersionSummary
 
VersionSummaryDto - Class in org.pentaho.platform.api.repository2.unified.webservices
 
VersionSummaryDto() - Constructor for class org.pentaho.platform.api.repository2.unified.webservices.VersionSummaryDto
 

W

WARN - Static variable in interface org.pentaho.platform.api.engine.ILogger
The WARN level designates potentially harmful situations.
warn(String) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message object with the WARN Level.
warn(String, Throwable) - Method in interface org.pentaho.platform.api.engine.ILogger
Log a message with the WARN level including the stack trace of the Throwable error passed as parameter.

X

XML - Static variable in interface org.pentaho.platform.api.engine.IActionSequenceResource
The resource type is embedded xml
XmlParseException - Exception in org.pentaho.platform.api.util
 
XmlParseException() - Constructor for exception org.pentaho.platform.api.util.XmlParseException
 
XmlParseException(String) - Constructor for exception org.pentaho.platform.api.util.XmlParseException
 
XmlParseException(String, Throwable) - Constructor for exception org.pentaho.platform.api.util.XmlParseException
 
XmlParseException(Throwable) - Constructor for exception org.pentaho.platform.api.util.XmlParseException
 

_

_printStack(IActionSequenceExecutableStatement, PrintWriter, String) - Method in exception org.pentaho.platform.api.engine.ActionSequenceException
 
A B C D E F G H I J K L M N O P Q R S T U V W X _ 
Skip navigation links

Copyright © 2020 Hitachi Vantara. All rights reserved.