Oracle Enterprise Performance Management Cloud, Groovy Rules Java API Reference
A B C D E F G H I J L M N O P Q R S T U V Y 

A

addColumn(String...) - Method in interface oracle.epm.api.grid.DataGridBuilder
Add a row of column headers to this grid.
addColumn(List<String>, List<List<String>>) - Method in interface oracle.epm.api.grid.DataGridDefinitionBuilder
Add column members to this grid definition.
addDynamicChild(Object) - Method in class oracle.epm.api.model.Member
Returns the new child member that was created and saved with the specified name if this member was enabled for dynamic children.
addPov(String...) - Method in interface oracle.epm.api.grid.DataGridBuilder
Add POV members to this grid.
addRow(List<String>, List) - Method in interface oracle.epm.api.grid.DataGridBuilder
Add a list of row headers and data for the corresponding columns to this grid.
addRow(List<String>, List<List<String>>) - Method in interface oracle.epm.api.grid.DataGridDefinitionBuilder
Add row members to this grid definition.
addValidationError(Integer, String) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Sets the background color and tooltip for this data cell, and vetos the operation during which this validation error is added.
addValidationError(Integer, String, boolean) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Sets the background color and tooltip for this data cell, and vetos the operation during which this validation error is added if isValid is false.
Application - Class in oracle.epm.api.model
This object represents an EPM application.
ApplicationType - Enum in oracle.epm.api.model
An enumeration containing a list of valid application types.
asString() - Method in class oracle.epm.api.model.rest.BaseRequest
Executes this request and returns the response as a String.
AttributeDimension - Class in oracle.epm.api.model
This object represents an attribute dimension.
AttributeMember - Class in oracle.epm.api.model
This object represents an attribute dimension member.
AttributeType - Enum in oracle.epm.api.model
An enumeration containing a list of valid attribute types.
awaitCompletion() - Method in class oracle.epm.api.model.Job
Returns the status of this job once it has completed or failed.

B

BasePeriodType - Enum in oracle.epm.api.model
An enumeration containing a list of valid base period types.
BaseRequest - Class in oracle.epm.api.model.rest
This object is a base class for all HTTP requests.
body(String) - Method in class oracle.epm.api.model.rest.HttpRequestWithBody
Returns this object after setting the body as a String.
body(String) - Method in class oracle.epm.api.model.rest.RequestBodyEntity
Returns this object afer setting its body as a String.
build() - Method in interface oracle.epm.api.grid.DataGridBuilder
Returns a grid built from the region defined by the caller.
build(DataGridBuilder.Status) - Method in interface oracle.epm.api.grid.DataGridBuilder
Returns a grid built from the region defined by the caller.
build() - Method in interface oracle.epm.api.grid.DataGridDefinitionBuilder
Returns a data grid definition built from the region defined by the caller.

C

close() - Method in class oracle.epm.api.model.StrategicModel
Releases system resources associated with SM.
Connection - Class in oracle.epm.api.model
This object represents a communications link between the Groovy script and a HTTP/HTTPS resource.
connection(String, String, String) - Method in class oracle.epm.api.script.EpmScript
Returns a new connection to the resource identified by the sepcified URL.
createSmartPush() - Method in class oracle.epm.api.model.DataMap
Returns a SmartPush that can be used to push data to the target location specified in the underlying data map.
crossDimCell(String...) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the first matching (top left) cell in this grid that represents the specified members or null if no matching cells are found.
cscParams(Collection<?>) - Method in class oracle.epm.api.script.EpmScript
Returns a string value with each of the specified items flattened, quoted and seperated by a comma.
cscParams(Object...) - Method in class oracle.epm.api.script.EpmScript
Returns a string value with each of the specified items flattened, quoted and seperated by a comma.
Cube - Class in oracle.epm.api.model
This object represents a cube.
CurrencyMode - Enum in oracle.epm.api.model
An enumeration containing a list of valid application currency modes.
currentTimeMillis() - Method in class oracle.epm.api.script.EpmScript
Returns the current time in milliseconds.

D

