Index
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
- ALIAS - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxIdentifierType
- ALL_LEVELS - Enum constant in enum class com.appliedolap.essbase.EssCubeView.ZoomInPreference
- 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
- applicationsApi() - Method in class com.appliedolap.essbase.ApiContext
- ASO - Enum constant in enum class com.appliedolap.essbase.EssServer.ApplicationType
-
ASO/Aggregate Storage Option
- authorizationHeader() - Method in interface com.appliedolap.essbase.EssAuthentication
-
The value for the
Authorizationheader, 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
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
- 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
- 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
C
- CLEAR_AGGREGATIONS - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
- CLEAR_DATA - Enum constant in enum class com.appliedolap.essbase.EssJob.JobType
- col() - Method in record class com.appliedolap.essbase.EssCubeView.MemberPlacement
-
Returns the value of the
colrecord component. - 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
EssApiExceptionsubtypes 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 incom.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.
- COMPLETED - Enum constant in enum class com.appliedolap.essbase.EssJob.Status
- COMPLETED_WITH_WARNINGS - Enum constant in enum class com.appliedolap.essbase.EssJob.Status
- cookieHeader() - Method in interface com.appliedolap.essbase.EssAuthentication
-
The value for the
Cookieheader, 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
- create() - Method in class com.appliedolap.essbase.ApiClientFactory
- 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
- 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
- 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.EssServer
-
Creates a new server-wide variable with the given name and value.
- 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
- 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
- DATASOURCE - Enum constant in enum class com.appliedolap.essbase.EssDrillthrough.DrillthroughType
- DATASOURCE - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
- DEFAULT_REST_API_PATH - Static variable in interface com.appliedolap.essbase.EssServer
- delete() - Method in interface com.appliedolap.essbase.EssApplication
-
Deletes this application.
- 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.EssScript
- delete() - Method in interface com.appliedolap.essbase.EssVariable
-
Deletes the variable.
- delete() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
- 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.EssScriptImpl
- delete() - Method in class com.appliedolap.essbase.impl.EssVariableImpl
- DELIMITER_SPACE - Static variable in interface com.appliedolap.essbase.EssDataSource
- DELIMITER_TAB - Static variable in interface com.appliedolap.essbase.EssDataSource
- describe() - Method in record class com.appliedolap.essbase.EssApiSpec
-
e.g.
- DIMENSION - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
- 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
- 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
E
- 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.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.
- EssApiException - Exception in com.appliedolap.essbase
-
A general, unchecked exception that we can be used to wrap the
ApiExceptionchecked exceptions that are all over the generated client code. - EssApiException(String) - Constructor for exception com.appliedolap.essbase.EssApiException
- 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
EssApiSpecrecord class. - EssApplication - Interface in com.appliedolap.essbase
- EssApplication.Status - Enum Class in com.appliedolap.essbase
-
An enumeration for the different application states.
- EssApplicationConfiguration - Interface in com.appliedolap.essbase
- EssApplicationConfigurationImpl - Class in com.appliedolap.essbase.impl
-
Represents a configuration item (basically speaking, a key/value pair) on an application.
- 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
- EssApplicationVariableImpl - Class in com.appliedolap.essbase.impl
-
Represents a variable that is associated with a particular application.
- EssAuthentication - Interface in com.appliedolap.essbase
-
How a client proves who it is to Essbase.
- ESSBASE_NETWORK_LOGGING - Static variable in class com.appliedolap.essbase.ApiClientFactory
- EssCube - Interface in com.appliedolap.essbase
- EssCube.MdxIdentifierType - Enum Class in com.appliedolap.essbase
- EssCube.MdxOutputType - Enum Class in com.appliedolap.essbase
- 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
- EssCubeVariable - Interface in com.appliedolap.essbase
- EssCubeVariableImpl - Class in com.appliedolap.essbase.impl
-
A variable that is specific to a particular 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.CellType - Enum Class in com.appliedolap.essbase
-
A coarse classification of a cell as either a data position or a member/label.
- 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.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
- 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
- EssDimension - Interface in com.appliedolap.essbase
- 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
- 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.Options - Class in com.appliedolap.essbase.impl
-
Options for drill-through report execution.
- EssDrillthroughImpl.Parameter - Class in com.appliedolap.essbase.impl
- 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
- 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
- EssMember - Interface in com.appliedolap.essbase
- 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.
- 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
- EssScriptImpl - Class in com.appliedolap.essbase.impl
-
Represents a script object (calc, report, etc.) on Essbase cube/application.
- EssServer - Interface in com.appliedolap.essbase
- EssServer.ApplicationType - Enum Class in com.appliedolap.essbase
-
A cube type, despite the name.
- 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
-
The about information of this server.
- EssServerImpl.AboutInstance - Class in com.appliedolap.essbase.impl
- EssServerImpl.DatabaseCreateOptions - Class in com.appliedolap.essbase.impl
-
Database creation options.
- 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
- 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
- EssVariable.Scope - Enum Class in com.appliedolap.essbase
-
Models variable scope.
- EssVariableImpl - Class in com.appliedolap.essbase.impl
-
A variable on the Essbase server.
- EssVariableImpl(ApiContext, Variable) - Constructor for class com.appliedolap.essbase.impl.EssVariableImpl
- EssZipFileDetails - Class in com.appliedolap.essbase
- EssZipFileDetails() - Constructor for class com.appliedolap.essbase.EssZipFileDetails
- ExcelExportOptions() - Constructor for class com.appliedolap.essbase.impl.EssCubeImpl.ExcelExportOptions
- execute() - Method in interface com.appliedolap.essbase.EssScript
-
Create a job to execute this script (assumes calc for now)
- execute() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
- executeMdx(String) - Method in interface com.appliedolap.essbase.EssCube
- executeMdx(String) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
- executeMdx(String, EssCube.MdxOutputType, EssCubeImpl.MdxOptions, OutputStream) - Method in interface com.appliedolap.essbase.EssCube
- executeMdx(String, EssCube.MdxOutputType, EssCubeImpl.MdxOptions, OutputStream) - Method in class com.appliedolap.essbase.impl.EssCubeImpl
- 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 Excel workbook.
- exportExcel() - Method in class com.appliedolap.essbase.impl.EssCubeImpl
- 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
- FILE - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
- format() - Method in record class com.appliedolap.essbase.EssApiSpec
-
Returns the value of the
formatrecord component. - fromCode(int) - Static method in enum class com.appliedolap.essbase.EssJob.Status
- fullPath - Variable in class com.appliedolap.essbase.impl.EssFileImpl
G
- GENERATION - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
- getAbout() - Method in interface com.appliedolap.essbase.EssServer
-
Gets the "about" information for this server.
- getAbout() - 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
- 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
-
Gets the owning application for this variable.
- getApplication() - Method in interface com.appliedolap.essbase.EssCube
-
Gets the parent application of this cube.
- 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(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
- 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
- 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
- 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
- getCellType(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
-
Classifies the cell at the given position as
EssCubeView.CellType.DATAorEssCubeView.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
- getColumnMappingInfo() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.ColumnMapping
- getColumnMappings() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
-
Gets information about report column mappings.
- getColumnName() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.ColumnMapping
- getColumns() - Method in interface com.appliedolap.essbase.EssGrid
- getColumns() - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
- 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
- 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
- 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
- getContent() - Method in interface com.appliedolap.essbase.EssScript
- getContent() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
- 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 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(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
- 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
-
Get the list of global data sources defined on the server.
- getDataSources() - Method in class com.appliedolap.essbase.impl.EssServerImpl
- getDelimiter() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.Options
-
Gets the current delimiter.
- 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.impl.EssGroupImpl
- getDescription() - Method in class com.appliedolap.essbase.impl.EssJobImpl
- getDescription() - Method in class com.appliedolap.essbase.impl.EssServerImpl.About
- 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.impl.EssCubeImpl
- getDimensions() - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
- getDimensionsApi() - Method in class com.appliedolap.essbase.ApiContext
- 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
DATASOURCEorURL. - getDrillthroughType() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
- 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
- getEmail() - Method in interface com.appliedolap.essbase.EssUser
- getEmail() - Method in class com.appliedolap.essbase.impl.EssUserImpl
- 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
- getExecuteMdxApi() - Method in class com.appliedolap.essbase.ApiContext
- 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
- 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
- getFiles() - Method in class com.appliedolap.essbase.impl.EssServerImpl
- getFilesApi() - Method in class com.appliedolap.essbase.ApiContext
- 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
- 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
- getGlobalDataSourcesApi() - Method in class com.appliedolap.essbase.ApiContext
- getGridApi() - Method in class com.appliedolap.essbase.ApiContext
- getGridPreferencesApi() - Method in class com.appliedolap.essbase.ApiContext
- 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
- 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
- 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
- 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 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
- 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
- getLoginTimeInSeconds() - Method in interface com.appliedolap.essbase.EssSession
-
Number of seconds session has been created
- getLoginTimeInSeconds() - Method in class com.appliedolap.essbase.impl.EssSessionImpl
- 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
- getMemberSearch(String) - Method in interface com.appliedolap.essbase.EssOutline
- getMemberSearch(String) - Method in class com.appliedolap.essbase.impl.EssOutlineImpl
- 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 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 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 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 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
-
Gets the name of this variable.
- 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.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
-
The name of this script.
- 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
- 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
- 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
- getParam() - Method in enum class com.appliedolap.essbase.EssJob.JobType
-
Represents the name of the param used in the JSON request to the server.
- getParameterMappings() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
-
Gets information about parameter mappings.
- getParent() - Method in interface com.appliedolap.essbase.EssMember
-
Gets the parent member (not implemented yet).
- getParent() - Method in class com.appliedolap.essbase.impl.EssMemberImpl
- getPassword() - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
- 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.EssFileImpl
- 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
- getProvisioningSupported() - Method in class com.appliedolap.essbase.impl.EssServerImpl.AboutInstance
- 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.
- getRow() - Method in class com.appliedolap.essbase.misc.MdxJson.Metadata
- 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
- 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 interface com.appliedolap.essbase.EssApplicationVariable
-
Gets the scope of this variable.
- getScope() - Method in interface com.appliedolap.essbase.EssCubeVariable
- getScope() - Method in interface com.appliedolap.essbase.EssVariable
-
Gets the scope of this variable.
- 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.EssVariableImpl
- getScriptsApi() - Method in class com.appliedolap.essbase.ApiContext
- 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.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.EssUserImpl
- getServerVariablesApi() - 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.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.EssCubeImpl
- getSessions() - Method in class com.appliedolap.essbase.impl.EssServerImpl
- getSessionsApi() - Method in class com.appliedolap.essbase.ApiContext
- getSize() - Method in interface com.appliedolap.essbase.EssScript
- getSize() - Method in class com.appliedolap.essbase.impl.EssScriptImpl
- getStatus() - Method in interface com.appliedolap.essbase.EssApplication
-
Gets the status of this application.
- 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.EssJobImpl
- getTemplatesAndUtilitiesApi() - Method in class com.appliedolap.essbase.ApiContext
- getTime() - Method in interface com.appliedolap.essbase.EssLock
- getTime() - Method in class com.appliedolap.essbase.impl.EssLockImpl
- 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 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.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
- getUnique() - Method in interface com.appliedolap.essbase.EssGeneration
-
Gets the unique setting of the generation
- getUnique() - Method in class com.appliedolap.essbase.impl.EssGenerationImpl
- 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
- 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 class com.appliedolap.essbase.impl.EssGroupImpl
- 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.
- getValue() - Method in interface com.appliedolap.essbase.EssVariable
-
Gets the value of this variable.
- 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
-
Gets the list of variables specific to this cube.
- 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
- getVersion() - Method in class com.appliedolap.essbase.impl.EssServerImpl.About
- 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
-
Creates an instance of a
GridPreferencesrecord 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.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.
- 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
- IN_PROGRESS - Enum constant in enum class com.appliedolap.essbase.EssJob.Status
-
Represented in the Essbase REST API with code 100.
- includeSelection() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
-
Returns the value of the
includeSelectionrecord component. - indentation() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
-
Returns the value of the
indentationrecord component. - 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
- isComplete() - Method in enum class com.appliedolap.essbase.EssJob.Status
- 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
- isEnableScenarios() - Method in class com.appliedolap.essbase.impl.EssServerImpl.DatabaseCreateOptions
- 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
-
Inverse of
EssFolder.isFolder(). - 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
EssFolderobjects, false forEssFileImplobjects). - isFolder() - Method in class com.appliedolap.essbase.impl.EssFileImpl
- isFolder() - Method in class com.appliedolap.essbase.impl.EssFolderImpl
- isIncludeHeaders() - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.Options
-
Gets the value for including headers.
- 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
- isPrintable() - Method in enum class com.appliedolap.essbase.EssCube.MdxOutputType
- 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 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.impl.EssJobImpl
- 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
- 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
jsonrecord 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
- 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.EssServer
-
Kill all sessions on the server.
- 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
- 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() - Method in interface com.appliedolap.essbase.EssFile
-
Deprecated.
- lcmImport() - Method in class com.appliedolap.essbase.impl.EssFileImpl
-
Deprecated.
- LEVEL - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
- 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
- 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
M
- 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.
- MdxJson - Class in com.appliedolap.essbase.misc
- MdxJson() - Constructor for class com.appliedolap.essbase.misc.MdxJson
- MdxJson.Metadata - Class in com.appliedolap.essbase.misc
- MdxOptions() - Constructor for class com.appliedolap.essbase.impl.EssCubeImpl.MdxOptions
- MEMBER - Enum constant in enum class com.appliedolap.essbase.EssCubeView.CellType
- MEMBER - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
- memberName() - Method in record class com.appliedolap.essbase.EssCubeView.MemberPlacement
-
Returns the value of the
memberNamerecord component. - MemberPlacement(int, int, String) - Constructor for record class com.appliedolap.essbase.EssCubeView.MemberPlacement
-
Creates an instance of a
MemberPlacementrecord class. - Metadata() - Constructor for class com.appliedolap.essbase.misc.MdxJson.Metadata
- 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
N
- NAME - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxIdentifierType
- NEXT_LEVEL - Enum constant in enum class com.appliedolap.essbase.EssCubeView.ZoomInPreference
- NONE - Enum constant in enum class com.appliedolap.essbase.EssCubeView.Indentation
- NoSuchEssbaseObjectException - Exception in com.appliedolap.essbase.exceptions
- NoSuchEssbaseObjectException(String, EssObject.Type) - Constructor for exception com.appliedolap.essbase.exceptions.NoSuchEssbaseObjectException
O
- observeSetCookies(List<String>) - Method in interface com.appliedolap.essbase.EssAuthentication
-
Offers the
Set-Cookieheaders 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.
- 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
- Options() - Constructor for class com.appliedolap.essbase.impl.EssDrillthroughImpl.Options
- OUTLINE - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
P
- 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.EssJob.JobType
- pivot(int, int, int, int) - Method in interface com.appliedolap.essbase.EssCubeView
-
Swaps the positions of the members at the two given coordinates.
- pivot(int, int, int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
- pivotToPov(int, int) - Method in interface com.appliedolap.essbase.EssCubeView
-
Pins the member at the given position into the POV, removing its dimension from whichever axis it currently occupies.
- pivotToPov(int, int) - Method in class com.appliedolap.essbase.impl.EssCubeViewImpl
- print() - Method in class com.appliedolap.essbase.impl.EssGridImpl
- print(PrintStream) - Method in class com.appliedolap.essbase.impl.EssGridImpl
R
- 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
- 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
- removeUnselectedGroup() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
-
Returns the value of the
removeUnselectedGrouprecord component. - 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
- repeatMemberLabels() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
-
Returns the value of the
repeatMemberLabelsrecord component. - 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.
- row() - Method in record class com.appliedolap.essbase.EssCubeView.MemberPlacement
-
Returns the value of the
rowrecord component. - run(Map<String, String>, OutputStream) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
-
Executes a drill-through request for the given POV and sends output to the given output stream.
- run(Map<String, String>, OutputStream, EssDrillthroughImpl.Options) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
-
Executes a drill-through request for the given POV and sends output to the given output stream.
- 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
- SCENARIO - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
- SCRIPT - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
- 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
- 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, EssDrillthroughImpl.ColumnMapping>) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
-
Sets a map of column mapping objects to update.
- 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
- setDelimiter(String) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.Options
-
Sets the delimiter to use.
- 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
- setIncludeHeaders(boolean) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl.Options
-
Sets whether headers are to be included in the output or not.
- 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
- setPage(List<String>) - Method in class com.appliedolap.essbase.misc.MdxJson.Metadata
- setPassword(String) - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
- 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
- setRow(List<String>) - Method in class com.appliedolap.essbase.misc.MdxJson.Metadata
- setRunTimeParameters(Map<String, EssDrillthroughImpl.Parameter>) - Method in class com.appliedolap.essbase.impl.EssDrillthroughImpl
-
Sets a map of parameter mappings to update.
- 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
- 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
- start() - Method in interface com.appliedolap.essbase.EssApplication
-
Starts the application
- start() - Method in class com.appliedolap.essbase.impl.EssApplicationImpl
- 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 class com.appliedolap.essbase.impl.EssApplicationImpl
- STOPPED - Enum constant in enum class com.appliedolap.essbase.EssApplication.Status
-
Application is in the stopped state.
- 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
- SUBITEMS - Enum constant in enum class com.appliedolap.essbase.EssCubeView.Indentation
- suppressMissingRows() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
-
Returns the value of the
suppressMissingRowsrecord component. - suppressUnderscoreRows() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
-
Returns the value of the
suppressUnderscoreRowsrecord component. - suppressZeroRows() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
-
Returns the value of the
suppressZeroRowsrecord component.
T
- toString() - Method in record class com.appliedolap.essbase.EssApiSpec
-
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 enum class com.appliedolap.essbase.EssJob.JobType
- toString() - Method in class com.appliedolap.essbase.impl.EssServerConnectionDetailsImpl
- TOTALS - Enum constant in enum class com.appliedolap.essbase.EssCubeView.Indentation
U
- 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.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
- 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
- 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
- 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
- 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.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.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.EssDrillthrough.DrillthroughType
-
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.EssObject.Type
-
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.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.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.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.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.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.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.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 - Enum constant in enum class com.appliedolap.essbase.EssObject.Type
- version() - Method in record class com.appliedolap.essbase.EssApiSpec
-
Returns the value of the
versionrecord 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
- withinSelectedGroup() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
-
Returns the value of the
withinSelectedGrouprecord component.
X
- XLSX - Enum constant in enum class com.appliedolap.essbase.EssCube.MdxOutputType
Z
- 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
- zoomInPreference() - Method in record class com.appliedolap.essbase.EssCubeView.GridPreferences
-
Returns the value of the
zoomInPreferencerecord 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
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form