Index

A B C D E F G H I J K L M N O P R S T U V W X Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AboutInstance(AboutInstance) - Constructor for class com.appliedolap.essbase.impl.EssServerImpl.AboutInstance
 
AbstractEssObject - Class in com.appliedolap.essbase
Parent class for all objects in this library's object hierarchy.
AbstractEssObject(ApiContext) - Constructor for class com.appliedolap.essbase.AbstractEssObject
 
ACCOUNT - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
 
ACCOUNTS - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionType
 
action(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
An action this does not model, by its element name and attributes.
ADD - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
 
addGroups(String...) - Method in interface com.appliedolap.essbase.EssGroup
Adds groups as members of this group.
addGroups(String...) - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
addMember(String, String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Adds a member, failing with a warning if it already exists.
addOrUpdateMember(String, String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Adds the member, or updates it where it already exists.
addUsers(String...) - Method in interface com.appliedolap.essbase.EssGroup
Adds users to this group.
addUsers(String...) - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
after(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.Action
Puts the member right after the given sibling.
after(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
AI - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
alias(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
An alias in the Default table.
alias(String, String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
ALIAS - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxIdentifierType
 
aliasTableName(String) - Method in class com.appliedolap.essbase.EssMdxOptions
Which alias table to take aliases from, when members are named by alias.
ALL_DATA - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Restructure
 
ALL_LEVELS - Enum constant in enum class com.appliedolap.essbase.EssCubeView.ZoomInPreference
 
ambiguousMemberNames(String) - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
The names this file cannot set every property on, because they appear more than once.
ancestorOnTop() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the ancestorOnTop record component.
api - Variable in class com.appliedolap.essbase.AbstractEssObject
 
ApiClientFactory - Class in com.appliedolap.essbase
 
ApiClientFactory(String, EssAuthentication) - Constructor for class com.appliedolap.essbase.ApiClientFactory
Builds clients that authenticate however the given strategy says to, which need not involve a username and password at all - see EssAuthentication.
ApiClientFactory(String, String, String) - Constructor for class com.appliedolap.essbase.ApiClientFactory
 
ApiClientFactory(String, String, String, boolean) - Constructor for class com.appliedolap.essbase.ApiClientFactory
 
ApiContext - Class in com.appliedolap.essbase
Serves as a holder for all the various API interfaces.
ApiContext(ApiClient) - Constructor for class com.appliedolap.essbase.ApiContext
 
ApiContext(ApiClient, EssAuthentication) - Constructor for class com.appliedolap.essbase.ApiContext
 
APPLICATION - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
APPLICATION - Enum constant in enum class com.appliedolap.essbase.EssVariable.Scope
 
APPLICATION_NOT_ASSOCIATED - Enum constant in enum class com.appliedolap.essbase.EssAiReadiness.State
The server has at least one AI connection, but this cube's application is not associated with one.
applicationsApi() - Method in class com.appliedolap.essbase.ApiContext
 
ASCENDING - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.SortOrder
 
ASK_ESSBASE - Enum constant in enum class com.appliedolap.essbase.EssAiFeature
Free-form chat about a cube.
ASO - Enum constant in enum class com.appliedolap.essbase.EssServer.ApplicationType
ASO/Aggregate Storage Option
associateAttribute(String, String, String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Associates one attribute member with a base member.
associateAttributeDimension(String, String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Attaches an attribute dimension to a base dimension.
attribute(String, Object) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.Action
Sets an attribute the builder does not otherwise expose.
attribute(String, Object) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionAction
 
attribute(String, Object) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
ATTRIBUTE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
 
ATTRIBUTE - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionType
 
ATTRIBUTE_CALC - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionType
 
authorizationHeader() - Method in interface com.appliedolap.essbase.EssAuthentication
The value for the Authorization header, or null to send none.
authorizationHeader() - Method in class com.appliedolap.essbase.impl.BasicAuthentication
 
authorizationHeader() - Method in class com.appliedolap.essbase.impl.BearerTokenAuthentication
 
authorizationHeader() - Method in class com.appliedolap.essbase.impl.SessionAuthentication
 
authorizationHeader() - Method in class com.appliedolap.essbase.impl.SessionCookieAuthentication
 
AVERAGE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.TimeBalance
 

B

basic(String, String) - Static method in interface com.appliedolap.essbase.EssAuthentication
Username and password on every request, with no session.
BasicAuthentication - Class in com.appliedolap.essbase.impl
HTTP Basic on every request, never establishing a session.
BasicAuthentication(String, String) - Constructor for class com.appliedolap.essbase.impl.BasicAuthentication
 
batchOutlineEdit(EssBatchOutlineEdit) - Method in interface com.appliedolap.essbase.EssCube
Applies a batch outline edit built with EssBatchOutlineEdit.
batchOutlineEdit(EssBatchOutlineEdit) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
batchOutlineEdit(String) - Method in interface com.appliedolap.essbase.EssCube
Applies a batch outline edit document to this cube's outline.
batchOutlineEdit(String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
Posts a batch outline edit document and reads the server's log back.
bearerToken(String) - Static method in interface com.appliedolap.essbase.EssAuthentication
A bearer token, sent as Authorization: Bearer <token>.
BearerTokenAuthentication - Class in com.appliedolap.essbase.impl
An OAuth-style bearer token.
BearerTokenAuthentication(String) - Constructor for class com.appliedolap.essbase.impl.BearerTokenAuthentication
 
BI - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
BOTH - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Skip
 
BOTTOM_LEVEL - Enum constant in enum class com.appliedolap.essbase.EssCubeView.ZoomInPreference
 
BSO - Enum constant in enum class com.appliedolap.essbase.EssServer.ApplicationType
BSO/Block Storage Option (including hybrid)
BUILD_AGGREGATION - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
BUILD_DIMENSIONS - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
byMemberId() - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.Action
Says that the member names in this action are actually member ids.
byMemberId() - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionAction
 
byMemberId() - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 

C

CALC - Enum constant in enum class com.appliedolap.essbase.EssScript.ScriptType
A calculation script.
calculate() - Method in interface com.appliedolap.essbase.EssCube
Runs the default calculation, aggregating the cube.
calculate() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
CALC ALL is what "the default calculation" means for a block storage cube.
calculate(String) - Method in interface com.appliedolap.essbase.EssCube
Runs a calculation given as script text rather than a stored script.
calculate(String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
CALCULATION - Enum constant in enum class com.appliedolap.essbase.EssAiFeature
Writing a calculation script from a description.
call(String, Map<String, Object>) - Method in interface com.appliedolap.essbase.EssMcp
Runs one tool.
call(String, Map<String, Object>) - Method in class com.appliedolap.essbase.impl.EssMcpImpl
 
category(EssBatchOutlineEdit.DimensionCategory) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionAction
 
cell(int, int) - Static method in class com.appliedolap.essbase.EssCubeView.Range
A single cell.
cellAttributes(boolean) - Method in class com.appliedolap.essbase.EssMdxOptions
Sets the server's cellAttributes preference.
CellEdit(int, int, String) - Constructor for record class com.appliedolap.essbase.EssCubeView.CellEdit
Creates an instance of a CellEdit record class.
cellIndex(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
The flat index of a cell, which is how the pivot actions address one.
CHILDREN - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.ApplyTo
 
CLEAR_AGGREGATIONS - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
CLEAR_DATA - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
clearConversationHistory(String) - Method in interface com.appliedolap.essbase.EssCubeAi
Forgets a conversation on the server, so a later question doesn't inherit its context.
clearConversationHistory(String) - Method in class com.appliedolap.essbase.impl.EssCubeAiImpl
 
close() - Method in class com.appliedolap.essbase.EssPlanningSnapshot
 
col() - Method in record class com.appliedolap.essbase.EssCubeView.CellEdit
Returns the value of the col record component.
col() - Method in record class com.appliedolap.essbase.EssCubeView.MemberPlacement
Returns the value of the col record component.
Column(String, String) - Constructor for class com.appliedolap.essbase.EssDrillthroughResult.Column
 
com.appliedolap.essbase - package com.appliedolap.essbase
The classes in this package model client API that works with the Essbase REST API.
com.appliedolap.essbase.exceptions - package com.appliedolap.essbase.exceptions
Specific EssApiException subtypes for error conditions callers may want to catch and handle individually, rather than the generic base exception every other API failure surfaces as.
com.appliedolap.essbase.impl - package com.appliedolap.essbase.impl
Implementations of the public API interfaces declared in com.appliedolap.essbase, backed by the generated REST client in com.appliedolap.essbase.client.
com.appliedolap.essbase.misc - package com.appliedolap.essbase.misc
Response models for REST endpoints whose JSON shape doesn't correspond to a generated model class.
comment(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
COMPLETED - Enum constant in enum class com.appliedolap.essbase.EssJob.Status
 
COMPLETED_WITH_WARNINGS - Enum constant in enum class com.appliedolap.essbase.EssJob.Status
 
configuration() - Method in interface com.appliedolap.essbase.EssApplication
This application's configuration, as something to read and change.
configuration() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
configured() - Method in interface com.appliedolap.essbase.EssApplicationConfig
Only the keys this application actually sets.
CONNECTION - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
consolidation(EssBatchOutlineEdit.Consolidation) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
cookieHeader() - Method in interface com.appliedolap.essbase.EssAuthentication
The value for the Cookie header, or null to send none.
cookieHeader() - Method in class com.appliedolap.essbase.impl.SessionAuthentication
 
cookieHeader() - Method in class com.appliedolap.essbase.impl.SessionCookieAuthentication
 
copy(EssFilePathDetail, Boolean) - Method in interface com.appliedolap.essbase.EssFile
Copy a file from source to destination.
copy(EssFilePathDetail, Boolean) - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
copy(String) - Method in interface com.appliedolap.essbase.EssApplication
Copies this application to a new application with the given name.
copy(String) - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
COUNTRY - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
 
COUNTRY - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionType
 
create() - Method in class com.appliedolap.essbase.ApiClientFactory
 
create() - Static method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
createApplication(String, String) - Method in interface com.appliedolap.essbase.EssServer
Creates an application (and a database) with the given names.
createApplication(String, String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
createApplication(String, String, EssServerImpl.DatabaseCreateOptions) - Method in interface com.appliedolap.essbase.EssServer
Create an application/database with the given name and options.
createApplication(String, String, EssServerImpl.DatabaseCreateOptions) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
createApplicationFromWorkbook(String, String, EssFile) - Method in interface com.appliedolap.essbase.EssServer
Creates or updates an application from an uploaded workbook.
createApplicationFromWorkbook(String, String, EssFile) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
createApplicationFromWorkbook(String, String, EssFile, EssWorkbookImportOptions) - Method in interface com.appliedolap.essbase.EssServer
Builds or updates an application from a workbook, choosing what the import should do.
createApplicationFromWorkbook(String, String, EssFile, EssWorkbookImportOptions) - Method in class com.appliedolap.essbase.impl.EssServerImpl
Every flag is sent as the string "true" or "false" rather than a JSON boolean, which is not a style choice - the parameters bean types them as strings and the server rejects real booleans here.
createDrillthroughDataSource(String, String, List<String>, Map<String, EssDrillthroughColumnMapping>, List<String>) - Method in interface com.appliedolap.essbase.EssCube
Creates a drill-through report that reads its detail from a data source.
createDrillthroughDataSource(String, String, List<String>, Map<String, EssDrillthroughColumnMapping>, List<String>) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
createDrillthroughURL(String, String, List<String>) - Method in interface com.appliedolap.essbase.EssCube
Creates a URL-type drill-through on the cube,
createDrillthroughURL(String, String, List<String>) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
createFileConnection(String, String, String) - Method in interface com.appliedolap.essbase.EssServer
Creates a connection to a file in the Essbase catalogue.
createFileConnection(String, String, String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
createFiles(boolean) - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
Whether to create the scripts, rules and queries the workbook defines.
createGroup(String, String, String) - Method in interface com.appliedolap.essbase.EssServer
Creates a group.
createGroup(String, String, String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
createScript(EssScript.ScriptType, String, String) - Method in interface com.appliedolap.essbase.EssCube
Creates a script on this cube.
createScript(EssScript.ScriptType, String, String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
createSubFolder(String) - Method in interface com.appliedolap.essbase.EssFolder
Creates a subfolder in this folder.
createSubFolder(String) - Method in class com.appliedolap.essbase.impl.EssFolderImpl
 
createVariable(String, String) - Method in interface com.appliedolap.essbase.EssApplication
Defines a new variable on this application, visible to its cubes.
createVariable(String, String) - Method in interface com.appliedolap.essbase.EssCube
Defines a new variable on this cube, shadowing any application or server variable of the same name for anything running against it.
createVariable(String, String) - Method in interface com.appliedolap.essbase.EssServer
Creates a new server-wide variable with the given name and value.
createVariable(String, String) - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
createVariable(String, String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
createVariable(String, String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
CSV - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxOutputType
 
CUBE - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
CUBE - Enum constant in enum class com.appliedolap.essbase.EssVariable.Scope
 
CURRENCY_PARTITION - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
 
CURRENCY_PARTITION - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionType
 
CURRENCY_TYPE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
 
currentAuthorizationHeader() - Method in class com.appliedolap.essbase.ApiClientFactory
Returns the current Authorization header value, matching what the request interceptor would apply, or null when the current strategy sends none.
currentCookieHeader() - Method in class com.appliedolap.essbase.ApiClientFactory
Returns the current Cookie header value, or null when the current strategy sends none.

D

DATA - Enum constant in enum class com.appliedolap.essbase.EssCubeView.CellType
 
DatabaseCreateOptions() - Constructor for class com.appliedolap.essbase.impl.EssServerImpl.DatabaseCreateOptions
 
dataless(boolean) - Method in class com.appliedolap.essbase.EssMdxOptions
Whether to leave the data out and return only the members.
DATASOURCE - Enum constant in enum class com.appliedolap.essbase.EssDrillthrough.DrillthroughType
 
DATASOURCE - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
dataStorage(EssBatchOutlineEdit.DataStorage) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
DB - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
DB2 - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
DEFAULT_PROFILE - Static variable in class com.appliedolap.essbase.impl.EssCubeAiImpl
The profile every 26.1 server is set up with.
DEFAULT_REST_API_PATH - Static variable in interface com.appliedolap.essbase.EssServer
 
defaults() - Static method in class com.appliedolap.essbase.EssMdxOptions
No options set: the server's defaults, as for a plain query.
defaults() - Static method in class com.appliedolap.essbase.EssWorkbookImportOptions
Loads the data and runs the scripts; does not recreate an existing application.
delete() - Method in interface com.appliedolap.essbase.EssApplication
Deletes this application.
delete() - Method in interface com.appliedolap.essbase.EssApplicationConfiguration
Removes this key from the application's configuration, leaving the setting at whatever default Essbase applies.
delete() - Method in interface com.appliedolap.essbase.EssConnection
 
delete() - Method in interface com.appliedolap.essbase.EssDrillthrough
Deletes this drill-through report
delete() - Method in interface com.appliedolap.essbase.EssFile
Delete this file.
delete() - Method in interface com.appliedolap.essbase.EssGroup
Removes this group.
delete() - Method in interface com.appliedolap.essbase.EssScript
 
delete() - Method in interface com.appliedolap.essbase.EssVariable
Deletes this variable, at its own scope.
delete() - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
 
delete() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
delete() - Method in class com.appliedolap.essbase.impl.EssApplicationVariableImpl
 
delete() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
 
delete() - Method in class com.appliedolap.essbase.impl.EssCubeVariableImpl
 
delete() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
delete() - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
delete() - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
delete() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
delete() - Method in class com.appliedolap.essbase.impl.EssServerVariableImpl
 
delete(String) - Method in interface com.appliedolap.essbase.EssApplicationConfig
Removes a key from the application's configuration.
deleteDataSource(String) - Method in interface com.appliedolap.essbase.EssServer
Removes a global data source.
deleteDataSource(String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
deleteMarked(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
deleteMember(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
deleteWorkbookOnSuccess(boolean) - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
Whether to delete the workbook from the catalogue once the import succeeds.
DELIMITEDFILE - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
DELIMITER_SPACE - Static variable in interface com.appliedolap.essbase.EssDataSource
 
DELIMITER_TAB - Static variable in interface com.appliedolap.essbase.EssDataSource
 
DENSE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionStorage
 
DENSE - Enum constant in enum class com.appliedolap.essbase.EssDimension.StorageType
 
DENSE - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionStorage
 
DESCENDANTS - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.ApplyTo
 
DESCENDING - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.SortOrder
 
describe() - Method in record class com.appliedolap.essbase.EssApiSpec
e.g.
DIMENSION - Enum constant in enum class com.appliedolap.essbase.EssDrillthroughColumnMapping.MappingType
 
DIMENSION - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
DimensionPlacement(String, EssCubeView.DimensionPlacement.Region, int) - Constructor for record class com.appliedolap.essbase.EssCubeView.DimensionPlacement
Creates an instance of a DimensionPlacement record class.
DISABLED_ON_SERVER - Enum constant in enum class com.appliedolap.essbase.EssAiReadiness.State
The server can do AI but has it switched off wholesale - aiEnabled is false - so no capability is available whatever else is configured.
dissociateAttributes(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Removes every attribute association from a base member - all of them, not a named one.
DIVIDE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
 
download() - Method in interface com.appliedolap.essbase.EssFile
Downloads this file to the current directory
download() - Method in interface com.appliedolap.essbase.EssUtility
 
download() - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
download() - Method in class com.appliedolap.essbase.impl.EssUtilityImpl
 
downloadAllLogsAsZip(OutputStream) - Method in interface com.appliedolap.essbase.EssApplication
Writes all logs to the given output stream.
downloadAllLogsAsZip(OutputStream) - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
downloadLatestLog(OutputStream) - Method in interface com.appliedolap.essbase.EssApplication
Writes the latest application log to the given output stream.
downloadLatestLog(OutputStream) - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
downloadLatestServerLog(String, OutputStream) - Method in interface com.appliedolap.essbase.EssServer
Writes the latest server log of the given type to the stream.
downloadLatestServerLog(String, OutputStream) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
downloadProvisionReport(File) - Method in interface com.appliedolap.essbase.EssApplication
Downloads this application's provisioning report.
downloadProvisionReport(File) - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
Fetched by hand because the endpoint answers with a spreadsheet, not a model.
downloadServerLogsAsZip(String, OutputStream) - Method in interface com.appliedolap.essbase.EssServer
Writes every server log of the given type, as a zip, to the stream.
downloadServerLogsAsZip(String, OutputStream) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
downloadTo(File) - Method in interface com.appliedolap.essbase.EssFile
Downloads this file to exactly the given path, whatever it is called on the server.
downloadTo(File) - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
downloadToFolder(File) - Method in interface com.appliedolap.essbase.EssFile
Downloads the file to a particular folder).
downloadToFolder(File) - Method in interface com.appliedolap.essbase.EssOutline
 
downloadToFolder(File) - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
downloadToFolder(File) - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
 
downloadXml() - Method in interface com.appliedolap.essbase.EssOutline
Downloads the outline XML as a byte array.
downloadXml() - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
 
DRILLTHROUGH - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
DrillthroughColumnMismatchException - Exception in com.appliedolap.essbase.exceptions
 
DrillthroughColumnMismatchException(EssDrillthrough, String, String) - Constructor for exception com.appliedolap.essbase.exceptions.DrillthroughColumnMismatchException
 
DYNAMIC - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.HierarchyType
 
DYNAMIC_CALC - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DataStorage
 
DYNAMIC_CALC - Enum constant in enum class com.appliedolap.essbase.EssMember.DataStorage
Calculated on retrieval and not written to the cube.
DYNAMIC_CALC_AND_STORE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DataStorage
 
DYNAMIC_CALC_AND_STORE - Enum constant in enum class com.appliedolap.essbase.EssMember.DataStorage
Calculated on retrieval and then written.

E

edit(Variable) - Method in class com.appliedolap.essbase.impl.EssApplicationVariableImpl
 
edit(Variable) - Method in class com.appliedolap.essbase.impl.EssCubeVariableImpl
 
edit(Variable) - Method in class com.appliedolap.essbase.impl.EssServerVariableImpl
 
edit(Variable) - Method in class com.appliedolap.essbase.impl.EssVariableImpl
Sends the edit to whichever endpoint owns this scope.
ENABLED_FLAG - Static variable in enum class com.appliedolap.essbase.EssAiFeature
The flag for AI as a whole; every capability is off when this is.
equals(Object) - Method in record class com.appliedolap.essbase.EssApiSpec
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.appliedolap.essbase.EssCubeView.CellEdit
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.appliedolap.essbase.EssCubeView.DimensionPlacement
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class com.appliedolap.essbase.EssCubeView.MemberPlacement
Indicates whether some other object is "equal to" this one.
ERROR - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEditResult.Severity
 
ERROR - Enum constant in enum class com.appliedolap.essbase.EssLogEntry.Severity
 
EssAiFeature - Enum Class in com.appliedolap.essbase
The generative-AI capabilities a server can offer, each independently switchable.
EssAiReadiness - Class in com.appliedolap.essbase
Why a cube's AI features will or won't work, worked out before calling one of them.
EssAiReadiness.State - Enum Class in com.appliedolap.essbase
 
EssApiException - Exception in com.appliedolap.essbase
A general, unchecked exception that we can be used to wrap the ApiException checked exceptions that are all over the generated client code.
EssApiException(String) - Constructor for exception com.appliedolap.essbase.EssApiException
 
EssApiException(String, Throwable) - Constructor for exception com.appliedolap.essbase.EssApiException
For adding context a caller has and the cause does not - which part of an upload failed, say.
EssApiException(Throwable) - Constructor for exception com.appliedolap.essbase.EssApiException
 
EssApiSpec - Record Class in com.appliedolap.essbase
The server's own machine-readable description of its REST API - what its Swagger UI renders.
EssApiSpec(String, String, String) - Constructor for record class com.appliedolap.essbase.EssApiSpec
Creates an instance of a EssApiSpec record class.
EssApplication - Interface in com.appliedolap.essbase
 
EssApplication.Status - Enum Class in com.appliedolap.essbase
An enumeration for the different application states.
EssApplicationConfig - Interface in com.appliedolap.essbase
An application's configuration, as a small language for reading and changing it.
EssApplicationConfiguration - Interface in com.appliedolap.essbase
One application configuration setting - a key from Essbase's catalogue, what it is for, and the value this application gives it if any.
EssApplicationConfigurationImpl - Class in com.appliedolap.essbase.impl
One configuration key on an application: the catalogue entry describing it, and the value this application gives it if any.
EssApplicationImpl - Class in com.appliedolap.essbase.impl
Represents an Essbase application object.
EssApplicationImpl(ApiContext, EssServer, Application) - Constructor for class com.appliedolap.essbase.impl.EssApplicationImpl
 
EssApplicationVariable - Interface in com.appliedolap.essbase
A substitution variable defined on an application, visible to its cubes unless one of them defines the same name, and invisible to every other application.
EssApplicationVariableImpl - Class in com.appliedolap.essbase.impl
A variable defined on an application.
EssAuthentication - Interface in com.appliedolap.essbase
How a client proves who it is to Essbase.
ESSBASE - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
ESSBASE_NETWORK_LOGGING - Static variable in class com.appliedolap.essbase.ApiClientFactory
 
EssBatchOutlineEdit - Class in com.appliedolap.essbase
A batch outline edit document, built action by action.
EssBatchOutlineEdit() - Constructor for class com.appliedolap.essbase.EssBatchOutlineEdit
 
EssBatchOutlineEdit.Action - Class in com.appliedolap.essbase
One action in the document.
EssBatchOutlineEdit.ApplyTo - Enum Class in com.appliedolap.essbase
Which members a dataStorageSet applies to.
EssBatchOutlineEdit.Consolidation - Enum Class in com.appliedolap.essbase
How the server consolidates a member into its parent.
EssBatchOutlineEdit.DataStorage - Enum Class in com.appliedolap.essbase
Where a member's data lives.
EssBatchOutlineEdit.DimensionAction - Class in com.appliedolap.essbase
A dimUpdate, which carries a properties block rather than a mbrInfo.
EssBatchOutlineEdit.DimensionCategory - Enum Class in com.appliedolap.essbase
A dimension's type, in the schema's vocabulary.
EssBatchOutlineEdit.DimensionStorage - Enum Class in com.appliedolap.essbase
Whether a dimension's blocks are dense or sparse.
EssBatchOutlineEdit.HierarchyType - Enum Class in com.appliedolap.essbase
How a hierarchy under a dimension is aggregated.
EssBatchOutlineEdit.MemberAction - Class in com.appliedolap.essbase
An action carrying a mbrInfo block - add, addOrUpdate, update.
EssBatchOutlineEdit.Restructure - Enum Class in com.appliedolap.essbase
What to restructure after the edit.
EssBatchOutlineEdit.Skip - Enum Class in com.appliedolap.essbase
What a time-balance member skips.
EssBatchOutlineEdit.SortOrder - Enum Class in com.appliedolap.essbase
 
EssBatchOutlineEdit.TimeBalance - Enum Class in com.appliedolap.essbase
Time balance, for an accounts dimension.
EssBatchOutlineEditResult - Class in com.appliedolap.essbase
What a batch outline edit did, read out of the log the server sends back.
EssBatchOutlineEditResult(String) - Constructor for class com.appliedolap.essbase.EssBatchOutlineEditResult
Public so a caller that already has a log - one captured from a job, or replayed from a file - can read it with the same parsing the live call uses.
EssBatchOutlineEditResult.Message - Class in com.appliedolap.essbase
One labelled line of the log, kept whole alongside the bits worth reading separately.
EssBatchOutlineEditResult.Severity - Enum Class in com.appliedolap.essbase
How the server labels a line: Info[1370001]:, Warn[1370101]:, Error[1370271]:.
EssConnection - Interface in com.appliedolap.essbase
A named, reusable pointer to somewhere data lives, plus how to reach it.
EssConnection.ConnectionType - Enum Class in com.appliedolap.essbase
The kinds of connection Essbase models.
EssConnectionImpl - Class in com.appliedolap.essbase.impl
A global connection on the server.
EssCube - Interface in com.appliedolap.essbase
 
EssCube.MdxIdentifierType - Enum Class in com.appliedolap.essbase
 
EssCube.MdxOutputType - Enum Class in com.appliedolap.essbase
 
EssCubeAi - Interface in com.appliedolap.essbase
The generative-AI features a 26.1 server offers over one cube, reached through EssCube.getAi().
EssCubeAiImpl - Class in com.appliedolap.essbase.impl
The AI capabilities of one cube, spoken to over the /ai endpoints a 26.1 server adds.
EssCubeAiImpl(ApiContext, EssCube) - Constructor for class com.appliedolap.essbase.impl.EssCubeAiImpl
 
EssCubeImpl - Class in com.appliedolap.essbase.impl
Represents an Essbase cube on the server.
EssCubeImpl(ApiContext, EssApplication, Cube) - Constructor for class com.appliedolap.essbase.impl.EssCubeImpl
 
EssCubeImpl.ExcelExportOptions - Class in com.appliedolap.essbase.impl
 
EssCubeImpl.MdxOptions - Class in com.appliedolap.essbase.impl
Deprecated.
since 2.1.0. Use EssMdxOptions, which is sent.
EssCubeVariable - Interface in com.appliedolap.essbase
A substitution variable defined on one cube, which shadows an application or server variable of the same name for queries and calculations against that cube.
EssCubeVariableImpl - Class in com.appliedolap.essbase.impl
A variable defined on one cube, which shadows an application or server variable of the same name for anything running against that cube.
EssCubeView - Interface in com.appliedolap.essbase
A live, navigable ad hoc grid on a cube - the REST analog of the Java API's IEssCubeView.
EssCubeView.CellEdit - Record Class in com.appliedolap.essbase
A new value for one data cell.
EssCubeView.CellType - Enum Class in com.appliedolap.essbase
A coarse classification of a cell as either a data position or a member/label.
EssCubeView.DimensionPlacement - Record Class in com.appliedolap.essbase
Where a dimension sits in the grid: in the POV, on a top/column axis, or on a left/row axis.
EssCubeView.DimensionPlacement.Region - Enum Class in com.appliedolap.essbase
A grid's three regions.
EssCubeView.GridPreferences - Record Class in com.appliedolap.essbase
Ad hoc display/navigation preferences, mirroring the classic "Essbase Options" dialog to the extent the REST wire format supports.
EssCubeView.Indentation - Enum Class in com.appliedolap.essbase
How indented member rows/columns are, mirroring the classic ad hoc "Indentation" setting.
EssCubeView.MemberPlacement - Record Class in com.appliedolap.essbase
A member to place at a specific grid position, replacing whichever member currently occupies that spot on its row or column axis tier.
EssCubeView.Range - Class in com.appliedolap.essbase
A rectangle of cells, given as two corners in either order.
EssCubeView.ZoomInPreference - Enum Class in com.appliedolap.essbase
The server's zoom-in behavior when a plain EssCubeView.zoomIn(int, int) is used (no explicit member set).
EssCubeViewImpl - Class in com.appliedolap.essbase.impl
 
EssCubeViewImpl(ApiContext, String, String, Grid) - Constructor for class com.appliedolap.essbase.impl.EssCubeViewImpl
 
EssDataSource - Interface in com.appliedolap.essbase
 
EssDataSourceColumn - Class in com.appliedolap.essbase
One column of a data source, as the server describes it.
EssDataSourceColumn(String, String, Integer) - Constructor for class com.appliedolap.essbase.EssDataSourceColumn
 
EssDataSourceImpl - Class in com.appliedolap.essbase.impl
A data source object on the Essbase server, which seems to be a general abstraction for a tabular data source, such as a SQL table, MDX result set, CSV file, and others.
EssDataSourceImpl(ApiContext, EssServer, Datasource) - Constructor for class com.appliedolap.essbase.impl.EssDataSourceImpl
 
EssDataSourceQuery - Interface in com.appliedolap.essbase
The rows a data source returned, with the column names it described them by.
EssDimension - Interface in com.appliedolap.essbase
 
EssDimension.StorageType - Enum Class in com.appliedolap.essbase
Whether a dimension is dense or sparse.
EssDimensionImpl - Class in com.appliedolap.essbase.impl
A special type of member that represents a dimension.
EssDimensionImpl(ApiContext, EssApplication, EssCube, DimensionBean) - Constructor for class com.appliedolap.essbase.impl.EssDimensionImpl
 
EssDrillthrough - Interface in com.appliedolap.essbase
 
EssDrillthrough.DrillthroughType - Enum Class in com.appliedolap.essbase
The drill-through report type
EssDrillthroughColumnMapping - Class in com.appliedolap.essbase
Ties one source column of a drill-through report to a cube dimension.
EssDrillthroughColumnMapping(String, EssDrillthroughColumnMapping.MappingType) - Constructor for class com.appliedolap.essbase.EssDrillthroughColumnMapping
 
EssDrillthroughColumnMapping(String, EssDrillthroughColumnMapping.MappingType, String, String, Integer) - Constructor for class com.appliedolap.essbase.EssDrillthroughColumnMapping
 
EssDrillthroughColumnMapping.MappingType - Enum Class in com.appliedolap.essbase
How the cell's members are matched against the column.
EssDrillthroughImpl - Class in com.appliedolap.essbase.impl
Represents a drill-through report on a given cube.
EssDrillthroughImpl(ApiContext, EssCube, ReportBean) - Constructor for class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
EssDrillthroughImpl.ColumnMapping - Class in com.appliedolap.essbase.impl
 
EssDrillthroughImpl.Parameter - Class in com.appliedolap.essbase.impl
 
EssDrillthroughResult - Class in com.appliedolap.essbase
The detail rows behind a drilled cell.
EssDrillthroughResult(List<EssDrillthroughResult.Column>, List<List<String>>) - Constructor for class com.appliedolap.essbase.EssDrillthroughResult
 
EssDrillthroughResult.Column - Class in com.appliedolap.essbase
One column of a drill-through result: what it is called and what the server says it holds.
EssEffectiveVariable - Class in com.appliedolap.essbase
One variable name as a cube actually sees it: the definition that wins, and the ones it hides.
EssEffectiveVariable(EssVariable, List<EssVariable>) - Constructor for class com.appliedolap.essbase.EssEffectiveVariable
 
EssFile - Interface in com.appliedolap.essbase
 
EssFileImpl - Class in com.appliedolap.essbase.impl
A file or folder in the Essbase server file hierarchy.
EssFileImpl(ApiContext, EssServer, String, String) - Constructor for class com.appliedolap.essbase.impl.EssFileImpl
 
EssFilePathDetail - Class in com.appliedolap.essbase
 
EssFilePathDetail() - Constructor for class com.appliedolap.essbase.EssFilePathDetail
 
EssFolder - Interface in com.appliedolap.essbase
 
EssFolderImpl - Class in com.appliedolap.essbase.impl
Represents a folder in the remote Essbase server pseudo-filesystem.
EssFolderImpl(ApiContext, EssServer, String, String) - Constructor for class com.appliedolap.essbase.impl.EssFolderImpl
 
EssGeneration - Interface in com.appliedolap.essbase
 
EssGenerationImpl - Class in com.appliedolap.essbase.impl
Special Type of Member that represents a Generation
EssGenerationImpl(ApiContext, GenerationLevel) - Constructor for class com.appliedolap.essbase.impl.EssGenerationImpl
 
EssGrid - Interface in com.appliedolap.essbase
 
EssGridImpl - Class in com.appliedolap.essbase.impl
 
EssGroup - Interface in com.appliedolap.essbase
A group on a server that owns its own security.
EssGroupImpl - Class in com.appliedolap.essbase.impl
 
EssGroupImpl(ApiContext, EssServer, GroupBean) - Constructor for class com.appliedolap.essbase.impl.EssGroupImpl
 
EssJob - Interface in com.appliedolap.essbase
 
EssJob.JobType - Enum Class in com.appliedolap.essbase
Known job types.
EssJob.Status - Enum Class in com.appliedolap.essbase
Models the status of a job.
EssJobImpl - Class in com.appliedolap.essbase.impl
Represents a server job, which is any number of different types of actions that have been performed on the server, such as a dimension build, data load, and others.
EssJobImpl(ApiContext, EssServer, JobRecordBean) - Constructor for class com.appliedolap.essbase.impl.EssJobImpl
 
EssLevel - Interface in com.appliedolap.essbase
 
EssLevelImpl - Class in com.appliedolap.essbase.impl
Special Type of Member that represents a Level
EssLevelImpl(ApiContext, GenerationLevel) - Constructor for class com.appliedolap.essbase.impl.EssLevelImpl
 
EssLock - Interface in com.appliedolap.essbase
 
EssLockImpl - Class in com.appliedolap.essbase.impl
 
EssLogEntry - Class in com.appliedolap.essbase
One line of an Essbase log, read apart into its fields.
EssLogEntry.Severity - Enum Class in com.appliedolap.essbase
ODL severities, in the order Oracle ranks them.
EssLogSetting - Class in com.appliedolap.essbase
How one ODL log handler rotates - which is the answer to why a log stops where it does.
EssLogSetting(String, String, Integer, Integer) - Constructor for class com.appliedolap.essbase.EssLogSetting
 
EssMaintenanceLimits - Class in com.appliedolap.essbase
What the server says about the machine it is running on - the only thing in the REST API that does.
EssMaintenanceLimits(EssResourceLimit, EssResourceLimit) - Constructor for class com.appliedolap.essbase.EssMaintenanceLimits
 
EssMcp - Interface in com.appliedolap.essbase
The MCP server built into Essbase 26.1, reached through EssServer.getMcp().
EssMcpImpl - Class in com.appliedolap.essbase.impl
Talks to the MCP server Essbase 26.1 serves from inside its own REST API.
EssMcpImpl(ApiContext) - Constructor for class com.appliedolap.essbase.impl.EssMcpImpl
 
EssMcpParameter - Class in com.appliedolap.essbase
One argument of an EssMcpTool, read out of the tool's JSON Schema.
EssMcpParameter(String, String, String, boolean) - Constructor for class com.appliedolap.essbase.EssMcpParameter
 
EssMcpResult - Class in com.appliedolap.essbase
What a tool call came back with.
EssMcpResult(boolean, String) - Constructor for class com.appliedolap.essbase.EssMcpResult
 
EssMcpTool - Class in com.appliedolap.essbase
One tool the server's built-in MCP server offers, as it describes itself.
EssMcpTool(String, String, List<EssMcpParameter>) - Constructor for class com.appliedolap.essbase.EssMcpTool
 
EssMdxFunction - Class in com.appliedolap.essbase
One MDX function the server understands, as the server itself describes it.
EssMdxFunction(String, String, String, String) - Constructor for class com.appliedolap.essbase.EssMdxFunction
 
EssMdxFunctionGroup - Class in com.appliedolap.essbase
A named family of MDX functions - the server's own grouping, not one imposed here.
EssMdxFunctionGroup(String, List<EssMdxFunction>) - Constructor for class com.appliedolap.essbase.EssMdxFunctionGroup
 
EssMdxFunctions - Class in com.appliedolap.essbase.impl
Reads the server's own MDX function reference.
EssMdxGeneration - Interface in com.appliedolap.essbase
What the MDX generator made of a question asked in English.
EssMdxGrid - Interface in com.appliedolap.essbase
An MDX query's result, with the names of the dimensions on each axis as well as the cells.
EssMdxGridImpl - Class in com.appliedolap.essbase.impl
The grid of an MDX result, with the dimension names from the result's metadata.
EssMdxOptions - Class in com.appliedolap.essbase
How the server should present an MDX query's result: whether to include the data, and how to name the members.
EssMdxOptions() - Constructor for class com.appliedolap.essbase.EssMdxOptions
 
EssMember - Interface in com.appliedolap.essbase
 
EssMember.DataStorage - Enum Class in com.appliedolap.essbase
How a member's data is held.
EssMember.DimensionStorage - Enum Class in com.appliedolap.essbase
Whether a dimension's blocks are dense or sparse.
EssMember.DimensionType - Enum Class in com.appliedolap.essbase
The role a dimension plays in the outline.
EssMemberImpl - Class in com.appliedolap.essbase.impl
A member in an Essbase cube.
EssObject - Interface in com.appliedolap.essbase
 
EssObject.Type - Enum Class in com.appliedolap.essbase
Object types for the Essbase REST API.
EssOutline - Interface in com.appliedolap.essbase
 
EssOutlineImpl - Class in com.appliedolap.essbase.impl
Models the outline for a particular cube.
EssPermission - Class in com.appliedolap.essbase
One role granted to one user or group, at the service or at an application.
EssPermission(String, String, String, boolean) - Constructor for class com.appliedolap.essbase.EssPermission
 
EssPlanningDimensionFile - Class in com.appliedolap.essbase
One dimension as EPM Cloud exports it, read from the .csv in an artifact snapshot.
EssPlanningDimensionFile.Member - Class in com.appliedolap.essbase
One member row, with the columns that mean something to an Essbase outline pulled out.
EssPlanningSnapshot - Class in com.appliedolap.essbase
An EPM Cloud artifact snapshot, read as a source for building an Essbase cube.
EssPlanningSnapshot.DimensionOutcome - Class in com.appliedolap.essbase
One dimension's outcome.
EssPlanningSnapshot.DimensionSummary - Class in com.appliedolap.essbase
What a dimension in the snapshot looks like, without importing anything.
EssPlanningSnapshot.Report - Class in com.appliedolap.essbase
What an import did, dimension by dimension.
EssResourceLimit - Class in com.appliedolap.essbase
How much of one system resource is free, and what the configured ceiling is.
EssResourceLimit(String, Integer, Integer) - Constructor for class com.appliedolap.essbase.EssResourceLimit
 
EssScenario - Interface in com.appliedolap.essbase
 
EssScenarioImpl - Class in com.appliedolap.essbase.impl
Models a particular scenario in a scenarios-enabled Essbase cube.
EssScript - Interface in com.appliedolap.essbase
A calculation or MDX script on a cube.
EssScript.ScriptType - Enum Class in com.appliedolap.essbase
Which kind of script this is, which decides both the endpoint's file parameter and how the script is run.
EssScriptImpl - Class in com.appliedolap.essbase.impl
A calculation or MDX script on a cube.
EssServer - Interface in com.appliedolap.essbase
 
EssServer.ApplicationType - Enum Class in com.appliedolap.essbase
A cube type, despite the name.
EssServerAi - Interface in com.appliedolap.essbase
What a server can say about its own generative-AI setup, reached through EssServer.getAi().
EssServerAiImpl - Class in com.appliedolap.essbase.impl
The server-level half of the AI diagnosis, made of exactly the rungs that do not need a cube.
EssServerAiImpl(ApiContext) - Constructor for class com.appliedolap.essbase.impl.EssServerAiImpl
 
EssServerConnectionDetailsImpl - Class in com.appliedolap.essbase.impl
 
EssServerConnectionDetailsImpl() - Constructor for class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
EssServerImpl - Class in com.appliedolap.essbase.impl
Server connection.
EssServerImpl(EssServerConnectionDetailsImpl) - Constructor for class com.appliedolap.essbase.impl.EssServerImpl
 
EssServerImpl(String, EssAuthentication) - Constructor for class com.appliedolap.essbase.impl.EssServerImpl
Connects using the given authentication strategy, which need not be a username and password - see EssAuthentication.
EssServerImpl(String, String, String) - Constructor for class com.appliedolap.essbase.impl.EssServerImpl
Creates a new server connection object.
EssServerImpl.About - Class in com.appliedolap.essbase.impl
 
EssServerImpl.AboutInstance - Class in com.appliedolap.essbase.impl
 
EssServerImpl.DatabaseCreateOptions - Class in com.appliedolap.essbase.impl
Database creation options.
EssServerVariable - Interface in com.appliedolap.essbase
A substitution variable defined on the server, visible to every application and cube on it unless one of them defines the same name.
EssServerVariableImpl - Class in com.appliedolap.essbase.impl
A variable defined on the server itself.
EssSession - Interface in com.appliedolap.essbase
 
EssSessionImpl - Class in com.appliedolap.essbase.impl
Models a session (connection) on the server.
EssSessionImpl(ApiContext, SessionAttributes) - Constructor for class com.appliedolap.essbase.impl.EssSessionImpl
 
EssUploadConfig - Class in com.appliedolap.essbase
How the server wants large files uploaded.
EssUploadConfig(int, int, int, long) - Constructor for class com.appliedolap.essbase.EssUploadConfig
 
EssURL - Interface in com.appliedolap.essbase
 
EssURLImpl - Class in com.appliedolap.essbase.impl
Models a URL object that can be returned from the URLs endpoint.
EssURLImpl(ApiContext, EssServer, EssbaseURL) - Constructor for class com.appliedolap.essbase.impl.EssURLImpl
 
EssUser - Interface in com.appliedolap.essbase
 
EssUserImpl - Class in com.appliedolap.essbase.impl
A user entry on the server.
EssUtility - Interface in com.appliedolap.essbase
 
EssUtilityImpl - Class in com.appliedolap.essbase.impl
Represents one of the downloadable utilities on the Essbase server.
EssUtilityImpl(ApiContext, Resource) - Constructor for class com.appliedolap.essbase.impl.EssUtilityImpl
 
EssVariable - Interface in com.appliedolap.essbase
A substitution variable, at whichever of the three scopes it is defined.
EssVariable.Scope - Enum Class in com.appliedolap.essbase
Which level a variable is defined at, in cascade order - each shadows the ones before it.
EssVariableImpl - Class in com.appliedolap.essbase.impl
What the three scopes of variable have in common: a name, a value, and the fact that the server models all three with the same Variable document.
EssWorkbookImportOptions - Class in com.appliedolap.essbase
What an application workbook import should actually do.
EssWorkbookImportOptions() - Constructor for class com.appliedolap.essbase.EssWorkbookImportOptions
 
EssZipFileDetails - Class in com.appliedolap.essbase
 
EssZipFileDetails() - Constructor for class com.appliedolap.essbase.EssZipFileDetails
 
ExcelExportOptions() - Constructor for class com.appliedolap.essbase.impl.EssCubeImpl.ExcelExportOptions
 
EXCELFILE - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
execute() - Method in interface com.appliedolap.essbase.EssScript
Runs the script and waits for it.
execute() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
Runs the script as a job and waits.
execute(Map<String, Set<String>>) - Method in interface com.appliedolap.essbase.EssDrillthrough
Runs this report for a drilled cell and returns the detail behind it.
execute(Map<String, Set<String>>) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
execute(Map<String, Set<String>>, String) - Method in interface com.appliedolap.essbase.EssDrillthrough
Runs this report for a drilled cell, resolving member names through an alias table.
execute(Map<String, Set<String>>, String) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
Through NativeHttp rather than the generated method, because the specification gives this operation's 200 no schema at all - it describes the shape in prose and models none of it, so the generated call returns void and discards the rows.
executeMdx(String) - Method in interface com.appliedolap.essbase.EssCube
Runs an MDX query and returns its cells.
executeMdx(String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
executeMdx(String, EssCube.MdxOutputType, EssCubeImpl.MdxOptions, OutputStream) - Method in interface com.appliedolap.essbase.EssCube
Deprecated.
since 2.1.0. Its options class lives in the implementation package and was never sent. Use EssCube.executeMdx(String, EssMdxOptions, MdxOutputType, OutputStream).
executeMdx(String, EssCube.MdxOutputType, EssCubeImpl.MdxOptions, OutputStream) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
Deprecated.
executeMdx(String, EssMdxOptions) - Method in interface com.appliedolap.essbase.EssCube
Runs an MDX query and returns its cells along with the dimensions on each axis.
executeMdx(String, EssMdxOptions) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
executeMdx(String, EssMdxOptions, EssCube.MdxOutputType, OutputStream) - Method in interface com.appliedolap.essbase.EssCube
Runs an MDX query and writes the server's answer, in the given format, to a stream.
executeMdx(String, EssMdxOptions, EssCube.MdxOutputType, OutputStream) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
executeScripts(boolean) - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
Whether to run the calculation scripts the workbook carries.
expense(boolean) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
Expense reporting, for an accounts member.
EXPONENT - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
 
EXPORT_DATA - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
EXPORT_EXCEL - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
exportExcel() - Method in interface com.appliedolap.essbase.EssCube
Exports this cube to an application workbook, and waits for the export to finish.
exportExcel() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
Runs the Excel export job and waits for it.
extract(EssZipFileDetails, Boolean) - Method in interface com.appliedolap.essbase.EssFile
Extract a zip file on same location.
extract(EssZipFileDetails, Boolean) - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
extractMessage(String) - Static method in exception com.appliedolap.essbase.EssApiException
 

F

FAILED - Enum constant in enum class com.appliedolap.essbase.EssJob.Status
 
FEATURE_DISABLED - Enum constant in enum class com.appliedolap.essbase.EssAiReadiness.State
AI is on, but this particular capability is switched off.
FILE - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
FILE - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
FIRST - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.TimeBalance
 
FIXEDWIDTHFILE - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
format() - Method in record class com.appliedolap.essbase.EssApiSpec
Returns the value of the format record component.
formatString(boolean) - Method in class com.appliedolap.essbase.EssMdxOptions
Sets the server's formatString preference.
formatString(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
formatValues(boolean) - Method in class com.appliedolap.essbase.EssMdxOptions
Sets the server's formatValues preference.
formula(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
fromCode(int) - Static method in enum class com.appliedolap.essbase.EssJob.Status
 
fromPlanningDimension(Path, String) - Static method in class com.appliedolap.essbase.EssBatchOutlineEdit
An edit that rebuilds a dimension from an EPM Cloud artifact snapshot.
fullPath - Variable in class com.appliedolap.essbase.impl.EssFileImpl
 

G

generateMdx(String) - Method in interface com.appliedolap.essbase.EssCubeAi
Asks the model to write an MDX query answering a question posed in English, starting a new conversation.
generateMdx(String) - Method in class com.appliedolap.essbase.impl.EssCubeAiImpl
 
generateMdx(String, String) - Method in interface com.appliedolap.essbase.EssCubeAi
Asks a follow-up in an existing conversation, so the model reads the question in the context of what it was already asked.
generateMdx(String, String) - Method in class com.appliedolap.essbase.impl.EssCubeAiImpl
 
GENERATION - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.ApplyTo
 
GENERATION - Enum constant in enum class com.appliedolap.essbase.EssDrillthroughColumnMapping.MappingType
 
GENERATION - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
get(String) - Method in interface com.appliedolap.essbase.EssApplicationConfig
One key by name, whether or not the application sets it.
getAbout() - Method in interface com.appliedolap.essbase.EssServer
Gets the "about" information for this server.
getAbout() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getAboutDetails() - Method in interface com.appliedolap.essbase.EssServer
Everything the server reports about the product, exactly as it reports it.
getAboutDetails() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getAboutEssbaseApi() - Method in class com.appliedolap.essbase.ApiContext
 
getAboutInstance() - Method in interface com.appliedolap.essbase.EssServer
 
getAboutInstance() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getActualName() - Method in interface com.appliedolap.essbase.EssGeneration
Gets the actual name of the generation
getActualName() - Method in class com.appliedolap.essbase.impl.EssGenerationImpl
 
getAdded() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
 
getAi() - Method in interface com.appliedolap.essbase.EssCube
The generative-AI features this cube offers - notably turning a question asked in English into an MDX query.
getAi() - Method in interface com.appliedolap.essbase.EssServer
This server's own generative-AI setup: whether it supports AI, whether it is switched on, which capabilities are on, and whether any GenAI connection has been configured.
getAi() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getAi() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getAlias(String) - Method in interface com.appliedolap.essbase.EssMember
This member's alias in one table, or null if it has none there.
getAliases() - Method in interface com.appliedolap.essbase.EssMember
This member's alias in every alias table the cube has, by table name.
getAliases() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
Alias table name to alias, for every Alias: X column that had a value.
getAliases() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getAliasTable() - Method in interface com.appliedolap.essbase.EssCubeView
The alias table the grid's labels are in.
getAliasTable() - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
getAliasTableName() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getAliasTables() - Method in interface com.appliedolap.essbase.EssCube
Gets the names of this cube's alias tables.
getAliasTables() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getApi() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getApiSpec() - Method in interface com.appliedolap.essbase.EssServer
The server's own OpenAPI/Swagger definition of its REST API.
getApiSpec() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getApplication() - Method in interface com.appliedolap.essbase.EssApplicationConfiguration
Gets the application that this configuration item is associated with.
getApplication() - Method in interface com.appliedolap.essbase.EssApplicationVariable
 
getApplication() - Method in interface com.appliedolap.essbase.EssCube
Gets the parent application of this cube.
getApplication() - Method in interface com.appliedolap.essbase.EssCubeVariable
The application owning the cube - not where this variable lives, but often what you want next.
getApplication() - Method in class com.appliedolap.essbase.EssLogEntry
The application the event belongs to, or null on a server-level line.
getApplication() - Method in interface com.appliedolap.essbase.EssSession
The application this session is attached to, or null for one that isn't attached to any.
getApplication() - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
 
getApplication() - Method in class com.appliedolap.essbase.impl.EssApplicationVariableImpl
 
getApplication() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getApplication() - Method in class com.appliedolap.essbase.impl.EssCubeVariableImpl
 
getApplication() - Method in class com.appliedolap.essbase.impl.EssSessionImpl
 
getApplication(String) - Method in interface com.appliedolap.essbase.EssServer
Gets an application with the given name
getApplication(String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getApplicationConfigurationApi() - Method in class com.appliedolap.essbase.ApiContext
 
getApplicationLogsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getApplicationNames() - Method in class com.appliedolap.essbase.EssPlanningSnapshot
The Planning applications in the snapshot.
getApplicationRoleProvisioningApi() - Method in class com.appliedolap.essbase.ApiContext
 
getApplications() - Method in interface com.appliedolap.essbase.EssServer
Fetch the list of applications available on the server for the currently connected user.
getApplications() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getApplicationsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getAuthentication() - Method in class com.appliedolap.essbase.ApiContext
The authentication strategy in use, or null when the context was built without one.
getAuthentication() - Method in interface com.appliedolap.essbase.EssServer
How this connection authenticates, so that code outside the generated client can present the same identity - a download bypass, or a local proxy standing in front of the server's own web pages.
getAuthentication() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getAvailable() - Method in class com.appliedolap.essbase.EssResourceLimit
 
getBatchOutlineEditingApi() - Method in class com.appliedolap.essbase.ApiContext
 
getBestMessage(Throwable) - Static method in exception com.appliedolap.essbase.EssApiException
 
getBuild() - Method in class com.appliedolap.essbase.impl.EssServerImpl.About
 
getCalcScripts() - Method in interface com.appliedolap.essbase.EssCube
Get the list of scripts associated with this cube.
getCalcScripts() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getCause() - Method in class com.appliedolap.essbase.EssAiReadiness
The failure behind EssAiReadiness.State.UNDETERMINED, or null in every other state.
getCell(int, int) - Method in interface com.appliedolap.essbase.EssGrid
 
getCell(int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
getCell(int, int) - Method in class com.appliedolap.essbase.impl.EssGridImpl
 
getCellAttributes() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getCellType(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Classifies the cell at the given position as EssCubeView.CellType.DATA or EssCubeView.CellType.MEMBER.
getCellType(int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
getChildCount() - Method in interface com.appliedolap.essbase.EssMember
Returns the count of children of this member.
getChildCount() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getChildren() - Method in interface com.appliedolap.essbase.EssMember
Gets the children of this member.
getChildren() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getClient() - Method in class com.appliedolap.essbase.ApiContext
 
getCode() - Method in enum class com.appliedolap.essbase.EssJob.Status
 
getColumn() - Method in class com.appliedolap.essbase.misc.MdxJson.Metadata
 
getColumnCount() - Method in class com.appliedolap.essbase.EssCubeView.Range
 
getColumnDimensions() - Method in interface com.appliedolap.essbase.EssMdxGrid
The dimensions on the columns, in order.
getColumnDimensions() - Method in class com.appliedolap.essbase.impl.EssMdxGridImpl
 
getColumnMappingInfo() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.ColumnMapping
 
getColumnMappings() - Method in interface com.appliedolap.essbase.EssDrillthrough
Which source column is filtered by which cube dimension, keyed by column name.
getColumnMappings() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
getColumnName() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.ColumnMapping
 
getColumns() - Method in interface com.appliedolap.essbase.EssDataSource
The columns this data source exposes, in the order the server lists them.
getColumns() - Method in interface com.appliedolap.essbase.EssDataSourceQuery
The column names, in order, as the data source defines them - not as they appear in the file.
getColumns() - Method in interface com.appliedolap.essbase.EssDrillthrough
The source columns this report returns, for a datasource report.
getColumns() - Method in class com.appliedolap.essbase.EssDrillthroughResult
The columns, in the order the server returned them.
getColumns() - Method in interface com.appliedolap.essbase.EssGrid
 
getColumns() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
getColumns() - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
getColumns() - Method in class com.appliedolap.essbase.impl.EssDataSourceImpl
 
getColumns() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
Gets a list of column names for this report.
getColumns() - Method in class com.appliedolap.essbase.impl.EssGridImpl
 
getComment() - Method in class com.appliedolap.essbase.EssMdxFunction
A sentence on what it does.
getComponent() - Method in class com.appliedolap.essbase.EssLogEntry
The subsystem that logged it, e.g.
getConfigurations() - Method in interface com.appliedolap.essbase.EssApplication
Gets the list of configuration for this application.
getConfigurations() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getConnection(String) - Method in interface com.appliedolap.essbase.EssServer
One connection by name.
getConnection(String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
One connection, with everything the server knows about it.
getConnections() - Method in interface com.appliedolap.essbase.EssServer
The global connections defined on this server.
getConnections() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getConnectionSource() - Method in interface com.appliedolap.essbase.EssSession
Get the connection source (not sure what this signifies, but it's in the source JSON...)
getConnectionSource() - Method in class com.appliedolap.essbase.impl.EssSessionImpl
 
getConnectionType() - Method in interface com.appliedolap.essbase.EssConnection
 
getConnectionType() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
 
getConsolidation(String) - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
The consolidation operator for a plan type, falling back to the dimension-wide one.
getContent() - Method in interface com.appliedolap.essbase.EssScript
The script's text, fetched from the server.
getContent() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
getConversationId() - Method in interface com.appliedolap.essbase.EssMdxGeneration
The id tying this answer to the ones before and after it, for a multi-turn conversation.
getCreated() - Method in interface com.appliedolap.essbase.EssApplication
Gets the created time for this application.
getCreated() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getCube() - Method in interface com.appliedolap.essbase.EssCubeVariable
 
getCube() - Method in interface com.appliedolap.essbase.EssDrillthrough
Returns the cube that owns this drill-through object.
getCube() - Method in interface com.appliedolap.essbase.EssOutline
Gets the owning cube of this outline.
getCube() - Method in interface com.appliedolap.essbase.EssScenario
 
getCube() - Method in interface com.appliedolap.essbase.EssScript
The cube this script belongs to.
getCube() - Method in class com.appliedolap.essbase.impl.EssCubeVariableImpl
 
getCube() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
getCube() - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
 
getCube() - Method in class com.appliedolap.essbase.impl.EssScenarioImpl
 
getCube() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
getCube(String) - Method in interface com.appliedolap.essbase.EssApplication
Gets a cube with the given name.
getCube(String) - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getCubes() - Method in interface com.appliedolap.essbase.EssApplication
Gets the list of cubes in this application.
getCubes() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getData() - Method in class com.appliedolap.essbase.misc.MdxJson
 
getDatabase() - Method in interface com.appliedolap.essbase.EssSession
The cube this session is attached to, or null.
getDatabase() - Method in class com.appliedolap.essbase.impl.EssSessionImpl
 
getDatabasesInLcmZip() - Method in interface com.appliedolap.essbase.EssFile
The cubes inside this LCM zip, without importing it.
getDatabasesInLcmZip() - Method in class com.appliedolap.essbase.impl.EssFileImpl
Answers with a plain string rather than a list - "Sample.Basic" or several comma separated - so it is split here.
getDataless() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getDataSource(String) - Method in interface com.appliedolap.essbase.EssServer
Get the data source with the given name.
getDataSource(String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getDataSourceName() - Method in interface com.appliedolap.essbase.EssDrillthrough
Gets the name of the data source for this report.
getDataSourceName() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
getDataSources() - Method in interface com.appliedolap.essbase.EssServer
 
getDataSources() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getDataStorage() - Method in interface com.appliedolap.essbase.EssMember
How this member's data is held, or EssMember.DataStorage.STORED where the server said nothing - it omits the field entirely for the default rather than naming it, so an absent value is information and not a gap.
getDataStorage() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getDataStorage(String) - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
getDataType() - Method in class com.appliedolap.essbase.EssDataSourceColumn
STRING, DOUBLE, DATE, TIMESTAMP or LONG.
getDataType() - Method in class com.appliedolap.essbase.EssDrillthroughResult.Column
As the server reports it - STRING, DOUBLE, DATE and so on.
getDeleted() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
 
getDensity() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
 
getDensity() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionSummary
"Dense" or "Sparse" as the snapshot declares it, or empty.
getDescendantsCount() - Method in interface com.appliedolap.essbase.EssMember
How many members sit below this one, at every level.
getDescendantsCount() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getDescription() - Method in interface com.appliedolap.essbase.EssApplicationConfiguration
What the setting does, in Essbase's own words.
getDescription() - Method in interface com.appliedolap.essbase.EssConnection
 
getDescription() - Method in interface com.appliedolap.essbase.EssGroup
 
getDescription() - Method in interface com.appliedolap.essbase.EssJob
A textual description of the job.
getDescription() - Method in class com.appliedolap.essbase.EssMcpParameter
 
getDescription() - Method in class com.appliedolap.essbase.EssMcpTool
 
getDescription() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
getDescription() - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
 
getDescription() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
 
getDescription() - Method in class com.appliedolap.essbase.impl.EssGroupImpl
The description, fetching the group in full if the listing did not carry one.
getDescription() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
getDescription() - Method in class com.appliedolap.essbase.impl.EssServerImpl.About
 
getDimension() - Method in class com.appliedolap.essbase.EssDrillthroughColumnMapping
 
getDimensionAttributes() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
 
getDimensionEntries(String) - Method in class com.appliedolap.essbase.EssPlanningSnapshot
Every dimension file in the snapshot, by dimension name.
getDimensionName() - Method in interface com.appliedolap.essbase.EssMember
The dimension this member belongs to.
getDimensionName() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
The dimension's name, taken from the first column's header.
getDimensionName() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getDimensions() - Method in interface com.appliedolap.essbase.EssCube
Gets the list of dimensions on the cube, if any.
getDimensions() - Method in interface com.appliedolap.essbase.EssOutline
 
getDimensions() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.Report
 
getDimensions() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getDimensions() - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
 
getDimensionsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getDimensionStorage() - Method in interface com.appliedolap.essbase.EssMember
Whether this dimension is dense or sparse.
getDimensionStorage() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getDimensionType() - Method in interface com.appliedolap.essbase.EssMember
The role this dimension plays, or EssMember.DimensionType.NONE for an ordinary one and for any member below a dimension.
getDimensionType() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
 
getDimensionType() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionSummary
Planning's dimension type - "Accounts", "Time", "None".
getDimensionType() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getDisk() - Method in class com.appliedolap.essbase.EssMaintenanceLimits
 
getDisplayName() - Method in interface com.appliedolap.essbase.EssUser
 
getDisplayName() - Method in class com.appliedolap.essbase.impl.EssUserImpl
 
getDrillableRegions() - Method in interface com.appliedolap.essbase.EssDrillthrough
Get the drillable regions.
getDrillableRegions() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
getDrillthrough(String) - Method in interface com.appliedolap.essbase.EssCube
Gets a drill-through report with a specific name.
getDrillthrough(String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getDrillThroughReportsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getDrillthroughs() - Method in interface com.appliedolap.essbase.EssCube
Get list of drill-through reports on the cube.
getDrillthroughs() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getDrillthroughType() - Method in interface com.appliedolap.essbase.EssDrillthrough
Gets the type of report, which will be either DATASOURCE or URL.
getDrillthroughType() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
Parsed without regard to case because the server is not consistent about it: creating a report echoes back the datasource it was sent, while reading one answers DATASOURCE.
getDuration() - Method in interface com.appliedolap.essbase.EssJob
Gets the duration of this job, in milliseconds.
getDuration() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
getEasInstalled() - Method in class com.appliedolap.essbase.impl.EssServerImpl.AboutInstance
 
getEffective() - Method in class com.appliedolap.essbase.EssEffectiveVariable
 
getEffectiveVariables() - Method in interface com.appliedolap.essbase.EssCube
Every variable this cube can actually see, with the definition that wins and the ones it hides.
getEffectiveVariables() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getEmail() - Method in interface com.appliedolap.essbase.EssUser
 
getEmail() - Method in class com.appliedolap.essbase.impl.EssUserImpl
 
getEnabledFeatures() - Method in interface com.appliedolap.essbase.EssCubeAi
Which AI capabilities this server has switched on, in one request.
getEnabledFeatures() - Method in interface com.appliedolap.essbase.EssServerAi
Which AI capabilities this server has switched on, in one request.
getEnabledFeatures() - Method in class com.appliedolap.essbase.impl.EssCubeAiImpl
 
getEnabledFeatures() - Method in class com.appliedolap.essbase.impl.EssServerAiImpl
 
getErrorMessage() - Method in interface com.appliedolap.essbase.EssJob
Returns the error message for the job, if any.
getErrorMessage() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
getErrors() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
 
getExample() - Method in interface com.appliedolap.essbase.EssApplicationConfiguration
A filled-in example, e.g.
getExample() - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
 
getExecuteMdxApi() - Method in class com.appliedolap.essbase.ApiContext
 
getExpand() - Method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
 
getExplanation() - Method in class com.appliedolap.essbase.EssAiReadiness
A sentence naming the missing link and who fixes it, suitable for showing to a user.
getExtension() - Method in enum class com.appliedolap.essbase.EssScript.ScriptType
The file extension Essbase stores the script under.
getFailure() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionOutcome
Null when the dimension built; otherwise why it did not.
getFields() - Method in class com.appliedolap.essbase.EssLogEntry
The named brackets after the positional ones - ecid, tid, REQ_ID, DBNAME - keyed as the log spells them.
getFile(String, String) - Method in interface com.appliedolap.essbase.EssServer
Gets a file using the specified path and name.
getFile(String, String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
Finds a file by the folder holding it and its name.
getFiles() - Method in interface com.appliedolap.essbase.EssFolder
 
getFiles() - Method in interface com.appliedolap.essbase.EssServer
Gets the list of files available through the files API.
getFiles() - Method in class com.appliedolap.essbase.impl.EssFolderImpl
Lists this folder's contents.
getFiles() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getFilesApi() - Method in class com.appliedolap.essbase.ApiContext
 
getFlag() - Method in enum class com.appliedolap.essbase.EssAiFeature
The key this capability is reported under in /about/instance.
getFormatString() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getFormatValues() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getFormula(String) - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
getFullPath() - Method in interface com.appliedolap.essbase.EssFile
Returns the full path of the file, i.e. the combination of its path and filename.
getFullPath() - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
getFunctions() - Method in class com.appliedolap.essbase.EssMdxFunctionGroup
The functions in it, in the order the server listed them.
getGeneration() - Method in class com.appliedolap.essbase.EssDrillthroughColumnMapping
 
getGeneration(Integer) - Method in interface com.appliedolap.essbase.EssDimension
Gets the generation on the dimension, if any.
getGeneration(Integer) - Method in class com.appliedolap.essbase.impl.EssDimensionImpl
 
getGenerationNumber() - Method in class com.appliedolap.essbase.EssDrillthroughColumnMapping
 
getGlobalDatasourcesApi() - Method in class com.appliedolap.essbase.ApiContext
 
getGridApi() - Method in class com.appliedolap.essbase.ApiContext
 
getGridPreferencesApi() - Method in class com.appliedolap.essbase.ApiContext
 
getGroup() - Method in class com.appliedolap.essbase.EssMdxFunction
The group the server files this function under - Member, Set, Tuple, Number and so on.
getGroup(String) - Method in interface com.appliedolap.essbase.EssServer
One group by name.
getGroup(String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getGroups() - Method in interface com.appliedolap.essbase.EssGroup
 
getGroups() - Method in interface com.appliedolap.essbase.EssServer
Gets a list of groups on this server
getGroups() - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
getGroups() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getGroupsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getHandlerName() - Method in class com.appliedolap.essbase.EssLogSetting
Which handler, e.g.
getHeaderRows() - Method in interface com.appliedolap.essbase.EssMdxGrid
How many rows at the top of the grid are headers rather than data: one for each dimension on the columns.
getHideRestrictedData() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getHomePath() - Method in interface com.appliedolap.essbase.EssServer
Gets the home path of the currently connected user.
getHomePath() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getHost() - Method in interface com.appliedolap.essbase.EssConnection
The host a database connection points at, or null for a file connection.
getHost() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
 
getId() - Method in class com.appliedolap.essbase.EssPermission
Who holds it - a user id or a group name, and the only field guaranteed to be there.
getId() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
Planning's own id for this member - the GUID the batch-outline-edit XML addresses it by.
getId() - Method in class com.appliedolap.essbase.EssResourceLimit
DISK or RAM.
getId() - Method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
 
getIndex() - Method in class com.appliedolap.essbase.EssDataSourceColumn
 
getInstanceDetails() - Method in interface com.appliedolap.essbase.EssServer
Everything the server reports about this deployment, exactly as it reports it.
getInstanceDetails() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getJobID() - Method in interface com.appliedolap.essbase.EssJob
Gets the ID of the job.
getJobID() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
getJobs() - Method in interface com.appliedolap.essbase.EssApplication
Get the list of jobs associated with this application.
getJobs() - Method in interface com.appliedolap.essbase.EssServer
Gets the list of jobs on this server.
getJobs() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getJobs() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getJobsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getJobType() - Method in interface com.appliedolap.essbase.EssJob
Gets the type of the job.
getJobType() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
getKey() - Method in interface com.appliedolap.essbase.EssApplicationConfiguration
Gets the key for this configuration property.
getKey() - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
 
getKey() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.Parameter
 
getLabel() - Method in enum class com.appliedolap.essbase.EssAiFeature
The capability's name as a person would write it, for a caller putting it on screen.
getLabel() - Method in enum class com.appliedolap.essbase.EssMember.DataStorage
The storage as Essbase's own tools write it, for a caller putting it on screen.
getLabel() - Method in enum class com.appliedolap.essbase.EssMember.DimensionType
The type as Essbase's own tools write it, or null for EssMember.DimensionType.NONE, which has nothing to say.
getLabel() - Method in enum class com.appliedolap.essbase.EssScript.ScriptType
The kind as a person would write it.
getLabel() - Method in enum class com.appliedolap.essbase.EssVariable.Scope
 
getLayoutsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getLeafDescendants() - Method in interface com.appliedolap.essbase.EssMember
Gets the level-0 descendants of this member.
getLeafDescendants() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getLevel() - Method in class com.appliedolap.essbase.EssDrillthroughColumnMapping
 
getLevel() - Method in interface com.appliedolap.essbase.EssMember
Gets the level of the member as indicated by the REST API
getLevel() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getLevel(Integer) - Method in interface com.appliedolap.essbase.EssDimension
Gets the level on the dimension, if any.
getLevel(Integer) - Method in class com.appliedolap.essbase.impl.EssDimensionImpl
 
getLevels() - Method in interface com.appliedolap.essbase.EssDimension
Gets the list of levels on the dimension, if any.
getLevels() - Method in class com.appliedolap.essbase.impl.EssDimensionImpl
 
getLimit() - Method in class com.appliedolap.essbase.EssResourceLimit
The configured ceiling, where one is set - zero appears to mean no limit.
getLockedObjects(Integer, Integer) - Method in interface com.appliedolap.essbase.EssCube
List Locked Objects Returns all the locked objects from the specified application and database
getLockedObjects(Integer, Integer) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getLockObjectType() - Method in interface com.appliedolap.essbase.EssLock
 
getLockObjectType() - Method in class com.appliedolap.essbase.impl.EssLockImpl
 
getLocksApi() - Method in class com.appliedolap.essbase.ApiContext
 
getLog() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
The server's log, whole and unparsed.
getLoginTimeInSeconds() - Method in interface com.appliedolap.essbase.EssSession
Number of seconds session has been created
getLoginTimeInSeconds() - Method in class com.appliedolap.essbase.impl.EssSessionImpl
 
getLogSettings() - Method in interface com.appliedolap.essbase.EssServer
How each ODL log handler rotates.
getLogSettings() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getLogType() - Method in class com.appliedolap.essbase.EssLogSetting
How it rotates, e.g.
getMaintenanceLimits() - Method in interface com.appliedolap.essbase.EssServer
What the server reports about the machine it runs on - free disk and memory, and any configured ceilings.
getMaintenanceLimits() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getMappingType() - Method in class com.appliedolap.essbase.EssDrillthroughColumnMapping
 
getMaxAllLogSize() - Method in class com.appliedolap.essbase.EssLogSetting
The size every file for this handler may reach together, before the oldest are discarded.
getMaxFileSizeBytes() - Method in class com.appliedolap.essbase.EssUploadConfig
The largest file the server will take, or -1 where it sets no limit.
getMaxLogSize() - Method in class com.appliedolap.essbase.EssLogSetting
The size one file may reach before rotating.
getMaxParts() - Method in class com.appliedolap.essbase.EssUploadConfig
How many parts one upload may have.
getMcp() - Method in interface com.appliedolap.essbase.EssServer
The MCP server built into this Essbase, if it has one.
getMcp() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getMdx() - Method in interface com.appliedolap.essbase.EssMdxGeneration
The generated query, or null if the model answered without one.
getMdxFunctions() - Method in interface com.appliedolap.essbase.EssCube
The MDX functions this server understands, in the server's own groups.
getMdxFunctions() - Method in interface com.appliedolap.essbase.EssServer
The MDX functions this server understands, in the server's own groups.
getMdxFunctions() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getMdxFunctions() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getMdxScripts() - Method in interface com.appliedolap.essbase.EssCube
The MDX scripts on this cube.
getMdxScripts() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getMeaninglessCells() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getMember(String) - Method in interface com.appliedolap.essbase.EssCube
Gets a reference to a particular member in the cube outline.
getMember(String) - Method in interface com.appliedolap.essbase.EssOutline
 
getMember(String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getMember(String) - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
 
getMemberCount() - Method in interface com.appliedolap.essbase.EssDimension
How many members the dimension has, stored or not.
getMemberCount() - Method in class com.appliedolap.essbase.impl.EssDimensionImpl
 
getMemberIdentifierType() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getMembers() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
 
getMembers() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionSummary
How many members this plan type has in it.
getMembersBuilt() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionOutcome
 
getMemberSearch(String) - Method in interface com.appliedolap.essbase.EssOutline
 
getMemberSearch(String) - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
 
getMessage() - Method in class com.appliedolap.essbase.EssLogEntry
The message text, and for an unparseable line the whole of it.
getMessageId() - Method in class com.appliedolap.essbase.EssLogEntry
The catalogue number, e.g.
getMessages() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
Every labelled line, in the order the server wrote them.
getMetadata() - Method in class com.appliedolap.essbase.misc.MdxJson
 
getModified() - Method in interface com.appliedolap.essbase.EssApplication
Gets the modified time for this application.
getModified() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getModifiedTime() - Method in interface com.appliedolap.essbase.EssScript
 
getModifiedTime() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
getName() - Method in interface com.appliedolap.essbase.EssDataSource
Gets the name of this data source.
getName() - Method in class com.appliedolap.essbase.EssDataSourceColumn
 
getName() - Method in interface com.appliedolap.essbase.EssDimension
Gets the name of the dimension.
getName() - Method in interface com.appliedolap.essbase.EssDrillthrough
Gets the name of this drill-through report.
getName() - Method in class com.appliedolap.essbase.EssDrillthroughResult.Column
 
getName() - Method in class com.appliedolap.essbase.EssEffectiveVariable
 
getName() - Method in interface com.appliedolap.essbase.EssFile
Returns the filename portion of the file.
getName() - Method in interface com.appliedolap.essbase.EssGeneration
Gets the name of the generation.
getName() - Method in interface com.appliedolap.essbase.EssGroup
 
getName() - Method in interface com.appliedolap.essbase.EssJob
Implemented for conformance to AbstractEssObject; the name is simply the job ID.
getName() - Method in interface com.appliedolap.essbase.EssLevel
Gets the name of the level.
getName() - Method in interface com.appliedolap.essbase.EssLock
Gets the name of the lock.
getName() - Method in class com.appliedolap.essbase.EssMcpParameter
 
getName() - Method in class com.appliedolap.essbase.EssMcpTool
 
getName() - Method in class com.appliedolap.essbase.EssMdxFunction
The function name, e.g.
getName() - Method in class com.appliedolap.essbase.EssMdxFunctionGroup
The group name, e.g.
getName() - Method in interface com.appliedolap.essbase.EssMember
Returns the name of the member.
getName() - Method in interface com.appliedolap.essbase.EssObject
Gets the name of this object.
getName() - Method in interface com.appliedolap.essbase.EssOutline
 
getName() - Method in class com.appliedolap.essbase.EssPermission
Their display name, which is frequently absent.
getName() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
The member name, which is the first column and is named after the dimension.
getName() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionOutcome
 
getName() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionSummary
 
getName() - Method in interface com.appliedolap.essbase.EssScenario
Gets the name of this scenario.
getName() - Method in interface com.appliedolap.essbase.EssServer
 
getName() - Method in interface com.appliedolap.essbase.EssSession
Standard implementation.
getName() - Method in interface com.appliedolap.essbase.EssURL
 
getName() - Method in interface com.appliedolap.essbase.EssUser
Returns the user ID.
getName() - Method in interface com.appliedolap.essbase.EssUtility
 
getName() - Method in interface com.appliedolap.essbase.EssVariable
 
getName() - Method in exception com.appliedolap.essbase.exceptions.NoSuchEssbaseObjectException
 
getName() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssDataSourceImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssDimensionImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssGenerationImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssLevelImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssLockImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssScenarioImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssServerImpl.About
 
getName() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssSessionImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssURLImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssUserImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssUtilityImpl
 
getName() - Method in class com.appliedolap.essbase.impl.EssVariableImpl
 
getName() - Method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
 
getNotes() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionOutcome
Things that were skipped or could not be set, which do not amount to a failure.
getNotes() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.Report
Anything worth saying that is not about one dimension.
getNumber() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult.Message
The Essbase message number, e.g. 1370271 for "member not exist", or -1 if the line had none.
getNumber() - Method in interface com.appliedolap.essbase.EssGeneration
Gets the number of the generation
getNumber() - Method in interface com.appliedolap.essbase.EssLevel
Gets the number of the level.
getNumber() - Method in class com.appliedolap.essbase.impl.EssGenerationImpl
 
getNumber() - Method in class com.appliedolap.essbase.impl.EssLevelImpl
 
getOperator() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
 
getOutline() - Method in interface com.appliedolap.essbase.EssCube
Gets an outline object for this cube.
getOutline() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getOutlineViewerApi() - Method in class com.appliedolap.essbase.ApiContext
 
getPage() - Method in class com.appliedolap.essbase.misc.MdxJson.Metadata
 
getPageDimensions() - Method in interface com.appliedolap.essbase.EssMdxGrid
The dimensions on neither axis, which each contribute one member to every cell: the query's slicer and the cube's defaults for whatever it leaves out.
getPageDimensions() - Method in class com.appliedolap.essbase.impl.EssMdxGridImpl
 
getPageMembers() - Method in interface com.appliedolap.essbase.EssMdxGrid
The member each page dimension contributes, in the same order as EssMdxGrid.getPageDimensions(): the slicer's member where the query names one, the dimension's top member otherwise, named the way the query asked for members to be named.
getPageMembers() - Method in class com.appliedolap.essbase.impl.EssMdxGridImpl
 
getParam() - Method in enum class com.appliedolap.essbase.EssJob.JobType
Represents the name of the param used in the JSON request to the server.
getParameter() - Method in enum class com.appliedolap.essbase.EssConnection.ConnectionType
The value the API wants, which is the constant's own name in upper case.
getParameter() - Method in enum class com.appliedolap.essbase.EssScript.ScriptType
The value the scripts endpoints want in file.
getParameters() - Method in class com.appliedolap.essbase.EssMcpTool
Its arguments, required ones first.
getParent() - Method in interface com.appliedolap.essbase.EssMember
Gets the parent member (not implemented yet).
getParent() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
getParent() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getPartSizeBytes() - Method in class com.appliedolap.essbase.EssUploadConfig
The size in bytes, which is what anything measuring a file actually needs.
getPartSizeMegabytes() - Method in class com.appliedolap.essbase.EssUploadConfig
How big each part should be, in megabytes - ten, on the servers seen so far.
getPassword() - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
getPath() - Method in interface com.appliedolap.essbase.EssConnection
For a file connection, the catalogue path of the file - /gallery/Technical/Filters/UserDetails.csv.
getPath() - Method in interface com.appliedolap.essbase.EssFile
Convenience method to return the path to the file.
getPath() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
 
getPath() - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
getPermissions() - Method in interface com.appliedolap.essbase.EssApplication
Who holds which role on this application - Application Manager, Database Manager, Database Update, Database Access.
getPermissions() - Method in interface com.appliedolap.essbase.EssServer
Who holds which service-level role - Service Administrator, Power User, User.
getPermissions() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getPermissions() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getPlacements() - Method in interface com.appliedolap.essbase.EssCubeView
Says where every dimension currently sits, as the server reports it rather than as the sheet of labels implies.
getPlacements() - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
getPlanTypes() - Method in class com.appliedolap.essbase.EssPlanningSnapshot
The plan types - the cubes - the snapshot describes.
getPov() - Method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
The member this dimension is pinned to, or null against a server that doesn't report one.
getPreferences() - Method in interface com.appliedolap.essbase.EssCubeView
Reads the current session's ad hoc display/navigation preferences.
getPreferences() - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
getProperties() - Method in interface com.appliedolap.essbase.EssMember
Everything the server said about this member, as it said it.
getProperties() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
Everything the server said about this connection, for a caller wanting more than the accessors.
getProperties() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getProvisioningSupported() - Method in class com.appliedolap.essbase.impl.EssServerImpl.AboutInstance
 
getRam() - Method in class com.appliedolap.essbase.EssMaintenanceLimits
 
getRaw() - Method in class com.appliedolap.essbase.EssLogEntry
The line exactly as it was read.
getRawResponse() - Method in interface com.appliedolap.essbase.EssMdxGeneration
Whatever else came back, unmodified.
getReadiness() - Method in interface com.appliedolap.essbase.EssCubeAi
Works out whether the AI features on this cube can run, and if not, which prerequisite is missing.
getReadiness() - Method in interface com.appliedolap.essbase.EssServerAi
Works out how far this server's AI setup goes, without reference to any application or cube.
getReadiness() - Method in class com.appliedolap.essbase.impl.EssCubeAiImpl
 
getReadiness() - Method in class com.appliedolap.essbase.impl.EssServerAiImpl
 
getReadiness(EssAiFeature) - Method in interface com.appliedolap.essbase.EssCubeAi
The same diagnosis, narrowed to one capability, which is what you usually want: the server reports a separate on/off flag per capability, so "is AI available here" is a question with no single answer and asking about the feature you are about to use is strictly better.
getReadiness(EssAiFeature) - Method in interface com.appliedolap.essbase.EssServerAi
The same diagnosis, narrowed to one capability, so that a server with AI on but the MDX generator off reports EssAiReadiness.State.FEATURE_DISABLED rather than readiness.
getReadiness(EssAiFeature) - Method in class com.appliedolap.essbase.impl.EssCubeAiImpl
 
getReadiness(EssAiFeature) - Method in class com.appliedolap.essbase.impl.EssServerAiImpl
 
getResetPasswordSupported() - Method in class com.appliedolap.essbase.impl.EssServerImpl.AboutInstance
 
getResponseType() - Method in enum class com.appliedolap.essbase.EssJob.JobType
The job type as it is returned from the job post API.
getRetryCount() - Method in class com.appliedolap.essbase.EssUploadConfig
 
getRole() - Method in interface com.appliedolap.essbase.EssGroup
The service-level role this group grants its members - User, Power User or Service Administrator.
getRole() - Method in class com.appliedolap.essbase.EssPermission
The role, in the server's own spelling - service_administrator, Database Manager.
getRole() - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
getRow() - Method in class com.appliedolap.essbase.misc.MdxJson.Metadata
 
getRowCount() - Method in class com.appliedolap.essbase.EssCubeView.Range
 
getRowCount() - Method in class com.appliedolap.essbase.EssDrillthroughResult
 
getRowDimensions() - Method in interface com.appliedolap.essbase.EssMdxGrid
The dimensions on the rows, in order.
getRowDimensions() - Method in class com.appliedolap.essbase.impl.EssMdxGridImpl
 
getRows() - Method in interface com.appliedolap.essbase.EssDataSourceQuery
The rows, each a list of values matching EssDataSourceQuery.getColumns() in length and order.
getRows() - Method in class com.appliedolap.essbase.EssDrillthroughResult
One list of values per record, aligned with EssDrillthroughResult.getColumns().
getRows() - Method in interface com.appliedolap.essbase.EssGrid
 
getRows() - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
getRows() - Method in class com.appliedolap.essbase.impl.EssGridImpl
 
getRunTimeParametersInfo() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.Parameter
 
getSampleQuestions() - Method in interface com.appliedolap.essbase.EssCubeAi
Questions the server suggests as a starting point for this cube - what the web interface offers as examples before anyone has typed anything.
getSampleQuestions() - Method in class com.appliedolap.essbase.impl.EssCubeAiImpl
 
getScenarios() - Method in interface com.appliedolap.essbase.EssCube
Gets the list of scenarios on the cube, if any.
getScenarios() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getScenariosApi() - Method in class com.appliedolap.essbase.ApiContext
 
getScope() - Method in class com.appliedolap.essbase.EssEffectiveVariable
 
getScope() - Method in interface com.appliedolap.essbase.EssVariable
Where this variable is defined - which is also what it takes precedence over.
getScope() - Method in class com.appliedolap.essbase.impl.EssApplicationVariableImpl
 
getScope() - Method in class com.appliedolap.essbase.impl.EssCubeVariableImpl
 
getScope() - Method in class com.appliedolap.essbase.impl.EssServerVariableImpl
 
getScripts(EssScript.ScriptType) - Method in interface com.appliedolap.essbase.EssCube
The scripts of one kind on this cube.
getScripts(EssScript.ScriptType) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
Lists the scripts of one kind.
getScriptsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getScriptType() - Method in interface com.appliedolap.essbase.EssScript
Which kind of script this is.
getScriptType() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
getServer() - Method in interface com.appliedolap.essbase.EssApplication
Get the server that contains this application.
getServer() - Method in interface com.appliedolap.essbase.EssFile
Returns the owning Essbase server instance for this file.
getServer() - Method in interface com.appliedolap.essbase.EssGroup
 
getServer() - Method in interface com.appliedolap.essbase.EssJob
Gets the owning server for this job.
getServer() - Method in interface com.appliedolap.essbase.EssServerVariable
 
getServer() - Method in interface com.appliedolap.essbase.EssUser
Get the owning server of this user.
getServer() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getServer() - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
getServer() - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
getServer() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
getServer() - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
getServer() - Method in class com.appliedolap.essbase.impl.EssServerVariableImpl
 
getServer() - Method in class com.appliedolap.essbase.impl.EssUserImpl
 
getServerInfo() - Method in interface com.appliedolap.essbase.EssMcp
What the MCP server calls itself, e.g.
getServerInfo() - Method in class com.appliedolap.essbase.impl.EssMcpImpl
 
getServerLogTypes() - Method in interface com.appliedolap.essbase.EssServer
The kinds of server log this deployment offers, each a value for the other two methods here.
getServerLogTypes() - Method in class com.appliedolap.essbase.impl.EssServerImpl
The about information of this server.
getServerVariablesApi() - Method in class com.appliedolap.essbase.ApiContext
 
getServiceRoleProvisioningApi() - Method in class com.appliedolap.essbase.ApiContext
 
getSessionExpiry() - Method in interface com.appliedolap.essbase.EssServer
When this client's session expires, if the server has said.
getSessionExpiry() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getSessionId() - Method in interface com.appliedolap.essbase.EssSession
Gets the ID of this session.
getSessionId() - Method in class com.appliedolap.essbase.impl.EssSessionImpl
 
getSessionId() - Method in class com.appliedolap.essbase.impl.SessionAuthentication
The session this has established, or null if it is still authenticating with a password.
getSessions() - Method in interface com.appliedolap.essbase.EssApplication
The sessions currently on this application, across all of its cubes.
getSessions() - Method in interface com.appliedolap.essbase.EssCube
Gets the list of sessions on this cube.
getSessions() - Method in interface com.appliedolap.essbase.EssServer
 
getSessions() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getSessions() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getSessions() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getSessionsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getSeverity() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult.Message
 
getSeverity() - Method in class com.appliedolap.essbase.EssLogEntry
 
getSeverityLevel() - Method in class com.appliedolap.essbase.EssLogEntry
The numeric grade beside the severity - the 32 of ERROR:32 - or -1 if there wasn't one.
getShadowed() - Method in class com.appliedolap.essbase.EssEffectiveVariable
The definitions this one hides, furthest away first - so a cube variable shadowing both an application and a server one lists the server's first.
getSharedPath() - Method in interface com.appliedolap.essbase.EssServer
The shared folder every user can see, /shared.
getSharedPath() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getSize() - Method in interface com.appliedolap.essbase.EssScript
 
getSize() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
getSkipValue() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
getSolveOrder(String) - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
getStartColumn() - Method in class com.appliedolap.essbase.EssCubeView.Range
 
getStartRow() - Method in class com.appliedolap.essbase.EssCubeView.Range
 
getState() - Method in class com.appliedolap.essbase.EssAiReadiness
 
getStatus() - Method in interface com.appliedolap.essbase.EssApplication
Gets the status of this application.
getStatus() - Method in interface com.appliedolap.essbase.EssCube
Whether this cube is started.
getStatus() - Method in interface com.appliedolap.essbase.EssJob
Gets the status of this job.
getStatus() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getStatus() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getStatus() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
getStorageType() - Method in interface com.appliedolap.essbase.EssDimension
Whether the dimension is dense or sparse, the storage setting the classic Java API reports as IEssDimension.getStorageType().
getStorageType() - Method in class com.appliedolap.essbase.impl.EssDimensionImpl
 
getStoredMemberCount() - Method in interface com.appliedolap.essbase.EssDimension
How many of the dimension's members are stored.
getStoredMemberCount() - Method in class com.appliedolap.essbase.impl.EssDimensionImpl
 
getSyntax() - Method in interface com.appliedolap.essbase.EssApplicationConfiguration
How the setting is written, e.g.
getSyntax() - Method in class com.appliedolap.essbase.EssMdxFunction
How to call it, e.g.
getSyntax() - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
 
getTemplatesAndUtilitiesApi() - Method in class com.appliedolap.essbase.ApiContext
 
getText() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult.Message
The whole line, as the server wrote it.
getText() - Method in class com.appliedolap.essbase.EssMcpResult
Whatever the tool returned - usually JSON, and on failure a message.
getTextList() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getTime() - Method in interface com.appliedolap.essbase.EssLock
 
getTime() - Method in class com.appliedolap.essbase.impl.EssLockImpl
 
getTimeBalance() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
getTimeout() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getTimestamp() - Method in class com.appliedolap.essbase.EssLogEntry
When the event happened, or null for a line that didn't parse.
getTools() - Method in interface com.appliedolap.essbase.EssMcp
The tools it offers.
getTools() - Method in class com.appliedolap.essbase.impl.EssMcpImpl
 
getTotalChanged() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
Everything the edit changed.
getTotalMembers() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.Report
 
getType() - Method in interface com.appliedolap.essbase.EssDataSource
 
getType() - Method in interface com.appliedolap.essbase.EssDimension
 
getType() - Method in interface com.appliedolap.essbase.EssDrillthrough
 
getType() - Method in interface com.appliedolap.essbase.EssFile
 
getType() - Method in interface com.appliedolap.essbase.EssGeneration
 
getType() - Method in interface com.appliedolap.essbase.EssGroup
 
getType() - Method in interface com.appliedolap.essbase.EssJob
 
getType() - Method in interface com.appliedolap.essbase.EssLevel
 
getType() - Method in interface com.appliedolap.essbase.EssLock
 
getType() - Method in class com.appliedolap.essbase.EssMcpParameter
The JSON Schema type - string, boolean, integer.
getType() - Method in interface com.appliedolap.essbase.EssMember
 
getType() - Method in interface com.appliedolap.essbase.EssObject
Gets the type of this object.
getType() - Method in interface com.appliedolap.essbase.EssOutline
 
getType() - Method in interface com.appliedolap.essbase.EssScenario
 
getType() - Method in interface com.appliedolap.essbase.EssServer
 
getType() - Method in interface com.appliedolap.essbase.EssSession
 
getType() - Method in interface com.appliedolap.essbase.EssURL
 
getType() - Method in interface com.appliedolap.essbase.EssUser
 
getType() - Method in interface com.appliedolap.essbase.EssUtility
 
getType() - Method in interface com.appliedolap.essbase.EssVariable
 
getType() - Method in exception com.appliedolap.essbase.exceptions.NoSuchEssbaseObjectException
 
getType() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssDataSourceImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssDimensionImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssGenerationImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssLevelImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssLockImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssScenarioImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssServerImpl.DatabaseCreateOptions
 
getType() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssSessionImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssURLImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssUserImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssUtilityImpl
 
getType() - Method in class com.appliedolap.essbase.impl.EssVariableImpl
 
getUdas() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
Every UDA on the member.
getUnique() - Method in interface com.appliedolap.essbase.EssGeneration
Gets the unique setting of the generation
getUnique() - Method in class com.appliedolap.essbase.impl.EssGenerationImpl
 
getUpdated() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
 
getUploadConfig() - Method in interface com.appliedolap.essbase.EssServer
How this server wants large files uploaded - the part size, and how many parts it allows.
getUploadConfig() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getURI() - Method in interface com.appliedolap.essbase.EssURL
 
getURI() - Method in class com.appliedolap.essbase.impl.EssURLImpl
 
getUrl() - Method in interface com.appliedolap.essbase.EssDrillthrough
Gets the URL of this drill-through report (URL-style only!).
getUrl() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
getURL() - Method in interface com.appliedolap.essbase.EssURL
 
getURL() - Method in class com.appliedolap.essbase.impl.EssURLImpl
 
getUrlDrillThrough() - Method in class com.appliedolap.essbase.EssMdxOptions
 
getURLs() - Method in interface com.appliedolap.essbase.EssServer
Returns the list of URLs known to this server.
getURLs() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getUrlsApi() - Method in class com.appliedolap.essbase.ApiContext
 
getUser() - Method in interface com.appliedolap.essbase.EssLock
 
getUser() - Method in class com.appliedolap.essbase.impl.EssLockImpl
 
getUserId() - Method in interface com.appliedolap.essbase.EssSession
Get the user for the session.
getUserId() - Method in class com.appliedolap.essbase.impl.EssSessionImpl
 
getUsername() - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
getUsers() - Method in interface com.appliedolap.essbase.EssGroup
Gets the user members that are in this group.
getUsers() - Method in interface com.appliedolap.essbase.EssServer
The users this server holds.
getUsers() - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
getUsers() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getUsersApi() - Method in class com.appliedolap.essbase.ApiContext
 
getUserSessionApi() - Method in class com.appliedolap.essbase.ApiContext
 
getUtilities() - Method in interface com.appliedolap.essbase.EssServer
Gets the list of utilities on this server.
getUtilities() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getValue() - Method in interface com.appliedolap.essbase.EssApplicationConfiguration
Gets the value for this configuration property, or null when this application doesn't set it.
getValue() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.ApplyTo
 
getValue() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DataStorage
 
getValue() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
 
getValue() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionStorage
 
getValue() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.HierarchyType
 
getValue() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Restructure
 
getValue() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Skip
 
getValue() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.SortOrder
 
getValue() - Method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.TimeBalance
 
getValue() - Method in class com.appliedolap.essbase.EssEffectiveVariable
 
getValue() - Method in interface com.appliedolap.essbase.EssVariable
 
getValue() - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
 
getValue() - Method in class com.appliedolap.essbase.impl.EssVariableImpl
 
getVariables() - Method in interface com.appliedolap.essbase.EssApplication
Gets the list of variables specific to this application
getVariables() - Method in interface com.appliedolap.essbase.EssCube
 
getVariables() - Method in interface com.appliedolap.essbase.EssServer
Gets server-scoped variables.
getVariables() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
getVariables() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
getVariables() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
getVariablesApi() - Method in class com.appliedolap.essbase.ApiContext
 
getVarianceReporting() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
getVersion() - Method in class com.appliedolap.essbase.impl.EssServerImpl.About
 
getWarnings() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
 
getWeblogicAuthCookie() - Method in class com.appliedolap.essbase.impl.SessionAuthentication
The WebLogic authentication cookie for the established session, or null.
GridPreferences(EssCubeView.Indentation, boolean, boolean, boolean, boolean, EssCubeView.ZoomInPreference, boolean, boolean, boolean) - Constructor for record class com.appliedolap.essbase.EssCubeView.GridPreferences
The form without useBothNamesAndAliases, which defaults to off.
GridPreferences(EssCubeView.Indentation, boolean, boolean, boolean, boolean, EssCubeView.ZoomInPreference, boolean, boolean, boolean, boolean) - Constructor for record class com.appliedolap.essbase.EssCubeView.GridPreferences
The form with useBothNamesAndAliases but not navigateWithoutData.
GridPreferences(EssCubeView.Indentation, boolean, boolean, boolean, boolean, EssCubeView.ZoomInPreference, boolean, boolean, boolean, boolean, boolean) - Constructor for record class com.appliedolap.essbase.EssCubeView.GridPreferences
The form before column suppression and ancestorOnTop existed, which default to off.
GridPreferences(EssCubeView.Indentation, boolean, boolean, boolean, boolean, EssCubeView.ZoomInPreference, boolean, boolean, boolean, boolean, boolean, boolean, boolean) - Constructor for record class com.appliedolap.essbase.EssCubeView.GridPreferences
Creates an instance of a GridPreferences record class.
GROUP - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 

H

hashCode() - Method in record class com.appliedolap.essbase.EssApiSpec
Returns a hash code value for this object.
hashCode() - Method in record class com.appliedolap.essbase.EssCubeView.CellEdit
Returns a hash code value for this object.
hashCode() - Method in record class com.appliedolap.essbase.EssCubeView.DimensionPlacement
Returns a hash code value for this object.
hashCode() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns a hash code value for this object.
hashCode() - Method in record class com.appliedolap.essbase.EssCubeView.MemberPlacement
Returns a hash code value for this object.
hasPreferences() - Method in class com.appliedolap.essbase.EssMdxOptions
 
hasWarnings() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
 
hideRestrictedData(boolean) - Method in class com.appliedolap.essbase.EssMdxOptions
Sets the server's hideRestrictedData preference.
hierarchyType(EssBatchOutlineEdit.HierarchyType) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
HTML - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxOutputType
 

I

IMPORT_EXCEL - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
importExcel(String, String) - Method in interface com.appliedolap.essbase.EssCube
Updates this cube using an Excel workbook.
importExcel(String, String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
importFile(File) - Method in interface com.appliedolap.essbase.EssCube
Acts as a convenience function for uploading a file to a cube's storage folder.
importFile(File) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
importInto(EssCube, String) - Method in class com.appliedolap.essbase.EssPlanningSnapshot
Builds every dimension in the snapshot into a cube.
importInto(EssCube, String, Collection<String>) - Method in class com.appliedolap.essbase.EssPlanningSnapshot
Builds the dimensions the caller picked.
IN_DATA - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Restructure
Input data; block storage only.
IN_PROGRESS - Enum constant in enum class com.appliedolap.essbase.EssJob.Status
Represented in the Essbase REST API with code 100.
INCIDENT_ERROR - Enum constant in enum class com.appliedolap.essbase.EssLogEntry.Severity
 
includeSelection() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the includeSelection record component.
INCLUSIVE_CHILDREN - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.ApplyTo
 
INCLUSIVE_DESCENDANTS - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.ApplyTo
 
indentation() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the indentation record component.
index() - Method in record class com.appliedolap.essbase.EssCubeView.DimensionPlacement
Returns the value of the index record component.
INFO - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEditResult.Severity
 
insertSibling() - Method in interface com.appliedolap.essbase.EssOutline
 
insertSibling() - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
 
isAllowDuplicates() - Method in class com.appliedolap.essbase.impl.EssServerImpl.DatabaseCreateOptions
 
isAttributeDimension() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionOutcome
 
isAttributeDimension() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionSummary
Whether the snapshot files this under attribute dimensions.
isAvailable() - Method in interface com.appliedolap.essbase.EssMcp
Whether this server has an MCP server at all.
isAvailable() - Method in class com.appliedolap.essbase.impl.EssMcpImpl
 
isComplete() - Method in enum class com.appliedolap.essbase.EssJob.Status
 
isConfigured() - Method in interface com.appliedolap.essbase.EssApplicationConfiguration
Whether this application sets this key.
isConfigured() - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
Whether the application sets this key - which is exactly whether it has a value here, since this is built by merging the catalogue with the application's configurations.
isCreateFiles() - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
 
isDatabase() - Method in enum class com.appliedolap.essbase.EssConnection.ConnectionType
Whether this kind needs a JDBC driver on the server.
isDeleteWorkbookOnSuccess() - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
 
isDimension() - Method in interface com.appliedolap.essbase.EssMember
Check if the member is a normal member or a dimension member.
isDimension() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
isDownloadable() - Method in interface com.appliedolap.essbase.EssUtility
Checks if the utility is downloadable, as opposed to being a direct link.
isDownloadable() - Method in class com.appliedolap.essbase.impl.EssUtilityImpl
 
isEmpty() - Method in class com.appliedolap.essbase.EssDrillthroughResult
 
isEmpty() - Method in class com.appliedolap.essbase.EssMdxOptions
 
isEnableScenarios() - Method in class com.appliedolap.essbase.impl.EssServerImpl.DatabaseCreateOptions
 
isError() - Method in class com.appliedolap.essbase.EssMcpResult
 
isExecuteScripts() - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
 
isFile() - Method in enum class com.appliedolap.essbase.EssConnection.ConnectionType
Whether this kind reads from the Essbase file catalogue rather than an outside system.
isFile() - Method in interface com.appliedolap.essbase.EssFile
Returns true if this is a file, not a folder.
isFile() - Method in interface com.appliedolap.essbase.EssFolder
isFile() - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
isFile() - Method in class com.appliedolap.essbase.impl.EssFolderImpl
 
isFolder() - Method in interface com.appliedolap.essbase.EssFile
Checks if this file object represents a file or a folder.
isFolder() - Method in interface com.appliedolap.essbase.EssFolder
Check if this item is a folder (true for EssFolder objects, false for EssFileImpl objects).
isFolder() - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
isFolder() - Method in class com.appliedolap.essbase.impl.EssFolderImpl
 
isGroup() - Method in class com.appliedolap.essbase.EssPermission
Whether the holder is a group rather than a user.
isInPlanType(String) - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
Whether this member belongs to the given plan type.
isLeaf() - Method in interface com.appliedolap.essbase.EssMember
Checks if the member is a leaf node or level 0 (has no children).
isLeaf() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
 
isLoadData() - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
 
isOverriding() - Method in class com.appliedolap.essbase.EssEffectiveVariable
 
isOverwrite() - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
 
isParsed() - Method in class com.appliedolap.essbase.EssLogEntry
Whether the line was understood.
isPrintable() - Method in enum class com.appliedolap.essbase.EssCube.MdxOutputType
 
isProblem() - Method in enum class com.appliedolap.essbase.EssLogEntry.Severity
Whether this is something gone wrong, as opposed to something merely reported.
isReady() - Method in class com.appliedolap.essbase.EssAiReadiness
 
isRecreateApplication() - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
 
isRequired() - Method in class com.appliedolap.essbase.EssMcpParameter
 
isScenariosEnabled() - Method in interface com.appliedolap.essbase.EssCube
Checks if this cube has scenarios enabled.
isScenariosEnabled() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
isStateless() - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
isSuccessful() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
Whether the server reported no errors.
isSuccessful() - Method in interface com.appliedolap.essbase.EssJob
Check if the job execution was successful.
isSuccessful() - Method in enum class com.appliedolap.essbase.EssJob.Status
 
isSuccessful() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionOutcome
 
isSuccessful() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.Report
 
isSuccessful() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
isTwoPass() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
isUseTempTables() - Method in interface com.appliedolap.essbase.EssDrillthrough
Gets the useTempTables parameter for this report which is only valid using Oracle DB.
isUseTempTables() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 

J

JDBC - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
JOB - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
json() - Method in record class com.appliedolap.essbase.EssApiSpec
Returns the value of the json record component.
JSON - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxOutputType
 

K

keepOnly(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Keeps only the member at the given position.
keepOnly(int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
keepOnly(int, int, int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Keeps only the members in a rectangle of cells, dropping their siblings.
keepOnly(int, int, int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
keepOnly(List<EssCubeView.Range>) - Method in interface com.appliedolap.essbase.EssCubeView
Keeps only the members in several rectangles at once, dropping their siblings.
keepOnly(List<EssCubeView.Range>) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
keepTransaction(boolean) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Whether to hold the edit open as a transaction.
keys() - Method in interface com.appliedolap.essbase.EssApplicationConfig
Every configuration key the server publishes, each with its description and syntax, and with the value where this application sets one.
keys(String) - Method in interface com.appliedolap.essbase.EssApplicationConfig
The catalogue, narrowed by a key pattern.
kill(boolean) - Method in interface com.appliedolap.essbase.EssSession
Kill the session.
kill(boolean) - Method in class com.appliedolap.essbase.impl.EssSessionImpl
 
killSessions(boolean) - Method in interface com.appliedolap.essbase.EssApplication
Ends every session on this application.
killSessions(boolean) - Method in interface com.appliedolap.essbase.EssCube
Ends every session on this cube, leaving the rest of the application's alone.
killSessions(boolean) - Method in interface com.appliedolap.essbase.EssServer
Kill all sessions on the server.
killSessions(boolean) - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
killSessions(boolean) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
killSessions(boolean) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
killSessions(String, boolean) - Method in interface com.appliedolap.essbase.EssServer
Kill all sessions on the server for the given user.
killSessions(String, boolean) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 

L

LABEL_ONLY - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DataStorage
 
LABEL_ONLY - Enum constant in enum class com.appliedolap.essbase.EssMember.DataStorage
Carries no data at all; it exists to group the members under it.
LAST - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.TimeBalance
 
LCM_BACKUP - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
LCM_RESTORE - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
lcmImport(boolean) - Method in interface com.appliedolap.essbase.EssFile
Restores this LCM zip, as a job.
lcmImport(boolean) - Method in class com.appliedolap.essbase.impl.EssFileImpl
Deprecated.
LEFT - Enum constant in enum class com.appliedolap.essbase.EssCubeView.DimensionPlacement.Region
 
LEVEL - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.ApplyTo
 
LEVEL - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
LEVEL0 - Enum constant in enum class com.appliedolap.essbase.EssDrillthroughColumnMapping.MappingType
 
listDimGenerations() - Method in interface com.appliedolap.essbase.EssDimension
Gets the list of generations on the dimension, if any.
listDimGenerations() - Method in class com.appliedolap.essbase.impl.EssDimensionImpl
 
LOAD_DATA - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
loadData(boolean) - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
Whether to load the workbook's data sheets.
LOCK - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
lockObject(EssLock) - Method in interface com.appliedolap.essbase.EssCube
Lock Object Locks the object in the specified application and database and returns the details of the locked object
lockObject(EssLock) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
LOW_DATA - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Restructure
 

M

markForDelete(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Marks every member of a dimension for deletion, so a following build can spare the ones it mentions and EssBatchOutlineEdit.deleteMarked(String) removes the rest.
MAX_APPLICATIONS - Static variable in interface com.appliedolap.essbase.EssServer
For now, we're setting a generous upper limit on the number of applications that can be returned in a listing.
MDX - Enum constant in enum class com.appliedolap.essbase.EssScript.ScriptType
An MDX script.
MDX_GENERATOR - Enum constant in enum class com.appliedolap.essbase.EssAiFeature
Writing an MDX query from a question asked in English.
MdxJson - Class in com.appliedolap.essbase.misc
 
MdxJson() - Constructor for class com.appliedolap.essbase.misc.MdxJson
 
MdxJson.Metadata - Class in com.appliedolap.essbase.misc
 
MdxJson.PageDimension - Class in com.appliedolap.essbase.misc
A dimension that the query left off both axes, so it contributes a single point-of-view member to every cell.
MdxOptions() - Constructor for class com.appliedolap.essbase.impl.EssCubeImpl.MdxOptions
Deprecated.
 
meaninglessCells(boolean) - Method in class com.appliedolap.essbase.EssMdxOptions
Sets the server's meaninglessCells preference.
MEMBER - Enum constant in enum class com.appliedolap.essbase.EssCubeView.CellType
 
MEMBER - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
memberIdentifierType(EssCube.MdxIdentifierType) - Method in class com.appliedolap.essbase.EssMdxOptions
How to name the members in the result: by name (the server's default), by alias, or by unique name.
memberName() - Method in record class com.appliedolap.essbase.EssCubeView.MemberPlacement
Returns the value of the memberName record component.
memberNamesById() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
Planning member ids to member names, for every member in the file.
MemberPlacement(int, int, String) - Constructor for record class com.appliedolap.essbase.EssCubeView.MemberPlacement
Creates an instance of a MemberPlacement record class.
Message(EssBatchOutlineEditResult.Severity, int, String) - Constructor for class com.appliedolap.essbase.EssBatchOutlineEditResult.Message
 
Metadata() - Constructor for class com.appliedolap.essbase.misc.MdxJson.Metadata
 
MISSING - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Skip
 
move(EssFilePathDetail, Boolean) - Method in interface com.appliedolap.essbase.EssFile
Moves a file from source to destination.
move(EssFilePathDetail, Boolean) - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
moveMember(String, String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
MS_SQL - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
MULTIPLE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.HierarchyType
 
MULTIPLY - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
 
MYSQL - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 

N

name() - Method in record class com.appliedolap.essbase.EssCubeView.DimensionPlacement
Returns the value of the name record component.
NAME - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxIdentifierType
 
nameUnique(boolean) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionAction
Whether member names in this dimension have to be unique across the outline.
navigateWithoutData() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the navigateWithoutData record component.
needsParts(long) - Method in class com.appliedolap.essbase.EssUploadConfig
Whether a file of this size has to be sent in parts.
NEVER - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
 
NEVER_SHARE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DataStorage
 
NEVER_SHARE - Enum constant in enum class com.appliedolap.essbase.EssMember.DataStorage
Stored, and never implicitly shared with a sole child.
NEXT_LEVEL - Enum constant in enum class com.appliedolap.essbase.EssCubeView.ZoomInPreference
 
NO_ALIASES - Static variable in interface com.appliedolap.essbase.EssCubeView
The alias table name that means "label members with their own names".
NO_CONNECTION_CONFIGURED - Enum constant in enum class com.appliedolap.essbase.EssAiReadiness.State
The server supports AI but no AI connection has been configured on it, so there is no model for any application to talk to.
NO_DATA - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Restructure
Indexes only - drops the data.
NONE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
 
NONE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Skip
 
NONE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.TimeBalance
 
NONE - Enum constant in enum class com.appliedolap.essbase.EssCubeView.Indentation
 
NONE - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionType
An ordinary dimension, and what an absent value means.
NoSuchEssbaseObjectException - Exception in com.appliedolap.essbase.exceptions
 
NoSuchEssbaseObjectException(String, EssObject.Type) - Constructor for exception com.appliedolap.essbase.exceptions.NoSuchEssbaseObjectException
 
NOT_SUPPORTED - Enum constant in enum class com.appliedolap.essbase.EssAiReadiness.State
The server has no AI endpoints at all.
NOTIFICATION - Enum constant in enum class com.appliedolap.essbase.EssLogEntry.Severity
 

O

observeSetCookies(List<String>) - Method in interface com.appliedolap.essbase.EssAuthentication
Offers the Set-Cookie headers from a response, so an implementation that establishes a session as it goes can pick one up.
observeSetCookies(List<String>) - Method in class com.appliedolap.essbase.impl.SessionAuthentication
 
observeSetCookies(List<String>) - Method in class com.appliedolap.essbase.impl.SessionCookieAuthentication
Picks up how long this session has left.
of(EssAiReadiness.State, String) - Static method in class com.appliedolap.essbase.EssAiReadiness
 
of(String) - Static method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
Reads the 21.7 form, where the whole entry is the dimension name.
open(Path) - Static method in class com.appliedolap.essbase.EssPlanningSnapshot
Opens a snapshot.
openCubeView() - Method in interface com.appliedolap.essbase.EssCube
Opens a live, ad hoc grid view on this cube using its default layout - the REST analog of the Java API's IEssCube.openCubeView.
openCubeView() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
openCubeView(String) - Method in interface com.appliedolap.essbase.EssCube
Opens a live, ad hoc grid view on this cube using a specific saved layout by name, rather than whatever is currently saved as "Default".
openCubeView(String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
ORACLE - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
OUTLINE - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
outlineVersion(int) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
The outline version this edit expects, for guarding against a concurrent change.
overwrite(boolean) - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
Whether the import may overwrite artifacts it finds already present.

P

PageDimension() - Constructor for class com.appliedolap.essbase.misc.MdxJson.PageDimension
 
PARENT_CHILD - Enum constant in enum class com.appliedolap.essbase.EssDrillthroughColumnMapping.MappingType
 
parse(String) - Static method in enum class com.appliedolap.essbase.EssApplication.Status
Creates a status by parsing the given text.
parse(String) - Static method in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
parse(String) - Static method in enum class com.appliedolap.essbase.EssDimension.StorageType
Reads the server's name for a storage type.
parse(String) - Static method in enum class com.appliedolap.essbase.EssJob.JobType
 
parse(String) - Static method in class com.appliedolap.essbase.EssLogEntry
Reads one entry.
parse(String) - Static method in enum class com.appliedolap.essbase.EssLogEntry.Severity
 
parse(String) - Static method in enum class com.appliedolap.essbase.EssMember.DataStorage
Reads the server's spelling, tolerating separators and case.
parse(String) - Static method in enum class com.appliedolap.essbase.EssMember.DimensionStorage
 
parse(String) - Static method in enum class com.appliedolap.essbase.EssMember.DimensionType
 
parse(String) - Static method in enum class com.appliedolap.essbase.EssScript.ScriptType
 
parseAll(InputStream) - Static method in class com.appliedolap.essbase.EssLogEntry
Reads a whole log.
PERCENT - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
 
pivot(int) - Method in interface com.appliedolap.essbase.EssCubeView
Moves a dimension to the front of the row axis, which is what a pivot with no destination does.
pivot(int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
pivot(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Moves a dimension to somewhere else in the grid.
pivot(int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
pivotToPov(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Moves a dimension into the POV.
pivotToPov(int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
POV - Enum constant in enum class com.appliedolap.essbase.EssCubeView.DimensionPlacement.Region
 
preview(String) - Method in class com.appliedolap.essbase.EssPlanningSnapshot
What the snapshot holds for a plan type, without changing anything.
print() - Method in class com.appliedolap.essbase.impl.EssGridImpl
 
print(PrintStream) - Method in class com.appliedolap.essbase.impl.EssGridImpl
 
prototype(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
The member this one shares data with.

R

Range(int, int, int, int) - Constructor for class com.appliedolap.essbase.EssCubeView.Range
 
read(ApiContext, String, String) - Static method in class com.appliedolap.essbase.impl.EssMdxFunctions
 
read(Path) - Static method in class com.appliedolap.essbase.EssPlanningDimensionFile
Reads one dimension file.
readDimension(String) - Method in class com.appliedolap.essbase.EssPlanningSnapshot
Reads one dimension out of the snapshot.
readLatestLog() - Method in interface com.appliedolap.essbase.EssApplication
Reads the latest application log and parses it.
readLatestLog() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
READY - Enum constant in enum class com.appliedolap.essbase.EssAiReadiness.State
Every prerequisite this can see is in place, so a capability call will reach the model.
recreateApplication(boolean) - Method in class com.appliedolap.essbase.EssWorkbookImportOptions
Whether to destroy an existing application of this name and build it again.
refresh() - Method in interface com.appliedolap.essbase.EssCubeView
Re-executes the view as-is, picking up any data changes made since it was last retrieved.
refresh() - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
refreshStatus() - Method in interface com.appliedolap.essbase.EssApplication
Asks the server for this application's status again, and updates this object with the answer.
refreshStatus() - Method in interface com.appliedolap.essbase.EssCube
Asks the server for this cube's status again, and updates this object with the answer.
refreshStatus() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
refreshStatus() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
region() - Method in record class com.appliedolap.essbase.EssCubeView.DimensionPlacement
Returns the value of the region record component.
removeGroups(String...) - Method in interface com.appliedolap.essbase.EssGroup
Removes member groups from this group.
removeGroups(String...) - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
removeOnly(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Removes the member at the given position, keeping the rest.
removeOnly(int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
removeOnly(int, int, int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Removes the members in a rectangle of cells, keeping their siblings.
removeOnly(int, int, int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
removeOnly(List<EssCubeView.Range>) - Method in interface com.appliedolap.essbase.EssCubeView
Removes the members in several rectangles at once, keeping their siblings.
removeOnly(List<EssCubeView.Range>) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
removeUnselectedGroup() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the removeUnselectedGroup record component.
removeUsers(String...) - Method in interface com.appliedolap.essbase.EssGroup
Removes users from this group.
removeUsers(String...) - Method in class com.appliedolap.essbase.impl.EssGroupImpl
Removal is a DELETE carrying a body - the array of user IDs - which is unusual enough to be worth naming: every query parameter form of this answers HTTP 500 "Request failed."
rename(EssFilePathDetail, Boolean) - Method in interface com.appliedolap.essbase.EssFile
Renames a file or folder.
rename(EssFilePathDetail, Boolean) - Method in class com.appliedolap.essbase.impl.EssFileImpl
 
rename(String) - Method in interface com.appliedolap.essbase.EssApplication
Renames this application.
rename(String) - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
renameMember(String, String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
repeatMemberLabels() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the repeatMemberLabels record component.
Report() - Constructor for class com.appliedolap.essbase.EssPlanningSnapshot.Report
 
rerun() - Method in interface com.appliedolap.essbase.EssJob
Re-run the job (using the Essbase REST API method to re-run a job).
rerun() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
resetDefaultView() - Method in interface com.appliedolap.essbase.EssCube
Resets EssCube.openCubeView()'s "default grid" back to the true stateless default (the first grid you'd see in an ad hoc analysis, before any grid operations).
resetDefaultView() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
The layout to delete is named after the current user, so this needs to know who that is.
restructure(EssBatchOutlineEdit.Restructure) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
row() - Method in record class com.appliedolap.essbase.EssCubeView.CellEdit
Returns the value of the row record component.
row() - Method in record class com.appliedolap.essbase.EssCubeView.MemberPlacement
Returns the value of the row record component.
RUN_CALCULATION - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 
RUN_MDX_SCRIPT - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
 

S

save() - Method in interface com.appliedolap.essbase.EssDrillthrough
Saves updates to this report
save() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
save(String) - Method in interface com.appliedolap.essbase.EssScript
Replaces the script's text on the server.
save(String) - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
SCENARIO - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
SCRIPT - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
SEMANTIC_SEARCH - Enum constant in enum class com.appliedolap.essbase.EssAiFeature
Finding members by meaning rather than by name.
SERVER - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
SERVER - Enum constant in enum class com.appliedolap.essbase.EssVariable.Scope
 
session(String, String) - Static method in interface com.appliedolap.essbase.EssAuthentication
Username and password until the server returns a session, then the session thereafter.
SESSION - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
SessionAuthentication - Class in com.appliedolap.essbase.impl
Username and password until the server hands back a session, then the session from then on.
SessionAuthentication(String, String) - Constructor for class com.appliedolap.essbase.impl.SessionAuthentication
 
sessionCookie(String, String) - Static method in interface com.appliedolap.essbase.EssAuthentication
An existing session, presented as cookies, with no username or password anywhere.
SessionCookieAuthentication - Class in com.appliedolap.essbase.impl
An already-established session, presented as cookies.
SessionCookieAuthentication(String, String) - Constructor for class com.appliedolap.essbase.impl.SessionCookieAuthentication
 
sessionEnded() - Method in interface com.appliedolap.essbase.EssAuthentication
Told that the session this was using has been ended server-side, so that any session state held here is discarded rather than being presented again after it has stopped being valid.
sessionEnded() - Method in class com.appliedolap.essbase.impl.SessionAuthentication
Forgets the session, falling back to the username and password.
sessionEnded() - Method in class com.appliedolap.essbase.impl.SessionCookieAuthentication
Stops presenting the session.
sessionExpiry() - Method in interface com.appliedolap.essbase.EssAuthentication
When the current session expires, if that is known.
sessionExpiry() - Method in class com.appliedolap.essbase.impl.SessionAuthentication
 
sessionExpiry() - Method in class com.appliedolap.essbase.impl.SessionCookieAuthentication
 
set(String) - Method in interface com.appliedolap.essbase.EssApplicationConfiguration
Sets this key on the application, adding it if it wasn't there and replacing the value if it was.
set(String) - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
 
set(String, String) - Method in interface com.appliedolap.essbase.EssApplicationConfig
Sets a key, adding it if the application didn't have it and replacing the value if it did.
setAliasTable(String) - Method in interface com.appliedolap.essbase.EssCubeView
Sets the alias table this grid's members are labelled from.
setAliasTable(String) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
setAllowDuplicates(boolean) - Method in class com.appliedolap.essbase.impl.EssServerImpl.DatabaseCreateOptions
 
setColumn(List<String>) - Method in class com.appliedolap.essbase.misc.MdxJson.Metadata
 
setColumnMappings(Map<String, EssDrillthroughColumnMapping>) - Method in interface com.appliedolap.essbase.EssDrillthrough
Sets the column-to-dimension mappings.
setColumnMappings(Map<String, EssDrillthroughColumnMapping>) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
setColumns(List<String>) - Method in interface com.appliedolap.essbase.EssDrillthrough
Sets the source columns this report returns.
setColumns(List<String>) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
Sets the list of column names for this report.
setData(List<List<String>>) - Method in class com.appliedolap.essbase.misc.MdxJson
 
setDataSourceName(String) - Method in interface com.appliedolap.essbase.EssDrillthrough
Sets the name of the data source for this report.
setDataSourceName(String) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
setDataStorage(String, EssBatchOutlineEdit.DataStorage, EssBatchOutlineEdit.ApplyTo, Integer) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Sets data storage across a swathe of members at once.
setDescription(String) - Method in interface com.appliedolap.essbase.EssGroup
Changes the description, leaving the role alone.
setDescription(String) - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
setDrillableRegions(List<String>) - Method in interface com.appliedolap.essbase.EssDrillthrough
Sets the drillable regions for this report
setDrillableRegions(List<String>) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
setEnableScenarios(boolean) - Method in class com.appliedolap.essbase.impl.EssServerImpl.DatabaseCreateOptions
 
setExpand(String) - Method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
 
setId(Integer) - Method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
 
setLayout(String[][], int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Rewrites the grid as a sheet of labels of any shape, saying where the data region begins.
setLayout(String[][], int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
setLayout(List<String>) - Method in interface com.appliedolap.essbase.EssCubeView
Rewrites the grid as a sheet of labels and asks the server to interpret it.
setLayout(List<String>) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
Sends the sheet as given and lets the engine read it.
setLogSettings(List<EssLogSetting>) - Method in interface com.appliedolap.essbase.EssServer
Changes how the log handlers rotate.
setLogSettings(List<EssLogSetting>) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
setMembers(List<EssCubeView.MemberPlacement>) - Method in interface com.appliedolap.essbase.EssCubeView
Replaces the members at the given positions, in one request.
setMembers(List<EssCubeView.MemberPlacement>) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
setMetadata(MdxJson.Metadata) - Method in class com.appliedolap.essbase.misc.MdxJson
 
setName(String) - Method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
 
setPage(List<MdxJson.PageDimension>) - Method in class com.appliedolap.essbase.misc.MdxJson.Metadata
 
setPassword(String) - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
setPov(String) - Method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
 
setPreferences(EssCubeView.GridPreferences) - Method in interface com.appliedolap.essbase.EssCubeView
Replaces the current session's ad hoc display/navigation preferences.
setPreferences(EssCubeView.GridPreferences) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
setRole(String) - Method in interface com.appliedolap.essbase.EssGroup
Changes the role this group grants.
setRole(String) - Method in class com.appliedolap.essbase.impl.EssGroupImpl
 
setRow(List<String>) - Method in class com.appliedolap.essbase.misc.MdxJson.Metadata
 
setServer(String) - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
setStateless(boolean) - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
setType(EssServer.ApplicationType) - Method in class com.appliedolap.essbase.impl.EssServerImpl.DatabaseCreateOptions
 
setUrl(String) - Method in interface com.appliedolap.essbase.EssDrillthrough
Sets the drill (again, likely to change soon)
setUrl(String) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
setUsername(String) - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
setUseTempTables(boolean) - Method in interface com.appliedolap.essbase.EssDrillthrough
Sets the useTempTables parameter for this report which is only valid using Oracle DB.
setUseTempTables(boolean) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
 
setValue(String) - Method in interface com.appliedolap.essbase.EssVariable
Changes this variable's value on the server, in place.
setValue(String) - Method in class com.appliedolap.essbase.impl.EssVariableImpl
 
shadows(EssVariable.Scope) - Method in enum class com.appliedolap.essbase.EssVariable.Scope
Whether a variable at this scope takes precedence over one at the given scope.
SHARED - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DataStorage
Only meaningful in a unique-name outline; elsewhere use prototypeMbr.
SHARED - Enum constant in enum class com.appliedolap.essbase.EssMember.DataStorage
A pointer to another member's data rather than data of its own.
signOff() - Method in interface com.appliedolap.essbase.EssServer
Ends this client's own session on the server.
signOff() - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
size() - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
size() - Method in class com.appliedolap.essbase.EssCubeView.Range
How many cells the rectangle covers.
skip(EssBatchOutlineEdit.Skip) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
solveOrder(int) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionAction
 
solveOrder(int) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
sortChildren(String, EssBatchOutlineEdit.SortOrder, boolean) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
SPARK - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
SPARSE - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionStorage
 
SPARSE - Enum constant in enum class com.appliedolap.essbase.EssDimension.StorageType
 
SPARSE - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionStorage
 
start() - Method in interface com.appliedolap.essbase.EssApplication
Starts the application
start() - Method in interface com.appliedolap.essbase.EssCube
Starts this cube, and with it the application that owns it - a cube cannot run in a stopped application, so the server starts both.
start() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
start() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
STARTED - Enum constant in enum class com.appliedolap.essbase.EssApplication.Status
Application is in the started state.
stop() - Method in interface com.appliedolap.essbase.EssApplication
Stops the application.
stop() - Method in interface com.appliedolap.essbase.EssCube
Stops this cube, leaving its application running.
stop() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
 
stop() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
STOPPED - Enum constant in enum class com.appliedolap.essbase.EssApplication.Status
Application is in the stopped state.
storage(EssBatchOutlineEdit.DimensionStorage) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionAction
 
STORE_DATA - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DataStorage
 
STORED - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.HierarchyType
 
STORED - Enum constant in enum class com.appliedolap.essbase.EssMember.DataStorage
The default, and what an absent value means.
streamDataSource(String, boolean, String, Map<String, Object>, OutputStream) - Method in interface com.appliedolap.essbase.EssServer
Calls the global data source endpoint to execute a query against a data source with the given parameters.
streamDataSource(String, boolean, String, Map<String, Object>, OutputStream) - Method in class com.appliedolap.essbase.impl.EssServerImpl
Runs a query against a data source and writes the rows out.
SUBITEMS - Enum constant in enum class com.appliedolap.essbase.EssCubeView.Indentation
 
submitData(List<EssCubeView.CellEdit>) - Method in interface com.appliedolap.essbase.EssCubeView
Writes values back into the cube, in one request.
submitData(List<EssCubeView.CellEdit>) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
SUBTRACT - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
 
suppressMissingColumns() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the suppressMissingColumns record component.
suppressMissingRows() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the suppressMissingRows record component.
suppressUnderscoreRows() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the suppressUnderscoreRows record component.
suppressZeroRows() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the suppressZeroRows record component.

T

TEMPLATE - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
 
test() - Method in interface com.appliedolap.essbase.EssConnection
Checks the connection without saving anything.
test() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
Tests the saved connection.
testFileConnection(String, String) - Method in interface com.appliedolap.essbase.EssServer
Tests a connection that hasn't been saved, so a caller can check before committing.
testFileConnection(String, String) - Method in class com.appliedolap.essbase.impl.EssServerImpl
 
textList(boolean) - Method in class com.appliedolap.essbase.EssMdxOptions
Sets the server's textList preference.
TIME - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
 
TIME - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionType
 
timeBalance(EssBatchOutlineEdit.TimeBalance) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
timeout(Duration) - Method in class com.appliedolap.essbase.EssMdxOptions
How long to wait for the server's answer before giving up, which fails the query with an EssApiException caused by a HttpTimeoutException.
toBatchOutlineEdit(String) - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
The members of this dimension as a batch outline edit, ready to apply to a cube.
TOP - Enum constant in enum class com.appliedolap.essbase.EssCubeView.DimensionPlacement.Region
 
toStorageRefinement(String) - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
The storage types that could not be set while the dimension was being built, as a second edit.
toString() - Method in class com.appliedolap.essbase.EssAiReadiness
 
toString() - Method in record class com.appliedolap.essbase.EssApiSpec
Returns a string representation of this record class.
toString() - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
toString() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult.Message
 
toString() - Method in class com.appliedolap.essbase.EssBatchOutlineEditResult
 
toString() - Method in record class com.appliedolap.essbase.EssCubeView.CellEdit
Returns a string representation of this record class.
toString() - Method in record class com.appliedolap.essbase.EssCubeView.DimensionPlacement
Returns a string representation of this record class.
toString() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns a string representation of this record class.
toString() - Method in record class com.appliedolap.essbase.EssCubeView.MemberPlacement
Returns a string representation of this record class.
toString() - Method in class com.appliedolap.essbase.EssCubeView.Range
 
toString() - Method in class com.appliedolap.essbase.EssDataSourceColumn
 
toString() - Method in class com.appliedolap.essbase.EssDrillthroughColumnMapping
 
toString() - Method in class com.appliedolap.essbase.EssDrillthroughResult.Column
 
toString() - Method in class com.appliedolap.essbase.EssDrillthroughResult
 
toString() - Method in class com.appliedolap.essbase.EssEffectiveVariable
 
toString() - Method in enum class com.appliedolap.essbase.EssJob.JobType
 
toString() - Method in class com.appliedolap.essbase.EssLogEntry
 
toString() - Method in class com.appliedolap.essbase.EssLogSetting
 
toString() - Method in class com.appliedolap.essbase.EssMaintenanceLimits
 
toString() - Method in class com.appliedolap.essbase.EssMcpParameter
 
toString() - Method in class com.appliedolap.essbase.EssMcpResult
 
toString() - Method in class com.appliedolap.essbase.EssMcpTool
 
toString() - Method in class com.appliedolap.essbase.EssMdxFunction
 
toString() - Method in class com.appliedolap.essbase.EssMdxFunctionGroup
 
toString() - Method in class com.appliedolap.essbase.EssPermission
 
toString() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
 
toString() - Method in class com.appliedolap.essbase.EssPlanningDimensionFile
 
toString() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionOutcome
 
toString() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.DimensionSummary
 
toString() - Method in class com.appliedolap.essbase.EssPlanningSnapshot.Report
 
toString() - Method in class com.appliedolap.essbase.EssResourceLimit
 
toString() - Method in class com.appliedolap.essbase.EssUploadConfig
 
toString() - Method in class com.appliedolap.essbase.impl.EssApplicationConfigurationImpl
 
toString() - Method in class com.appliedolap.essbase.impl.EssConnectionImpl
 
toString() - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
 
toString() - Method in class com.appliedolap.essbase.impl.EssVariableImpl
 
toString() - Method in class com.appliedolap.essbase.misc.MdxJson.PageDimension
 
TOTALS - Enum constant in enum class com.appliedolap.essbase.EssCubeView.Indentation
 
toXml() - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
The document, as the XML the endpoint takes.
TRACE - Enum constant in enum class com.appliedolap.essbase.EssLogEntry.Severity
 
twoPassCalc(boolean) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
Two-pass calculation, which is an attribute of mbrInfo rather than an element.

U

uda(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
Adds a UDA, replacing whatever the member had.
uda(String, boolean, boolean) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit.MemberAction
 
undetermined(String, Throwable) - Static method in class com.appliedolap.essbase.EssAiReadiness
 
UNDETERMINED - Enum constant in enum class com.appliedolap.essbase.EssAiReadiness.State
The check itself could not be completed - the server was unreachable, or answered in a way this doesn't recognize.
UNIQUE_NAME - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxIdentifierType
 
UNKNOWN - Enum constant in enum class com.appliedolap.essbase.EssApplication.Status
State is unknown, currently unknown whether there are any states beyond stopped and started (such as starting) but this gives us some buffer against unknown states breaking the API.
UNKNOWN - Enum constant in enum class com.appliedolap.essbase.EssConnection.ConnectionType
A type this client doesn't name.
UNKNOWN - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
There is no "other" type for an Essbase job, but this gives us some wiggle room in case a new type is introduced, or we cannot otherwise properly parse the return type.
UNKNOWN - Enum constant in enum class com.appliedolap.essbase.EssJob.Status
This is not an official code, we're just using it as a buffer against changes in the API
UNKNOWN - Enum constant in enum class com.appliedolap.essbase.EssLogEntry.Severity
A severity this doesn't name, or a line that didn't parse.
UNKNOWN - Enum constant in enum class com.appliedolap.essbase.EssMember.DataStorage
A storage this version of the client doesn't name; the raw value is in EssMember.getProperties().
UNKNOWN - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionType
A type this version of the client doesn't name; the raw value is in EssMember.getProperties().
unlockObject(EssLock) - Method in interface com.appliedolap.essbase.EssCube
Unlock Object Unlocks the object in the specified application and database
unlockObject(EssLock) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
 
UNSPECIFIED - Enum constant in enum class com.appliedolap.essbase.EssMember.DimensionStorage
Not a standard dimension, or not a dimension at all.
updateDimension(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Changes a dimension's own properties.
updateMember(String) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Changes an existing member's properties.
uploadFile(File) - Method in interface com.appliedolap.essbase.EssFolder
Uploads a file to this folder.
uploadFile(File) - Method in class com.appliedolap.essbase.impl.EssFolderImpl
 
URL - Enum constant in enum class com.appliedolap.essbase.EssDrillthrough.DrillthroughType
 
URL - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
urlDrillThrough(boolean) - Method in class com.appliedolap.essbase.EssMdxOptions
Sets the server's urlDrillThrough preference.
useBothNamesAndAliases() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the useBothNamesAndAliases record component.
USER - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
username() - Method in interface com.appliedolap.essbase.EssAuthentication
The user being authenticated as, where this strategy knows it.
username() - Method in class com.appliedolap.essbase.impl.BasicAuthentication
 
username() - Method in class com.appliedolap.essbase.impl.SessionAuthentication
 
UTILITY - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 

V

validate() - Method in interface com.appliedolap.essbase.EssScript
Checks the script without running it.
validate() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
 
validate(boolean) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
Whether the server validates the outline after applying the edit.
validateFormulas(boolean) - Method in class com.appliedolap.essbase.EssBatchOutlineEdit
 
value() - Method in record class com.appliedolap.essbase.EssCubeView.CellEdit
Returns the value of the value record component.
value(String) - Method in class com.appliedolap.essbase.EssPlanningDimensionFile.Member
Any column, by its header, for something this class does not model.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssAiFeature
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssAiReadiness.State
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssApplication.Status
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.ApplyTo
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DataStorage
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionStorage
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.HierarchyType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Restructure
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Skip
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.SortOrder
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.TimeBalance
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEditResult.Severity
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssConnection.ConnectionType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssCube.MdxIdentifierType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssCube.MdxOutputType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssCubeView.CellType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssCubeView.DimensionPlacement.Region
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssCubeView.Indentation
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssCubeView.ZoomInPreference
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssDimension.StorageType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssDrillthrough.DrillthroughType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssDrillthroughColumnMapping.MappingType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssJob.JobType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssJob.Status
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssLogEntry.Severity
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssMember.DataStorage
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssMember.DimensionStorage
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssMember.DimensionType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssObject.Type
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssScript.ScriptType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssServer.ApplicationType
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.appliedolap.essbase.EssVariable.Scope
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.appliedolap.essbase.EssAiFeature
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssAiReadiness.State
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssApplication.Status
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.ApplyTo
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Consolidation
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DataStorage
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionCategory
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.DimensionStorage
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.HierarchyType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Restructure
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Skip
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.SortOrder
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEdit.TimeBalance
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssBatchOutlineEditResult.Severity
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssConnection.ConnectionType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssCube.MdxIdentifierType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssCube.MdxOutputType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssCubeView.CellType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssCubeView.DimensionPlacement.Region
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssCubeView.Indentation
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssCubeView.ZoomInPreference
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssDimension.StorageType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssDrillthrough.DrillthroughType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssDrillthroughColumnMapping.MappingType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssJob.JobType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssJob.Status
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssLogEntry.Severity
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssMember.DataStorage
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssMember.DimensionStorage
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssMember.DimensionType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssObject.Type
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssScript.ScriptType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssServer.ApplicationType
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.appliedolap.essbase.EssVariable.Scope
Returns an array containing the constants of this enum class, in the order they are declared.
variable() - Method in class com.appliedolap.essbase.impl.EssVariableImpl
The document as the server sent it, for a subclass that needs to resend it.
VARIABLE - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
 
version() - Method in record class com.appliedolap.essbase.EssApiSpec
Returns the value of the version record component.

W

waitForCompletion() - Method in interface com.appliedolap.essbase.EssJob
Loops while re-polling the job for its static to change to one that is complete (successfully or otherwise).
waitForCompletion() - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
waitForCompletion(long, TimeUnit) - Method in interface com.appliedolap.essbase.EssJob
Waits given amount of time for job to complete.
waitForCompletion(long, TimeUnit) - Method in class com.appliedolap.essbase.impl.EssJobImpl
 
WARNING - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEditResult.Severity
 
WARNING - Enum constant in enum class com.appliedolap.essbase.EssLogEntry.Severity
 
withinSelectedGroup() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the withinSelectedGroup record component.
withProfile(String) - Method in interface com.appliedolap.essbase.EssCubeAi
The chat profile capability calls are made against.
withProfile(String) - Method in class com.appliedolap.essbase.impl.EssCubeAiImpl
 
withSizes(Integer, Integer) - Method in class com.appliedolap.essbase.EssLogSetting

X

XLSX - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxOutputType
 

Z

ZERO - Enum constant in enum class com.appliedolap.essbase.EssBatchOutlineEdit.Skip
 
zoomIn(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Zooms in on the member at the given position, using the server's default zoom-in preference.
zoomIn(int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
zoomIn(List<EssCubeView.Range>) - Method in interface com.appliedolap.essbase.EssCubeView
Zooms in on the members in several rectangles at once.
zoomIn(List<EssCubeView.Range>) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
zoomInPreference() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
Returns the value of the zoomInPreference record component.
zoomOut(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
Zooms out from the member at the given position.
zoomOut(int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
zoomOut(List<EssCubeView.Range>) - Method in interface com.appliedolap.essbase.EssCubeView
Zooms out of the members in several rectangles at once.
zoomOut(List<EssCubeView.Range>) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
 
A B C D E F G H I J K L M N O P R S T U V W X Z 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form