dataCellIterator() - Method in interface oracle.epm.api.grid.DataGrid
Returns an iterator to iterate over all data cells in this data grid.
dataCellIterator(MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid
Returns an iterator to iterate over all data cells in this data grid.
dataCellIterator(String...) - Method in interface oracle.epm.api.grid.DataGrid
Returns an iterator to iterate over data cells with the specified members in this data grid.
dataCellIterator(MemberNameType, String...) - Method in interface oracle.epm.api.grid.DataGrid
Returns an iterator to iterate over data cells with the specified members in this data grid.
dataCellIterator(Predicate) - Method in interface oracle.epm.api.grid.DataGrid
Returns an iterator to iterate over data cells in this data grid where the data cells match the specified predicate conditions.
dataCellIterator(Predicate, MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid
Returns an iterator to iterate over data cells in this data grid where the data cells match the specified predicate conditions.
DataGrid - Interface in oracle.epm.api.grid
A data grid interface that provides access to the POV/Row/Column header cells and provides various iterators to iterate over the data cells.
DataGrid.Cell - Interface in oracle.epm.api.grid
A base interface for all cells.
DataGrid.DataCell - Interface in oracle.epm.api.grid
An interface representing a data cell in a data grid.
DataGrid.HeaderCell - Interface in oracle.epm.api.grid
An interface representing a header cell in a data grid.
DataGrid.Row - Interface in oracle.epm.api.grid
An interface representing a row in the data grid.
DataGridBuilder - Interface in oracle.epm.api.grid
A helper class to build a data grid that defines a slice of data to save.
dataGridBuilder(String) - Method in class oracle.epm.api.model.Cube
Returns a data grid builder.
dataGridBuilder(String, ExecuteAsUser) - Method in class oracle.epm.api.model.Cube
Returns a data grid builder.
dataGridBuilder() - Method in class oracle.epm.api.model.StrategicModel
Returns a data grid builder for this model.
dataGridBuilder(boolean) - Method in class oracle.epm.api.model.StrategicModel
Returns a data grid builder for this model.
DataGridBuilder.Status - Class in oracle.epm.api.grid
This class contains the results of the build operation.
DataGridBuilder.Status() - Constructor for class oracle.epm.api.grid.DataGridBuilder.Status
 
DataGridDefinition - Interface in oracle.epm.api.grid
A data grid definition defines a slice or region to load data from.
DataGridDefinition.GridSegment - Interface in oracle.epm.api.grid
A data grid segment defines the dimensions and members in a particular axis of the grid.
DataGridDefinitionBuilder - Interface in oracle.epm.api.grid
A helper class to build a data grid definition that defines a slice or a region from which to load the data.
dataGridDefinitionBuilder() - Method in class oracle.epm.api.model.Cube
Returns a grid definition builder.
dataGridDefinitionBuilder() - Method in class oracle.epm.api.model.StrategicModel
Returns a grid definition builder.
dataGridDefinitionBuilder(boolean) - Method in class oracle.epm.api.model.StrategicModel
Returns a grid definition builder.
dataGridDefinitionBuilder(boolean, boolean) - Method in class oracle.epm.api.model.StrategicModel
Returns a grid definition builder.
DataMap - Class in oracle.epm.api.model
This object represents a data map that defines the metadata mappings between a source cube and a target cube.
DataType - Enum in oracle.epm.api.model
An enumeration containing a list of valid data types.
delete(String) - Method in class oracle.epm.api.model.Connection
Creates and returns a Http DELETE request.
delete() - Method in class oracle.epm.api.model.Connection
Creates and returns a Http DELETE request.
delete() - Method in class oracle.epm.api.model.Member
Deletes this member and all descendants of this member from the Planning application outline.
deleteDynamicMember() - Method in class oracle.epm.api.model.Member
Deletes this member and all descendants of this member from the Planning application outline if the parent was enabled for dynamic children.
Dimension - Class in oracle.epm.api.model
This object represents a dimension.
DimensionType - Enum in oracle.epm.api.model
An enumeration containing a list of valid dimension types.
domain(String) - Method in class oracle.epm.api.model.Connection
Returns this connection after setting the domain for the resource this connection is configured for.
DynamicChildStrategy - Enum in oracle.epm.api.model
Defines various strategies for adding a dynamic member.

E

EpmScript - Class in oracle.epm.api.script
This object represents a Groovy script and is the base class for all EPM Groovy scripts.
EpmScript() - Constructor for class oracle.epm.api.script.EpmScript
Constructs an instance of this class with default parameters.
EssbaseCompatible - Interface in oracle.epm.api.model
This interface represents objects that can be used in Essbase Calc Scripts.
execute(Map<String, String>, boolean) - Method in class oracle.epm.api.model.DataMap
Executes this data map using the specified override members map, clearing data in the target region beforehand if requested.
execute(Map<String, String>, Map<String, String>, boolean) - Method in class oracle.epm.api.model.DataMap
Executes this data map using the specified override members map, clearing data in the target region beforehand if requested.
execute(boolean) - Method in class oracle.epm.api.model.DataMap
Executes this data map, clearing data in the target region beforehand if requested.
execute() - Method in class oracle.epm.api.model.SmartPush
Executes a smart push against the underlying DataMap.
execute(boolean) - Method in class oracle.epm.api.model.SmartPush
Executes a smart push against the underlying DataMap.
execute(Map<String, String>) - Method in class oracle.epm.api.model.SmartPush
Executes this smart push against the underlying DataMap using the specified override members map.
execute(Map<String, String>, boolean) - Method in class oracle.epm.api.model.SmartPush
Executes this smart push against the underlying DataMap using the specified override members map.
execute(Map<String, String>, Map<String, String>) - Method in class oracle.epm.api.model.SmartPush
Executes this smart push against the underlying DataMap using the specified override members map.
execute(Map<String, String>, Map<String, String>, boolean) - Method in class oracle.epm.api.model.SmartPush
Executes this smart push against the underlying DataMap using the specified override members map.
ExecuteAsUser - Enum in oracle.epm.api.model
An enumeration containing a list of user types to execute an operation on behalf of.
executeCalcScript(String) - Method in class oracle.epm.api.model.Cube
Executes the specified calc script.
executeJob(JobDefinition) - Method in class oracle.epm.api.model.Application
Executes the job with the specified job definition and returns the job once it has completed or failed.
executeJob(JobDefinition) - Method in class oracle.epm.api.script.EpmScript
Executes the job with the specified job definition and returns the job once it has completed or failed.
exportDataToFile(DataGrid, String) - Method in class oracle.epm.api.model.Operation
Exports the data in the specified data grid to a CSV file and uploads it to the Outbox.
exportDataToFile(DataGrid, String, Predicate) - Method in class oracle.epm.api.model.Operation
Exports the data in the specified data grid to a CSV file and uploads it to the Outbox.

F

FiscalCalendar - Class in oracle.epm.api.model
This object represents a fiscal calendar.
FiscalYearStart - Enum in oracle.epm.api.model
An enumeration containing a list of valid fiscal year start types.
fixValues(EssbaseCompatible...) - Method in class oracle.epm.api.script.EpmScript
Returns a string value for the specified objects that can be plugged into a Essbase calc script FIX command.
fromString(String) - Static method in enum oracle.epm.api.model.AttributeType
Returns an instance of the enum with the specified display name.
fromString(String) - Static method in enum oracle.epm.api.model.BasePeriodType
Returns an instance of the enum with the specified display name.
fromString(String) - Static method in enum oracle.epm.api.model.DataType
Returns an instance of the enum with the specified display name.
fromString(String) - Static method in enum oracle.epm.api.model.DimensionType
Returns an instance of the enum with the specified display name.
fromString(String) - Static method in enum oracle.epm.api.model.ExecuteAsUser
Returns an instance of the enum with the specified display name.
fromString(String) - Static method in enum oracle.epm.api.model.FiscalYearStart
Returns an instance of the enum with the specified display name.
fromString(String) - Static method in enum oracle.epm.api.model.JobStatus
Get a JobStatus from a string.

G

get(String) - Method in class oracle.epm.api.model.Connection
Creates and returns a Http GET request.
get() - Method in class oracle.epm.api.model.Connection
Creates and returns a Http GET request.
getAccountName() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the account name for this cell.
getAccountName(MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the account name for this cell based on the specified member name type.
getApplication() - Method in class oracle.epm.api.model.Cube
Returns the application to which this cube belongs.
getApplication() - Method in class oracle.epm.api.model.Operation
Returns the application on which the current operation is being performed.
getApplicationType(String) - Static method in enum oracle.epm.api.model.ApplicationType
Returns an instance of the enum with the specified display name.
getApplicationType(int) - Static method in enum oracle.epm.api.model.ApplicationType
Returns an instance of the enum with the specified identifier.
getAttributeDimensions() - Method in class oracle.epm.api.model.Dimension
Returns a list of attribute dimensions associated with this dimension.
getAttributeType() - Method in class oracle.epm.api.model.AttributeDimension
Returns this attribute dimension's type.
getAttributeType(int) - Static method in enum oracle.epm.api.model.AttributeType
Returns an instance of the enum with the specified type.
getAttributeValue(AttributeDimension) - Method in class oracle.epm.api.model.Member
Returns either the attribute member in the specified attribute dimension associated with this member or null.
getBaseAndSharedMembers(Cube...) - Method in class oracle.epm.api.model.Member
Returns a list of the base and shared members that are shared with this member.
getBaseDimension() - Method in class oracle.epm.api.model.AttributeDimension
Returns the base dimension for this attribute dimension.
getBasePeriodType(int) - Static method in enum oracle.epm.api.model.BasePeriodType
Returns an instance of the enum with the specified type.
getBasePeriodType() - Method in class oracle.epm.api.model.FiscalCalendar
Returns the fiscal year base period type.
getBgColor() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the background color for this data cell.
getBody() - Method in class oracle.epm.api.model.rest.HttpResponse
Returns the body as type T for this response.
getBody() - Method in class oracle.epm.api.model.rest.RequestBodyEntity
Returns the body encapsulated by this request.
getBodyEntity() - Method in class oracle.epm.api.model.rest.HttpRequest
Returns the RequestBodyEntity for this request if it supports a body.
getBooleanValue() - Method in class oracle.epm.api.model.RtpValue
Returns the boolean value represented by this rtp.
getCalendar() - Method in class oracle.epm.api.model.Application
Returns the fiscal calendar for this application.
getCause() - Method in exception oracle.epm.api.VetoOperationException
Returns the cause for this exception.
getCellsRejected() - Method in class oracle.epm.api.grid.DataGridBuilder.Status
Returns a list of the first 100 cells that were rejected.
getCellWithMembers(String...) - Method in interface oracle.epm.api.grid.DataGrid
Returns the first matching (top left) cell in this grid that represents the specified members or null if no matching cells are found.
getChild(Object) - Method in class oracle.epm.api.model.Member
Returns the child member with the specified name of this member.
getColumns() - Method in interface oracle.epm.api.grid.DataGrid
Returns a list of column header cells grouped by dimension for this data grid.
getColumns() - Method in interface oracle.epm.api.grid.DataGridDefinition
Returns the list of column segments.
getConnection(String) - Method in class oracle.epm.api.model.Application
Returns the connection with the specified name.
getCube(String) - Method in class oracle.epm.api.model.Application
Returns the cube with the specified name.
getCube() - Method in class oracle.epm.api.model.Operation
Returns the cube against which this operation is being performed.
getCube() - Method in class oracle.epm.api.model.Rule
Returns the cube this rule will execute against.
getCubes() - Method in class oracle.epm.api.model.Application
Returns a list of cubes belonging to this application.
getCurrencyCode() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the currency code for this data if the application is enabled for multiple currencies.
getCurrencyMode() - Method in class oracle.epm.api.model.Application
Returns the currency model for this application.
getCurrencyMode(String) - Static method in enum oracle.epm.api.model.CurrencyMode
Returns an instance of the enum with the specified display name.
getCurrencyMode(int) - Static method in enum oracle.epm.api.model.CurrencyMode
Returns an instance of the enum with the specified identifier.
getCurrentCell() - Method in interface oracle.epm.api.grid.GridIterator
Returns the current cell from the iterator.
getCurrentTimePeriod() - Method in class oracle.epm.api.model.FiscalCalendar
Returns the current time period for this fiscal calendar.
getCurrentYear() - Method in class oracle.epm.api.model.FiscalCalendar
Returns the current year for this fiscal calendar.
getData() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the data value in this data cell.
getData() - Method in interface oracle.epm.api.grid.DataGrid.Row
Returns the data cells for this row.
getDataAsDate() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns a date representation of the data value in this data cell if the data type is DATE; otherwise null is returned.
getDataAsSmartListMemberName() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the name of the member from which this data cell's smart list value is derived.
getDataAsSmartListMemberName(MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the name of the member based on the specified member name type from which this data cell's smart list value is derived.
getDataMap(String) - Method in class oracle.epm.api.model.Application
Returns the data map with the specified name.
getDataMaps() - Method in class oracle.epm.api.model.Application
Returns all the data maps defined for this application.
getDataType() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the data type for this data cell.
getDataType(int) - Static method in enum oracle.epm.api.model.DataType
Returns an instance of the enum with the specified type.
getDataValueProvider() - Method in class oracle.epm.api.model.Operation
Returns a data value provider for the current operation.
getDate() - Method in class oracle.epm.api.model.RtpValue
Returns a Date representation for this rtp.
getDefaultCurrency() - Method in class oracle.epm.api.model.Application
Returns the default currency member for this application.
getDefaultMemberNameType() - Method in interface oracle.epm.api.grid.GridIterator
Returns the default member name type.
getDefinition() - Method in class oracle.epm.api.model.Job
Retutns the job definition that this job is a running instance of.
getDescription() - Method in class oracle.epm.api.model.Cube
Returns the description for this cube.
getDescription() - Method in class oracle.epm.api.model.Dimension
Returns the description for this dimension.
getDescription() - Method in class oracle.epm.api.model.Member
Returns the description for this member.
getDescription() - Method in class oracle.epm.api.model.Rule
Returns the description for this rule.
getDescriptiveStatus() - Method in enum oracle.epm.api.model.JobStatus
Returns the name of this enum constant, as contained in the declaration.
getDetails() - Method in class oracle.epm.api.model.Job
Returns the execution details for this job.
getDimension(String, Cube...) - Method in class oracle.epm.api.model.Application
Returns the dimension with the specified name.
getDimension(DimensionType, Cube...) - Method in class oracle.epm.api.model.Application
Returns a dimension with the specified dimension type.
getDimension() - Method in class oracle.epm.api.model.Member
Returns the dimension this member belongs to.
getDimension() - Method in class oracle.epm.api.model.RtpValue
Returns a Dimension representation for this rtp.
getDimensions() - Method in interface oracle.epm.api.grid.DataGridDefinition.GridSegment
Returns the dimensions represented in this segment.
getDimensions(Cube...) - Method in class oracle.epm.api.model.Application
Returns a list of dimensions.
getDimensionType() - Method in interface oracle.epm.api.grid.DataGrid.HeaderCell
Returns the type of the dimension for the member that this header cell represents.
getDimensionType(int) - Static method in enum oracle.epm.api.model.DimensionType
Returns an instance of the enum with the specified type.
getDimId() - Method in enum oracle.epm.api.model.DimensionType
Returns the dimension id of this enum constant.
getDimName() - Method in interface oracle.epm.api.grid.DataGrid.HeaderCell
Returns the name of the dimension for the member that this header cell represents.
getDimType() - Method in enum oracle.epm.api.model.DimensionType
Returns the integer type of this enum constant, as contained in the declaration.
getDisplayName() - Method in enum oracle.epm.api.model.ApplicationType
Returns the display name of this enum constant, exactly as declared in its enum declaration.
getDisplayName() - Method in enum oracle.epm.api.model.AttributeType
Returns the name of this enum constant, as contained in the declaration.
getDisplayName() - Method in enum oracle.epm.api.model.BasePeriodType
Returns the name of this enum constant, as contained in the declaration.
getDisplayName() - Method in enum oracle.epm.api.model.CurrencyMode
Returns the display name of this enum constant, exactly as declared in its enum declaration.
getDisplayName() - Method in enum oracle.epm.api.model.DataType
Returns the name of this enum constant, as contained in the declaration.
getDisplayName() - Method in enum oracle.epm.api.model.DimensionType
Returns the name of this enum constant, as contained in the declaration.
getDisplayName() - Method in enum oracle.epm.api.model.ExecuteAsUser
Returns the name of this enum constant, as contained in the declaration.
getDisplayName() - Method in enum oracle.epm.api.model.FiscalYearStart
Returns the name of this enum constant, as contained in the declaration.
getDomain() - Method in class oracle.epm.api.model.Connection
Returns the domain for the resource this connection is configured for.
getDoubleValue() - Method in class oracle.epm.api.model.RtpValue
Returns the double value represented by this rtp.
getEnteredValue() - Method in class oracle.epm.api.model.RtpValue
Returns the value entered by the end user for this rtp.
getEntityName() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the entity name for this cell.
getEntityName(MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the entity name for this cell based on the specified member name type.
getEntry(String) - Method in class oracle.epm.api.model.SmartList
Returns the entry with the specified value.
getEntry(long) - Method in class oracle.epm.api.model.SmartList
Returns the entry with the specified entry id.
getEntryId() - Method in class oracle.epm.api.model.SmartList.Entry
Returns the entry Id.
getEntryId(String, String) - Method in class oracle.epm.api.script.EpmScript
Returns the smart list entry id for the specified smart list name and entry name.
getEssbaseMbrName() - Method in interface oracle.epm.api.grid.DataGrid.HeaderCell
Returns the name of the member in the physical olap model that this header cell represents.
getEssbaseName() - Method in class oracle.epm.api.model.Cube
Returns the physical name for this cube in Essbase.
getEssbaseUniqueMbrName() - Method in interface oracle.epm.api.grid.DataGrid.HeaderCell
Returns the name of the member in the physical olap model that this header cell represents.
getEssbaseValue() - Method in class oracle.epm.api.model.RtpValue
Returns the value for this rtp to be used in an Essbase calc script.
getEvaluatedMembers(String, Cube) - Method in class oracle.epm.api.model.Dimension
Returns a list of members by evaluating the functions, expressions and/or members specified in the membersString against the specified cube.
getExecuteAsUser(int) - Static method in enum oracle.epm.api.model.ExecuteAsUser
Returns an instance of the enum with the specified type.
getFirstCalanderYear() - Method in class oracle.epm.api.model.FiscalCalendar
Returns the first calendar year for this fiscal calendar.
getFirstFiscalYear() - Method in class oracle.epm.api.model.FiscalCalendar
Returns the first fiscal year in this fiscal calendar.
getFirstPeriod() - Method in class oracle.epm.api.model.FiscalCalendar
Returns the first period in which your fiscal year begins for this fiscal calendar.
getFirstPeriod() - Method in class oracle.epm.api.model.PeriodDimension
Returns the first base time period member in this application.
getFirstYear() - Method in class oracle.epm.api.model.YearDimension
Returns the first year member in this dimension.
getFiscalYearStart() - Method in class oracle.epm.api.model.FiscalCalendar
Returns the fiscal year start date type for this fiscal calendar.
getFiscalYearStart(int) - Static method in enum oracle.epm.api.model.FiscalYearStart
Returns an instance of the enum with the specified type.
getFixValue() - Method in class oracle.epm.api.model.Dimension
Returns a value that can be used in a FIX statement.
getFixValue() - Method in interface oracle.epm.api.model.EssbaseCompatible
Returns a value that can be used in a FIX statement.
getFixValue() - Method in class oracle.epm.api.model.Member
Returns a value that can be used in a FIX statement.
getFixValue() - Method in class oracle.epm.api.model.RtpValue
Returns a value that can be used in a FIX statement.
getFormattedValue() - Method in interface oracle.epm.api.grid.DataGrid.Cell
Returns the formatted value for this data cell.
getFullName() - Method in class oracle.epm.api.model.User
Returns the full name of this user.
getGrid() - Method in class oracle.epm.api.model.Operation
Returns a representation of the current data entry form on which the user is working.
getHeaders() - Method in interface oracle.epm.api.grid.DataGrid.Row
Returns the header cells for this row.
getHeaders() - Method in class oracle.epm.api.model.rest.HttpRequest
Returns the headers sent/received to/from the resoure this Http request is for.
getHeaders() - Method in class oracle.epm.api.model.rest.HttpResponse
Returns the response headers received from the extrenal resource.
getHttpMethod() - Method in class oracle.epm.api.model.rest.HttpRequest
Returns the method to be performed on a resource this Http request is for.
getHttpRequest() - Method in class oracle.epm.api.model.rest.BaseRequest
Returns the Http request object.
getId() - Method in enum oracle.epm.api.model.ApplicationType
Returns the integer type of this enum constant, as contained in the declaration.
getId() - Method in enum oracle.epm.api.model.CurrencyMode
Returns the integer type of this enum constant, as contained in the declaration.
getIntDataType() - Method in enum oracle.epm.api.model.DataType
Returns the integer type of this enum constant, as contained in the declaration.
getJobFactory() - Method in class oracle.epm.api.model.Application
Returns a job factory.
getJobName() - Method in class oracle.epm.api.model.JobDefinition
Returns the name of the job that this definition describes.
getJobStatus(int) - Static method in enum oracle.epm.api.model.JobStatus
Get a JobStatus from a int.
getJobStatusLabelMap(HspBaseMsgs) - Static method in enum oracle.epm.api.model.JobStatus
Returns a map of job status id to the display label, for all the job types.
getJobType() - Method in class oracle.epm.api.model.JobDefinition
Returns the type of the job that this definition describes.
getLabel() - Method in class oracle.epm.api.model.SmartList.Entry
returns the label for this entry.
getLabel() - Method in class oracle.epm.api.model.SmartList
Returns the smart list's label resource key.
getLastFiscalYear() - Method in class oracle.epm.api.model.FiscalCalendar
Returns the last fiscal year in this fiscal calendar.
getLastPeriod() - Method in class oracle.epm.api.model.PeriodDimension
Returns the last base time period member in this application.
getLastYear() - Method in class oracle.epm.api.model.YearDimension
Returns the last year member in this dimension.
getLocalizedMessage(Locale[]) - Method in exception oracle.epm.api.GroovyDynamicLocalizedException
Returns the localized message of this exception or throwable based on the specified locales.
getLocalizedMessage(Locale) - Method in exception oracle.epm.api.GroovyDynamicLocalizedException
Creates a localized description of this throwable based on the specified locale.
getMbrName() - Method in interface oracle.epm.api.grid.DataGrid.HeaderCell
Returns the name of the member that this header cell represents.
getMember(Object, Cube...) - Method in class oracle.epm.api.model.Dimension
Returns a member with the specified name.
getMember() - Method in class oracle.epm.api.model.RtpValue
Returns a Member representation for this rtp.
getMemberName(String) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the member name for the specified dimension that the cell represents.
getMemberName(String, MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the member name based on the specified member name type for the specified dimension that the cell represents.
getMemberName(DimensionType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the member name for the specified dimension type that the cell represents.
getMemberName(DimensionType, MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the member name based on the specified member name type for the specified dimension type that the cell represents.
getMemberNames() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns a list of members from all dimensions that the cell represents.
getMemberNames(MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns a list of members based on the specified member name type from all dimensions that the cell represents.
getMembers() - Method in interface oracle.epm.api.grid.DataGridDefinition.GridSegment
Returns the members for the dimensions represented in this segment.
getMembers() - Method in class oracle.epm.api.model.RtpValue
Returns a Member list representation for this rtp.
getMemberSelection() - Method in class oracle.epm.api.model.SmartList
Returns the member selection string for members that derive the entries for this smart list.
getMemberSelection() - Method in class oracle.epm.api.model.UserVariable
Returns the member selection string that defines a range of allowed values for this user variable, or null if no range is defined.
getMembersWithUda(String, boolean, Cube...) - Method in class oracle.epm.api.model.Dimension
Returns a list of all the members that have been tagged with the specified user defined attribute.
getMembersWithUdaInEssbase(String, Cube) - Method in class oracle.epm.api.model.Dimension
Returns a list of members in the specified cube that have been tagged with the specified user defined attribute.
getMessage() - Method in exception oracle.epm.api.GroovyDynamicLocalizedException
getMissingLabel() - Method in class oracle.epm.api.model.SmartList
Returns the smart list's missing label.
getName() - Method in class oracle.epm.api.model.Application
Returns the name for this application.
getName() - Method in class oracle.epm.api.model.Connection
Returns the name for this connection.
getName() - Method in class oracle.epm.api.model.Cube
Returns the logical name for this cube.
getName() - Method in class oracle.epm.api.model.DataMap
Returns the name of this data map.
getName() - Method in class oracle.epm.api.model.Dimension
Returns the name of this dimension or the unique name if needed.
getName(MemberNameType) - Method in class oracle.epm.api.model.Dimension
Returns the dimension name of this dimension based on the specified member name type.
getName() - Method in class oracle.epm.api.model.Job
Returns the name of this job.
getName() - Method in class oracle.epm.api.model.Member
Returns the name of this member or the unique name if needed.
getName(MemberNameType) - Method in class oracle.epm.api.model.Member
Returns the member name of this member based on the specified member name type.
getName(DataGrid.HeaderCell) - Method in enum oracle.epm.api.model.MemberNameType
Returns the member name of the specified header cell based on member name type.
getName(HspFormMember) - Method in enum oracle.epm.api.model.MemberNameType
Returns the member name of the specified form member based on member name type.
getName(HspMember) - Method in enum oracle.epm.api.model.MemberNameType
Returns the member name of the specified member based on member name type.
getName() - Method in class oracle.epm.api.model.RtpValue
Returns the name of this rtp.
getName() - Method in class oracle.epm.api.model.Rule
Returns the name of this rule.
getName() - Method in class oracle.epm.api.model.SmartList.Entry
Returns the name of this entry.
getName() - Method in class oracle.epm.api.model.SmartList
Returns the name of this smart list.
getName() - Method in class oracle.epm.api.model.SmartPush
Returns the name of this smart push.
getName() - Method in class oracle.epm.api.model.User
Returns the name of this user.
getName() - Method in class oracle.epm.api.model.UserVariable
Returns the name of this user variable.
getNames(HspMember...) - Method in enum oracle.epm.api.model.MemberNameType
Returns the member name of the specified members based on the member name type
getNumAcceptedCells() - Method in class oracle.epm.api.grid.DataGridBuilder.Status
Returns the total number of accepted cells.
getNumRejectedCells() - Method in class oracle.epm.api.grid.DataGridBuilder.Status
Returns the total number of rejected cells.
getNumYears() - Method in class oracle.epm.api.model.FiscalCalendar
Returns the number of years in this fiscal calendar.
getParameters() - Method in class oracle.epm.api.model.JobDefinition
Returns the parameters this job will be executed with.
getPeriodName() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the period name for this cell.
getPeriodName(MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the period name for this cell based on the specified member name type.
getPov() - Method in interface oracle.epm.api.grid.DataGrid
Returns a list of POV header cells for this data grid.
getPov() - Method in interface oracle.epm.api.grid.DataGridDefinition
Returns the POV grid segment.
getProperties() - Method in class oracle.epm.api.model.Rule
Returns the properties for this rule.
getQueryParams() - Method in class oracle.epm.api.model.rest.HttpRequest
Returns the query parameters for this request.
getResourceBundle(String) - Method in class oracle.epm.api.GroovyResourceBundleLoader
Returns a resource/message bundle for the specified language.
getResourceKey() - Method in exception oracle.epm.api.GroovyDynamicLocalizedException
Returns the resourceKey used by this Exception to lookup a localized message.
getRootMember(Cube...) - Method in class oracle.epm.api.model.Dimension
Returns the root member for this dimension.
getRows() - Method in interface oracle.epm.api.grid.DataGrid
Returns a list of rows for this data grid.
getRows() - Method in interface oracle.epm.api.grid.DataGridDefinition
Returns the list of row segments.
getRtps() - Method in class oracle.epm.api.script.EpmScript
Returns an unmodifiable map of RtpValue objects for the run time prompts used in this script.
getRule() - Method in class oracle.epm.api.script.EpmScript
Returns the current rule being executed.
getScenarioName() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the scenario name for this cell.
getScenarioName(MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the scenario name for this cell based on the specified member name type.
getScript() - Method in class oracle.epm.api.model.Rule
Returns the script of this rule.
getSharedMembers(Cube...) - Method in class oracle.epm.api.model.Member
Returns a list of the shared members that are shared with this member.
getSmartList(String) - Method in class oracle.epm.api.model.Application
Returns a smart list with the specified name.
getSmartListEntry() - Method in class oracle.epm.api.model.RtpValue
Returns a Smartlist.Entry representation for this rtp or null if the rtp value is optional or #missing.
getSmartPush(String) - Method in interface oracle.epm.api.grid.DataGrid
Returns a smart push for the DataMap with the specified name attached to this grid.
getSmartPushes() - Method in interface oracle.epm.api.grid.DataGrid
Returns all the smart pushes attached to this grid.
getSourceInfo() - Method in interface oracle.epm.api.grid.DataGrid
Returns miscellaneous information about the source of this grid.
getStatus() - Method in class oracle.epm.api.model.Job
Returns the status of this job.
getStatus() - Method in enum oracle.epm.api.model.JobStatus
Returns the integer type of this enum constant, as contained in the declaration.
getStatus() - Method in class oracle.epm.api.model.rest.HttpResponse
Returns the Http status code for this response.
getStatusLabelID() - Method in enum oracle.epm.api.model.JobStatus
 
getStatusText() - Method in class oracle.epm.api.model.rest.HttpResponse
Returns the texual sttus for this response.
getStrategicModel(String) - Method in class oracle.epm.api.model.Application
Returns the strategic model with the specified name.
getTextCellId(String, boolean) - Method in class oracle.epm.api.script.EpmScript
Returns the text cell id for the specified text value or 0 if the text value is not found and createIfNotFound is false.
getTooltip() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the tooltip for this data cell.
getType() - Method in class oracle.epm.api.model.Application
Return the type of this application.
getType() - Method in enum oracle.epm.api.model.AttributeType
Returns the integer type of this enum constant, as contained in the declaration.
getType() - Method in enum oracle.epm.api.model.BasePeriodType
Returns the integer type of this enum constant, as contained in the declaration.
getType() - Method in class oracle.epm.api.model.Dimension
Returns the type of this dimension.
getType() - Method in enum oracle.epm.api.model.ExecuteAsUser
Returns the integer type of this enum constant, as contained in the declaration.
getType() - Method in enum oracle.epm.api.model.FiscalYearStart
Returns the integer type of this enum constant, as contained in the declaration.
getUdas() - Method in class oracle.epm.api.model.Dimension
Returns a list of all user defined attributes for this dimension.
getUdas() - Method in class oracle.epm.api.model.Member
Returns a list of all user defined attributes for this member.
getUniqueMbrName() - Method in interface oracle.epm.api.grid.DataGrid.HeaderCell
Returns the name of the member that this header cell represents.
getUrl() - Method in class oracle.epm.api.model.Connection
Returns the url for the resource this connection is configured for.
getUrl() - Method in class oracle.epm.api.model.rest.HttpRequest
Return the URL for the resource this Http request is for.
getUser() - Method in class oracle.epm.api.model.Operation
Returns the user performing this operation.
getUserName() - Method in class oracle.epm.api.model.Connection
Returns the name of the user this connection is configured for.
getUserName() - Method in class oracle.epm.api.model.rest.HttpRequest
Returns the name of the user making this request.
getUserVariable(String) - Method in class oracle.epm.api.model.Application
Returns a user variable with the specified name.
getUserVariable(String) - Method in class oracle.epm.api.model.Dimension
Returns a user variable with the specified name for this dimension.
getUserVariables() - Method in class oracle.epm.api.model.Application
Returns the list of user variables for this application.
getUserVariables() - Method in class oracle.epm.api.model.Dimension
Returns the list of user variables for this application.
getValue() - Method in class oracle.epm.api.model.UserVariable
Returns the value for this user variable for the current user.
getVersionName() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the version name for this cell.
getVersionName(MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the version name for this cell based on the specified member name type.
getYearName() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the year name for this cell.
getYearName(MemberNameType) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns the year name for this cell based on the specified member name type.
GridIterator - Interface in oracle.epm.api.grid
An iterator over a collection of data cells.
GroovyDynamicLocalizedException - Exception in oracle.epm.api
This class is an implementation of HspDynamicLocalizedException and will dynamically return a localized description of this throwable based on the specified locale.
GroovyDynamicLocalizedException(GroovyResourceBundleLoader, String) - Constructor for exception oracle.epm.api.GroovyDynamicLocalizedException
Constructs an instance of GroovyDynamicLocalizedException with the specified parameters.
GroovyDynamicLocalizedException(GroovyResourceBundleLoader, String, Object...) - Constructor for exception oracle.epm.api.GroovyDynamicLocalizedException
Constructs an instance of GroovyDynamicLocalizedException with the specified parameters.
GroovyDynamicLocalizedException(GroovyResourceBundleLoader, String, Throwable) - Constructor for exception oracle.epm.api.GroovyDynamicLocalizedException
Constructs an instance of GroovyDynamicLocalizedException with the specified parameters.
GroovyDynamicLocalizedException(GroovyResourceBundleLoader, String, Throwable, Object...) - Constructor for exception oracle.epm.api.GroovyDynamicLocalizedException
Constructs an instance of GroovyDynamicLocalizedException with the specified parameters.
GroovyMessageBundle - Class in oracle.epm.api
A GroovyMessageBundle manages resources for a locale.
GroovyMessageBundle(Map<String, String>) - Constructor for class oracle.epm.api.GroovyMessageBundle
Constructs an instance of this class with specified parameters.
GroovyResourceBundleLoader - Class in oracle.epm.api
A GroovyResourceBundleLoader manages message bundles by locale.
GroovyResourceBundleLoader(Map<String, ? extends ResourceBundle>) - Constructor for class oracle.epm.api.GroovyResourceBundleLoader
Constructs an instance of this class with specified parameters.

H

hasApplication() - Method in class oracle.epm.api.model.Operation
Returns true if the application property is valid for this operation.
hasCellAttach() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns true if one or more attachments are present for this data cell.
hasCellNote() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns true if there is a cell note present for this data cell.
hasChild(Object) - Method in class oracle.epm.api.model.Member
Returns true if the specified child member exists for this member.
hasConnection(String) - Method in class oracle.epm.api.model.Application
Returns true if a connection with the specified name exists.
hasCube(String) - Method in class oracle.epm.api.model.Application
Returns true if a cube with the specified name exists.
hasCube() - Method in class oracle.epm.api.model.Operation
Returns true if the cube property is valid for this operation.
hasDataMap(String) - Method in class oracle.epm.api.model.Application
Returns true if a data map with the specified name exists.
hasDataValueProvider() - Method in class oracle.epm.api.model.Operation
Returns true if a data value provider is available for the current operation.
hasDimension(String, Cube...) - Method in class oracle.epm.api.model.Application
Returns true if a dimension with the specified name exists.
hasDimension(DimensionType, Cube...) - Method in class oracle.epm.api.model.Application
Returns true if a dimension with the specified dimension type exists.
hasGrid() - Method in class oracle.epm.api.model.Operation
Returns true if the grid property is valid for this operation.
hasMember(Object, Cube...) - Method in class oracle.epm.api.model.Dimension
Returns true if the specified member exists.
hasSmartList(String) - Method in class oracle.epm.api.model.Application
Returns true if the specified smart list exists.
hasSmartPush(String) - Method in interface oracle.epm.api.grid.DataGrid
Returns true if a smart push for the DataMap with the specified name is attached to the form.
hasStrategicModel(String) - Method in class oracle.epm.api.model.Application
Returns true if a strategic model with the specified name exists.
hasUda(String) - Method in class oracle.epm.api.model.Dimension
Returns true if a user defined attribute with the specified value exists for this dimension.
hasUda(String) - Method in class oracle.epm.api.model.Member
Returns true if the specified user defined attribute exists for this member.
hasUser() - Method in class oracle.epm.api.model.Operation
Returns true if the user property is valid for this operation.
hasUserVariable(String) - Method in class oracle.epm.api.model.Application
Returns true if the specified user variable exists.
hasUserVariable(String) - Method in class oracle.epm.api.model.Dimension
Returns true if the specified user variable exists for this dimension.
header(String, String) - Method in class oracle.epm.api.model.rest.HttpRequest
Returns this request after setting the specified header.
header(String, String) - Method in class oracle.epm.api.model.rest.HttpRequestWithBody
Returns this request after setting the specified header.
headers(Map<String, String>) - Method in class oracle.epm.api.model.rest.HttpRequest
Returns this request after setting the specified headers.
headers(Map<String, String>) - Method in class oracle.epm.api.model.rest.HttpRequestWithBody
Returns this request after setting the specified headers.
HttpMethod - Enum in oracle.epm.api.model.rest
An enumeration containing a list of valid HTTP methods.
HttpRequest - Class in oracle.epm.api.model.rest
This object represents an HTTP request off of a Connection.
HttpRequestWithBody - Class in oracle.epm.api.model.rest
This object represents an HTTP request with a body specified to an external or an Oracle Cloud Service resource.
HttpResponse<T> - Class in oracle.epm.api.model.rest
This object represents an HTTP request to an external or an Oracle Cloud Service resource.

I

isAutomaticallyGenerateId() - Method in class oracle.epm.api.model.SmartList
Returns true if the IDs for the entries will be generated by the system.
isCalcableForPOV() - Method in interface oracle.epm.api.grid.DataGrid.HeaderCell
Return true if this cell is not dynamic such as dynamic calc, implicit share, an attribute member, etc.
isContextSensitive() - Method in class oracle.epm.api.model.UserVariable
Returns true if this user variable uses value from the context.
isDynamicMember() - Method in class oracle.epm.api.model.Member
Returns true if this is a dynamic member.
isEdited() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns true if this data cell is edited.
isEmpty() - Method in interface oracle.epm.api.grid.DataGrid
Returns true if there are zero data cells in this grid.
isError() - Method in enum oracle.epm.api.model.JobStatus
 
isForceReadOnly() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns true if this data cell has been forced to be read only.
isLocked() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns true if this data cell is locked.
isMissing() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns true if this data cell value is missing.
isOverrideGridMissingLabel() - Method in class oracle.epm.api.model.SmartList
Returns true if the smart list missing label should override the grid's missing label.
isProtected() - Method in class oracle.epm.api.model.Rule
Returns true if the rule script is protected and false if the script is accessible.
isReadOnly() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns true if this data cell is read only.
isSandBoxEnabled() - Method in class oracle.epm.api.model.Cube
Returns true if this cube is enabled for sandboxing.
isSparse() - Method in interface oracle.epm.api.grid.DataGrid.HeaderCell
Returns true if the dimension for the member that this header cell represents is sparse.
isSuppressMissingBlocks() - Method in interface oracle.epm.api.grid.DataGridDefinition
Returns true if missing blocks are being suppressed when retrieving data.
isSuppressMissingColumns() - Method in interface oracle.epm.api.grid.DataGridDefinition
Returns true if missing columns are being suppressed when retrieving data.
isSuppressMissingRows() - Method in interface oracle.epm.api.grid.DataGridDefinition
Returns true if missing rows are being suppressed when retrieving data.
isValid() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns true if this cell is valid.
isValidIntersection() - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Returns true if this cell represents a valid intersection.
isZoomable() - Method in interface oracle.epm.api.grid.DataGrid.HeaderCell
Returns true if a zoom in operation on this cell will return one or more records.

J

Job - Class in oracle.epm.api.model
This object represents a job that was submitted for execution.
job(String, String, Map<String, ?>) - Method in class oracle.epm.api.model.JobFactory
Creates and returns a job definition for the specified properties.
JobDefinition - Class in oracle.epm.api.model
This object represents a job definition.
JobFactory - Class in oracle.epm.api.model
A job factory to help create job definitions.
JobFactory() - Constructor for class oracle.epm.api.model.JobFactory
 
JobStatus - Enum in oracle.epm.api.model
An enumeration containing a list of valid statuses for a job submitted for execution.
json(Map<String, ?>) - Method in class oracle.epm.api.script.EpmScript
Returns a JSON string for the specified input map.

L

loadGrid(DataGridDefinition, boolean) - Method in class oracle.epm.api.model.Cube
Returns a data grid for the specified region.
loadGrid(DataGridDefinition) - Method in class oracle.epm.api.model.StrategicModel
Returns a data grid for the specified region.

M

Member - Class in oracle.epm.api.model
This object represents a member.
MemberNameType - Enum in oracle.epm.api.model
An enumeration containing a list of valid member name types.
messageBundle(Map<String, String>) - Method in class oracle.epm.api.script.EpmScript
Returns a new in memory resource bundle that contains locale-specific resources provided to it.
messageBundleLoader(Map<String, GroovyMessageBundle>) - Method in class oracle.epm.api.script.EpmScript
Returns a resource bundle loader that manages message bundles by locale.

N

nanoTime() - Method in class oracle.epm.api.script.EpmScript
Returns the current value of the running Java Virtual Machine's high-resolution time source, in nanoseconds.
newChildAsMap(Object) - Method in class oracle.epm.api.model.Member
Returns a new map of properties for a child member of this member.

O

Operation - Class in oracle.epm.api.model
This object represents an operation.
oracle.epm.api - package oracle.epm.api
 
oracle.epm.api.grid - package oracle.epm.api.grid
 
oracle.epm.api.model - package oracle.epm.api.model
 
oracle.epm.api.model.rest - package oracle.epm.api.model.rest
 
oracle.epm.api.script - package oracle.epm.api.script
 

P

pathParam(String, String) - Method in class oracle.epm.api.model.rest.HttpRequest
Returns this request after setting the sepcified dynamic parameter value in the URL.
pathParam(String, String) - Method in class oracle.epm.api.model.rest.HttpRequestWithBody
Returns this request after setting the sepcified dynamic parameter value in the URL.
PeriodDimension - Class in oracle.epm.api.model
This object represents a Period dimension.
post(String) - Method in class oracle.epm.api.model.Connection
Creates and returns a Http POST request.
post() - Method in class oracle.epm.api.model.Connection
Creates and returns a Http POST request.
print(Object) - Method in class oracle.epm.api.script.EpmScript
Prints the value to the current operation's job details, which can be viewed from the job console.
printf(String, Object) - Method in class oracle.epm.api.script.EpmScript
Prints a formatted string using the specified format string and argument to the current operation's job details, which can be viewed from the job console.
printf(String, Object[]) - Method in class oracle.epm.api.script.EpmScript
Prints a formatted string using the specified format string and arguments to the current operation's job details, which can be viewed from the job console.
println() - Method in class oracle.epm.api.script.EpmScript
Prints a newline to the current operation's job details, which can be viewed from the job console.
println(Object) - Method in class oracle.epm.api.script.EpmScript
Prints the value and a newline to the current operation's job details, which can be viewed from the job console.
put(String) - Method in class oracle.epm.api.model.Connection
Creates and returns a Http PUT request.
put() - Method in class oracle.epm.api.model.Connection
Creates and returns a Http PUT request.

Q

queryParam(String, Collection<?>) - Method in class oracle.epm.api.model.rest.HttpRequest
Returns this request after setting the specified query parameter.
queryParam(String, Object) - Method in class oracle.epm.api.model.rest.HttpRequest
Returns this request after setting the specified query parameter.
queryParam(Map<String, ?>) - Method in class oracle.epm.api.model.rest.HttpRequestWithBody
Returns this request after setting the specified query parameters.
queryParam(String, Object) - Method in class oracle.epm.api.model.rest.HttpRequestWithBody
Returns this request after setting the specified query parameter.
queryParams(Map<String, ?>) - Method in class oracle.epm.api.model.rest.HttpRequest
Returns this request after setting the specified query parameters.

R

rename(Object) - Method in class oracle.epm.api.model.Member
Returns the renamed member and leaves this member instance unchanged.
RequestBodyEntity - Class in oracle.epm.api.model.rest
This object encapsulates a body for an HTTP request.
reset() - Method in interface oracle.epm.api.grid.GridIterator
Reset the iterator to begining.
RESOURCE_FILE_NOT_FOUND - Static variable in exception oracle.epm.api.GroovyDynamicLocalizedException
 
RtpValue - Class in oracle.epm.api.model
This object represents a Rtp value and provided utility methods to retrieve the object represenations for the various types of Rtps such as Member, Members, DateAsNumber, Member Range etc.
RtpValue(String, int, String, String, String, String, String, String) - Constructor for class oracle.epm.api.model.RtpValue
Constructs an instance of this class with specified parameters.
Rule - Class in oracle.epm.api.model
This object represents a business rule.

S

saveGrid(DataGrid) - Method in class oracle.epm.api.model.Cube
Save the data specified in the grid.
saveGrid(DataGrid) - Method in class oracle.epm.api.model.StrategicModel
Save the data specified in the grid.
saveMember(Map<String, Object>) - Method in class oracle.epm.api.model.Dimension
Returns the new member that was created and saved from the specified properties.
saveMember(Map<String, Object>, DynamicChildStrategy) - Method in class oracle.epm.api.model.Dimension
Returns the new member that was created and saved from the specified properties.
setBgColor(Integer) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Set the background color for this data cell.
setCellsRejected(List<String>) - Method in class oracle.epm.api.grid.DataGridBuilder.Status
 
setData(double) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Set the data value for this data cell.
setDefaultMemberNameType(MemberNameType) - Method in interface oracle.epm.api.grid.GridIterator
Sets the default member name type.
setEdited(boolean) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Marks the data cell as edited.
setForceReadOnly(boolean) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Forces the cell to be read only.
setFormattedValue(String) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Set the logical data value for this data cell.
setNumAcceptedCells(int) - Method in class oracle.epm.api.grid.DataGridBuilder.Status
 
setNumRejectedCells(int) - Method in class oracle.epm.api.grid.DataGridBuilder.Status
 
setPov(List<String>, List<List<String>>) - Method in interface oracle.epm.api.grid.DataGridDefinitionBuilder
Replaces the POV members with the specified members.
setSuppressMissingBlocks(boolean) - Method in interface oracle.epm.api.grid.DataGridDefinitionBuilder
Sets the suppress missing blocks option, which is honored when the data is loaded in the defined region.
setSuppressMissingColumns(boolean) - Method in interface oracle.epm.api.grid.DataGridDefinitionBuilder
Sets the suppress missing columns option, which is honored when the data is loaded in the defined region.
setSuppressMissingRows(boolean) - Method in interface oracle.epm.api.grid.DataGridDefinitionBuilder
Sets the suppress missing rows option, which is honored when the data is loaded in the defined region.
setTooltip(String) - Method in interface oracle.epm.api.grid.DataGrid.DataCell
Set the tooltip for this data cell.
setUserVariableValue(UserVariable, Member) - Method in class oracle.epm.api.model.Application
Sets the user variable value for the current user.
size() - Method in interface oracle.epm.api.grid.DataGrid
Returns the number of data cells in this grid.
SmartList - Class in oracle.epm.api.model
This object represents a smart list.
SmartList.Entry - Class in oracle.epm.api.model
This object represents an entry in the smart list.
SmartPush - Class in oracle.epm.api.model
This object can be used to push data to the target location specified in the underlying data map.
StrategicModel - Class in oracle.epm.api.model
This object represents a Strategic Model in an EPM application that has the Strategic Modeling business process enabled.

T

throwVetoException(HspLocalizedException) - Method in class oracle.epm.api.script.EpmScript
Throws an exception indicating that the operation in progress must be vetoed.
throwVetoException(HspDynamicLocalizedException) - Method in class oracle.epm.api.script.EpmScript
Throws an exception indicating that the operation in progress must be vetoed.
throwVetoException(String) - Method in class oracle.epm.api.script.EpmScript
Throws an exception indicating that the operation in progress must be vetoed.
throwVetoException(GroovyResourceBundleLoader, String, Object...) - Method in class oracle.epm.api.script.EpmScript
Throws an exception indicating that the operation in progress must be vetoed.
toMap() - Method in class oracle.epm.api.model.Member
Returns a new map containing the properties for this member.
toString() - Method in class oracle.epm.api.model.Application
Returns a string representation of the object.
toString() - Method in enum oracle.epm.api.model.ApplicationType
 
toString() - Method in enum oracle.epm.api.model.AttributeType
Returns the display name of this enum constant, as contained in the declaration.
toString() - Method in enum oracle.epm.api.model.BasePeriodType
Returns the display name of this enum constant, as contained in the declaration.
toString() - Method in class oracle.epm.api.model.Cube
Returns a string representation of the object.
toString() - Method in class oracle.epm.api.model.DataMap
Returns a string representation of the object.
toString() - Method in enum oracle.epm.api.model.DataType
Returns the display name of this enum constant, as contained in the declaration.
toString() - Method in class oracle.epm.api.model.Dimension
Returns a string representation of the object.
toString() - Method in enum oracle.epm.api.model.DimensionType
Returns the display name of this enum constant, as contained in the declaration.
toString() - Method in enum oracle.epm.api.model.ExecuteAsUser
Returns the display name of this enum constant, as contained in the declaration.
toString() - Method in enum oracle.epm.api.model.FiscalYearStart
Returns the display name of this enum constant, as contained in the declaration.
toString() - Method in enum oracle.epm.api.model.JobStatus
toString() - Method in class oracle.epm.api.model.Member
Returns a string representation of the object.
toString() - Method in class oracle.epm.api.model.RtpValue
Returns the string representation for the rtp.
toString() - Method in class oracle.epm.api.model.SmartPush
Returns a string representation of the object.

U

User - Class in oracle.epm.api.model
This object represents a user.
UserVariable - Class in oracle.epm.api.model
This object represents a user variable.

V

validateRtp(RtpValue, String, GroovyResourceBundleLoader, String, Object...) - Method in class oracle.epm.api.script.EpmScript
Validates the run time prompt value against the specified regular expression pattern.
validateRtp(RtpValue, Predicate<RtpValue>, GroovyResourceBundleLoader, String, Object...) - Method in class oracle.epm.api.script.EpmScript
Validates the run time prompt value against the specified predicate.
valueOf(String) - Static method in enum oracle.epm.api.model.ApplicationType
Returns the enum constant of this type with the specified name.
valueOf(Integer) - Static method in enum oracle.epm.api.model.ApplicationType
Returns an instance of the enum with the specified identifier.
valueOf(String) - Static method in enum oracle.epm.api.model.AttributeType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.BasePeriodType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.CurrencyMode
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.DataType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.DimensionType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.DynamicChildStrategy
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.ExecuteAsUser
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.FiscalYearStart
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.JobStatus
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.MemberNameType
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum oracle.epm.api.model.rest.HttpMethod
Returns the enum constant of this type with the specified name.
values() - Static method in enum oracle.epm.api.model.ApplicationType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.AttributeType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.BasePeriodType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.CurrencyMode
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.DataType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.DimensionType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.DynamicChildStrategy
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.ExecuteAsUser
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.FiscalYearStart
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.JobStatus
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.MemberNameType
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum oracle.epm.api.model.rest.HttpMethod
Returns an array containing the constants of this enum type, in the order they are declared.
VetoOperationException - Exception in oracle.epm.api
A RuntimeException to veto an operation from continuing.
VetoOperationException() - Constructor for exception oracle.epm.api.VetoOperationException
Constructs an instance of this class with specified parameters.
VetoOperationException(HspLocalizedException) - Constructor for exception oracle.epm.api.VetoOperationException
Constructs an instance of this class with specified parameters.
VetoOperationException(HspDynamicLocalizedException) - Constructor for exception oracle.epm.api.VetoOperationException
Constructs an instance of this class with specified parameters.

Y

YearDimension - Class in oracle.epm.api.model
This object represents a Year dimension.
A B C D E F G H I J L M N O P Q R S T U V Y 
Oracle Enterprise Performance Management Cloud, Groovy Rules Java API Reference

Copyright © 2017, 2019, Oracle and/or its affiliates. All rights reserved.